<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en_US" xml:lang="en_US"> <head> <title>akregator/src: article.h Source File (akregator/src)</title> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta http-equiv="Content-Style-Type" content="text/css" /> <meta http-equiv="pics-label" content='(pics-1.1 "http://www.icra.org/ratingsv02.html" comment "ICRAonline DE v2.0" l gen true for "http://www.kde.org" r (nz 1 vz 1 lz 1 oz 1 cb 1) "http://www.rsac.org/ratingsv01.html" l gen true for "http://www.kde.org" r (n 0 s 0 v 0 l 0))' /> <meta name="trademark" content="KDE e.V." /> <meta name="description" content="K Desktop Environment Homepage, KDE.org" /> <meta name="MSSmartTagsPreventParsing" content="true" /> <meta name="robots" content="all" /> <link rel="shortcut icon" href="../../../favicon.ico" /> <link rel="stylesheet" media="screen" type="text/css" title="APIDOX" href="doxygen.css" /> <style type="text/css"> <!-- hr { display: none; } #content h2 { margin-left: 0px; } table.mdTable { background-color: #f8f8f8; border: .2em solid #d7d7d7; } td.mdRow { padding: 8px 20px; } td.md { font-weight: bold; } td.mdname1 { font-weight: bold; color: #602020; } td.mdname { font-weight: bold; color: #602020; } --> </style> </head> <body> <div id="nav_header_top" align="right"> <a href="#content" class="doNotDisplay" accesskey="2">Skip to main content ::</a> <a href="../../.."><img id="nav_header_logo" alt="Home" align="left" src="../../../kde_gear_64.png" border="0" /></a> <span class="doNotDisplay">::</span> <img id="nav_header_logo_right" alt="" align="right" src="../../../pimlogo.png" border="0" /> <div id="nav_header_title" align="left">KDE PIM API Reference</div> </div> <div id="nav_header_bottom" align="right"> <span class="doNotDisplay">:: <a href="#navigation" accesskey="5">Skip to Link Menu</a><br/></span> <div id="nav_header_bottom_left" style="text-align: left;"> / <a href="../../../">API Reference</a> / <a href="../../html/index.html">akregator</a> / <a href=".">src</a> </div> </div> <table id="main" border="0" cellpadding="0" cellspacing="0" width="100%"> <tr> <td valign="top" class="menuheader" height="0"></td> <td id="contentcolumn" valign="top" rowspan="2" > <div id="content" style="padding-top: 0px;"><div style="width:100%; margin: 0px; padding: 0px;"> <h2><a name="content"></a>akregator/src</h2> <!-- Generated by Doxygen 1.5.5 --> <h1>article.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span> <a name="l00002"></a>00002 <span class="comment"> This file is part of Akregator.</span> <a name="l00003"></a>00003 <span class="comment"></span> <a name="l00004"></a>00004 <span class="comment"> Copyright (C) 2004 Stanislav Karchebny <Stanislav.Karchebny@kdemail.net></span> <a name="l00005"></a>00005 <span class="comment"> 2005 Frank Osterfeld <frank.osterfeld at kdemail.net></span> <a name="l00006"></a>00006 <span class="comment"></span> <a name="l00007"></a>00007 <span class="comment"> This program is free software; you can redistribute it and/or modify</span> <a name="l00008"></a>00008 <span class="comment"> it under the terms of the GNU General Public License as published by</span> <a name="l00009"></a>00009 <span class="comment"> the Free Software Foundation; either version 2 of the License, or</span> <a name="l00010"></a>00010 <span class="comment"> (at your option) any later version.</span> <a name="l00011"></a>00011 <span class="comment"></span> <a name="l00012"></a>00012 <span class="comment"> This program is distributed in the hope that it will be useful,</span> <a name="l00013"></a>00013 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span> <a name="l00014"></a>00014 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span> <a name="l00015"></a>00015 <span class="comment"> GNU General Public License for more details.</span> <a name="l00016"></a>00016 <span class="comment"></span> <a name="l00017"></a>00017 <span class="comment"> You should have received a copy of the GNU General Public License</span> <a name="l00018"></a>00018 <span class="comment"> along with this program; if not, write to the Free Software</span> <a name="l00019"></a>00019 <span class="comment"> Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</span> <a name="l00020"></a>00020 <span class="comment"></span> <a name="l00021"></a>00021 <span class="comment"> As a special exception, permission is given to link this program</span> <a name="l00022"></a>00022 <span class="comment"> with any edition of Qt, and distribute the resulting executable,</span> <a name="l00023"></a>00023 <span class="comment"> without including the source code for Qt in the source distribution.</span> <a name="l00024"></a>00024 <span class="comment">*/</span> <a name="l00025"></a>00025 <a name="l00026"></a>00026 <span class="preprocessor">#ifndef AKREGATOR_ARTICLE_H</span> <a name="l00027"></a>00027 <span class="preprocessor"></span><span class="preprocessor">#define AKREGATOR_ARTICLE_H</span> <a name="l00028"></a>00028 <span class="preprocessor"></span> <a name="l00029"></a>00029 <span class="keyword">class </span>QDateTime; <a name="l00030"></a>00030 <span class="keyword">class </span>QDomDocument; <a name="l00031"></a>00031 <span class="keyword">class </span>QDomElement; <a name="l00032"></a>00032 <span class="keyword">class </span>QString; <a name="l00033"></a>00033 <span class="keyword">class </span>QStringList; <a name="l00034"></a>00034 <span class="keyword">class </span>QWidget; <a name="l00035"></a>00035 <a name="l00036"></a>00036 <span class="keyword">template</span> <<span class="keyword">class</span> T> <span class="keyword">class </span>QValueList; <a name="l00037"></a>00037 <a name="l00038"></a>00038 <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> uint; <a name="l00039"></a>00039 <a name="l00040"></a>00040 <span class="keyword">class </span>KURL; <a name="l00041"></a>00041 <span class="keyword">class </span>KURLLabel; <a name="l00042"></a>00042 <a name="l00043"></a>00043 <span class="keyword">namespace </span>RSS <a name="l00044"></a>00044 { <a name="l00045"></a>00045 <span class="keyword">class </span>Article; <a name="l00046"></a>00046 <span class="keyword">class </span>Enclosure; <a name="l00047"></a>00047 } <a name="l00048"></a>00048 <a name="l00049"></a>00049 <span class="keyword">namespace </span>Akregator <a name="l00050"></a>00050 { <a name="l00051"></a>00051 <span class="keyword">namespace </span>Backend <a name="l00052"></a>00052 { <a name="l00053"></a>00053 <span class="keyword">class </span>FeedStorage; <a name="l00054"></a>00054 } <a name="l00055"></a>00055 <span class="keyword">class </span>Feed; <a name="l00057"></a><a class="code" href="classAkregator_1_1Article.html">00057</a> <span class="keyword">class </span><a class="code" href="classAkregator_1_1Article.html" title="A proxy class for RSS::Article with some additional methods to assist sorting.">Article</a> <a name="l00058"></a>00058 { <a name="l00059"></a>00059 <span class="keyword">public</span>: <a name="l00060"></a>00060 <span class="keyword">enum</span> Status { Unread=0, Read, New }; <a name="l00061"></a>00061 <span class="keyword">typedef</span> QValueList<Article> List; <a name="l00062"></a>00062 <a name="l00063"></a>00063 <a class="code" href="classAkregator_1_1Article.html" title="A proxy class for RSS::Article with some additional methods to assist sorting.">Article</a>(); <a name="l00067"></a>00067 <a class="code" href="classAkregator_1_1Article.html" title="A proxy class for RSS::Article with some additional methods to assist sorting.">Article</a>(<span class="keyword">const</span> QString& guid, <a class="code" href="classAkregator_1_1Feed.html" title="represents a feed">Feed</a>* feed); <a name="l00071"></a>00071 <a class="code" href="classAkregator_1_1Article.html" title="A proxy class for RSS::Article with some additional methods to assist sorting.">Article</a>(RSS::Article article, <a class="code" href="classAkregator_1_1Feed.html" title="represents a feed">Feed</a>* feed); <a name="l00072"></a>00072 <a name="l00073"></a>00073 <a class="code" href="classAkregator_1_1Article.html" title="A proxy class for RSS::Article with some additional methods to assist sorting.">Article</a>(RSS::Article article, Backend::FeedStorage* archive); <a name="l00074"></a>00074 <a class="code" href="classAkregator_1_1Article.html" title="A proxy class for RSS::Article with some additional methods to assist sorting.">Article</a>(<span class="keyword">const</span> <a class="code" href="classAkregator_1_1Article.html" title="A proxy class for RSS::Article with some additional methods to assist sorting.">Article</a> &other); <a name="l00075"></a>00075 <a class="code" href="classAkregator_1_1Article.html" title="A proxy class for RSS::Article with some additional methods to assist sorting.">Article</a> &operator=(<span class="keyword">const</span> <a class="code" href="classAkregator_1_1Article.html" title="A proxy class for RSS::Article with some additional methods to assist sorting.">Article</a> &other); <a name="l00076"></a>00076 <span class="keywordtype">bool</span> operator==(<span class="keyword">const</span> <a class="code" href="classAkregator_1_1Article.html" title="A proxy class for RSS::Article with some additional methods to assist sorting.">Article</a> &other) <span class="keyword">const</span>; <a name="l00077"></a>00077 <span class="keywordtype">bool</span> operator!=(<span class="keyword">const</span> <a class="code" href="classAkregator_1_1Article.html" title="A proxy class for RSS::Article with some additional methods to assist sorting.">Article</a> &other)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> !operator==(other); } <a name="l00078"></a>00078 <span class="keyword">virtual</span> ~<a class="code" href="classAkregator_1_1Article.html" title="A proxy class for RSS::Article with some additional methods to assist sorting.">Article</a>(); <a name="l00079"></a>00079 <a name="l00080"></a>00080 <span class="keywordtype">bool</span> isNull() <span class="keyword">const</span>; <a name="l00081"></a>00081 <a name="l00082"></a>00082 <span class="keywordtype">int</span> status() <span class="keyword">const</span>; <a name="l00083"></a>00083 <span class="keywordtype">void</span> setStatus(<span class="keywordtype">int</span> s); <a name="l00084"></a>00084 <a name="l00085"></a>00085 <span class="keywordtype">void</span> offsetPubDate(<span class="keywordtype">int</span> secs); <a name="l00086"></a>00086 <a name="l00087"></a>00087 QString title() <span class="keyword">const</span>; <a name="l00088"></a>00088 KURL link() <span class="keyword">const</span>; <a name="l00089"></a>00089 <a name="l00090"></a>00090 QString author() <span class="keyword">const</span>; <a name="l00091"></a>00091 <a name="l00092"></a>00092 QString description() <span class="keyword">const</span>; <a name="l00093"></a>00093 QString guid() <span class="keyword">const</span>; <a name="l00095"></a>00095 <span class="keywordtype">bool</span> <a class="code" href="classAkregator_1_1Article.html#78d28aa4fe17bcc75a09a2718ffb97ac" title="if true, the article should be kept even when expired">keep</a>() <span class="keyword">const</span>; <a name="l00096"></a>00096 <span class="keywordtype">void</span> setKeep(<span class="keywordtype">bool</span> keep); <a name="l00097"></a>00097 <span class="keywordtype">bool</span> isDeleted() <span class="keyword">const</span>; <a name="l00098"></a>00098 <a name="l00099"></a>00099 RSS::Enclosure enclosure() <span class="keyword">const</span>; <a name="l00100"></a>00100 <a name="l00101"></a>00101 <span class="keywordtype">void</span> setDeleted(); <a name="l00102"></a>00102 <a name="l00103"></a>00103 <a name="l00104"></a>00104 <a class="code" href="classAkregator_1_1Feed.html" title="represents a feed">Feed</a>* feed() <span class="keyword">const</span>; <a name="l00105"></a>00105 <a name="l00108"></a>00108 uint <a class="code" href="classAkregator_1_1Article.html#04d5a71e7fb69df6cdb72a24b2e5be32" title="returns a hash value used to detect changes in articles with non-hash GUIDs.">hash</a>() <span class="keyword">const</span>; <a name="l00109"></a>00109 <a name="l00112"></a>00112 <span class="keywordtype">bool</span> <a class="code" href="classAkregator_1_1Article.html#139c62193416ea449de0fe1c177ce575" title="returns if the guid is a hash or an ID taken from the source">guidIsHash</a>() <span class="keyword">const</span>; <a name="l00113"></a>00113 <a name="l00114"></a>00114 <span class="keywordtype">bool</span> guidIsPermaLink() <span class="keyword">const</span>; <a name="l00115"></a>00115 <a name="l00116"></a>00116 <span class="keyword">const</span> QDateTime& pubDate() <span class="keyword">const</span>; <a name="l00117"></a>00117 <a name="l00118"></a>00118 KURL commentsLink() <span class="keyword">const</span>; <a name="l00119"></a>00119 <a name="l00120"></a>00120 <span class="keywordtype">int</span> comments() <span class="keyword">const</span>; <a name="l00121"></a>00121 <a name="l00122"></a>00122 <span class="keywordtype">void</span> addTag(<span class="keyword">const</span> QString& tag); <a name="l00123"></a>00123 <span class="keywordtype">void</span> removeTag(<span class="keyword">const</span> QString& tag); <a name="l00124"></a>00124 <span class="keywordtype">bool</span> hasTag(<span class="keyword">const</span> QString& tag) <span class="keyword">const</span>; <a name="l00125"></a>00125 QStringList tags() <span class="keyword">const</span>; <a name="l00126"></a>00126 <a name="l00127"></a>00127 <span class="keywordtype">bool</span> operator<(<span class="keyword">const</span> <a class="code" href="classAkregator_1_1Article.html" title="A proxy class for RSS::Article with some additional methods to assist sorting.">Article</a> &other) <span class="keyword">const</span>; <a name="l00128"></a>00128 <span class="keywordtype">bool</span> operator<=(<span class="keyword">const</span> <a class="code" href="classAkregator_1_1Article.html" title="A proxy class for RSS::Article with some additional methods to assist sorting.">Article</a> &other) <span class="keyword">const</span>; <a name="l00129"></a>00129 <span class="keywordtype">bool</span> operator>(<span class="keyword">const</span> <a class="code" href="classAkregator_1_1Article.html" title="A proxy class for RSS::Article with some additional methods to assist sorting.">Article</a> &other) <span class="keyword">const</span>; <a name="l00130"></a>00130 <span class="keywordtype">bool</span> operator>=(<span class="keyword">const</span> <a class="code" href="classAkregator_1_1Article.html" title="A proxy class for RSS::Article with some additional methods to assist sorting.">Article</a> &other) <span class="keyword">const</span>; <a name="l00131"></a>00131 <a name="l00132"></a>00132 <a name="l00133"></a>00133 <span class="keyword">private</span>: <a name="l00134"></a>00134 <span class="keywordtype">void</span> initialize(RSS::Article article, Backend::FeedStorage* archive); <a name="l00135"></a>00135 <span class="keyword">static</span> QString buildTitle(<span class="keyword">const</span> QString& description); <a name="l00136"></a>00136 <a name="l00137"></a>00137 <span class="keywordtype">int</span> statusBits() <span class="keyword">const</span>; <span class="comment">// returns all of the status bits for the article. this</span> <a name="l00138"></a>00138 <span class="comment">// differs from status() which only returns the most relevant</span> <a name="l00139"></a>00139 <span class="comment">// status flag.</span> <a name="l00140"></a>00140 <a name="l00141"></a>00141 <a name="l00142"></a>00142 <span class="keyword">struct </span>Private; <a name="l00143"></a>00143 Private *d; <a name="l00144"></a>00144 }; <a name="l00145"></a>00145 } <a name="l00146"></a>00146 <a name="l00147"></a>00147 <span class="preprocessor">#endif</span> </pre></div></div> </div></div> </td> </tr> <tr> <td valign="top" id="leftmenu" width="25%"> <a name="navigation"></a> <div class="menu_box"><h2>akregator/src</h2> <div class="nav_list"> <ul><li><a href="index.html">Main Page</a></li><li><a href="namespaces.html">Namespace List</a></li><li><a href="hierarchy.html">Class Hierarchy</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="files.html">File List</a></li><li><a href="functions.html">Class Members</a></li></ul> <!-- <h2>Class Picker</h2> <div style="text-align: center;"> <form name="guideform"> <select name="guidelinks" style="width:100%;" onChange="window.location=document.guideform.guidelinks.options[document.guideform.guidelinks.selectedIndex].value"> <option value="annotated.html">-- Choose --</option> <option value="classAkregator_1_1AboutData.html">akregator::aboutdata</option>, <option value="classAkregator_1_1ActionManager.html">akregator::actionmanager</option>, <option value="classAkregator_1_1ActionManagerImpl.html">akregator::actionmanagerimpl</option>, <option value="classAkregator_1_1Article.html">akregator::article</option>, <option value="classAkregator_1_1ArticleInterceptor.html">akregator::articleinterceptor</option>, <option value="classAkregator_1_1ArticleInterceptorManager.html">akregator::articleinterceptormanager</option>, <option value="classAkregator_1_1ArticleViewer.html">akregator::articleviewer</option>, <option value="classAkregator_1_1Backend_1_1Category.html">akregator::backend::category</option>, <option value="classAkregator_1_1Backend_1_1Storage.html">akregator::backend::storage</option>, <option value="classAkregator_1_1Backend_1_1StorageDummyImpl.html">akregator::backend::storagedummyimpl</option>, <option value="classAkregator_1_1Feed.html">akregator::feed</option>, <option value="classAkregator_1_1FeedItem.html">akregator::feeditem</option>, <option value="classAkregator_1_1FeedList.html">akregator::feedlist</option>, <option value="classAkregator_1_1Filters_1_1AbstractMatcher.html">akregator::filters::abstractmatcher</option>, <option value="classAkregator_1_1Filters_1_1ArticleFilter.html">akregator::filters::articlefilter</option>, <option value="classAkregator_1_1Filters_1_1ArticleMatcher.html">akregator::filters::articlematcher</option>, <option value="classAkregator_1_1Filters_1_1Criterion.html">akregator::filters::criterion</option>, <option value="classAkregator_1_1Folder.html">akregator::folder</option>, <option value="classAkregator_1_1KCursorSaver.html">akregator::kcursorsaver</option>, <option value="classAkregator_1_1ListTabWidget.html">akregator::listtabwidget</option>, <option value="classAkregator_1_1MainWindow.html">akregator::mainwindow</option>, <option value="classAkregator_1_1NotificationManager.html">akregator::notificationmanager</option>, <option value="classAkregator_1_1Part.html">akregator::part</option>, <option value="classAkregator_1_1ProgressItemHandler.html">akregator::progressitemhandler</option>, <option value="classAkregator_1_1ProgressManager.html">akregator::progressmanager</option>, <option value="classAkregator_1_1SelectNodeDialog.html">akregator::selectnodedialog</option>, <option value="classAkregator_1_1TagAction.html">akregator::tagaction</option>, <option value="classAkregator_1_1TagSet.html">akregator::tagset</option>, <option value="classAkregator_1_1TreeNode.html">akregator::treenode</option>, <option value="classAkregator_1_1TreeNodeItem.html">akregator::treenodeitem</option>, <option value="classAkregator_1_1View.html">akregator::view</option>, </select> </form> </div> --> </div></div> <div class="menu_box"><h2>API Dox</h2> <div class="nav_list"> <ul> <li><a href="../../../akregator/html/index.html">akregator</a></li><li> <a href="../../../akregator/src/html/index.html">src</a></li><li> <a href="../../../akregator/src/librss/html/index.html">librss</a></li><li><a href="../../../certmanager/html/index.html">certmanager</a></li><li> <a href="../../../certmanager/lib/html/index.html">lib</a></li><li><a href="../../../kaddressbook/html/index.html">kaddressbook</a></li><li><a href="../../../kalarm/html/index.html">kalarm</a></li><li> <a href="../../../kalarm/lib/html/index.html">lib</a></li><li><a href="../../../kandy/html/index.html">kandy</a></li><li><a href="../../../karm/html/index.html">karm</a></li><li><a href="../../../kdgantt/html/index.html">kdgantt</a></li><li><a href="../../../kgantt/html/index.html">kgantt</a></li><li><a href="../../../kioslaves/html/index.html">kioslaves</a></li><li> <a href="../../../kioslaves/imap4/html/index.html">imap4</a></li><li> <a href="../../../kioslaves/mbox/html/index.html">mbox</a></li><li><a href="../../../kitchensync/html/index.html">kitchensync</a></li><li><a href="../../../kmail/html/index.html">kmail</a></li><li><a href="../../../knotes/html/index.html">knotes</a></li><li><a href="../../../konsolekalendar/html/index.html">konsolekalendar</a></li><li><a href="../../../kontact/html/index.html">kontact</a></li><li><a href="../../../korganizer/html/index.html">korganizer</a></li><li><a href="../../../kpilot/html/index.html">kpilot</a></li><li> <a href="../../../kpilot/kpilot/html/index.html">kpilot</a></li><li> <a href="../../../kpilot/lib/html/index.html">lib</a></li><li><a href="../../../libemailfunctions/html/index.html">libemailfunctions</a></li><li><a href="../../../libkcal/html/index.html">libkcal</a></li><li><a href="../../../libkdepim/html/index.html">libkdepim</a></li><li><a href="../../../libkholidays/html/index.html">libkholidays</a></li><li><a href="../../../libkmime/html/index.html">libkmime</a></li><li><a href="../../../libkpgp/html/index.html">libkpgp</a></li><li><a href="../../../libkpimidentities/html/index.html">libkpimidentities</a></li> </ul></div></div> </td> </tr> </table> <span class="doNotDisplay"> <a href="http://www.kde.org/" accesskey="8">KDE Home</a> | <a href="http://accessibility.kde.org/" accesskey="9">KDE Accessibility Home</a> | <a href="http://www.kde.org/media/accesskeys.php" accesskey="0">Description of Access Keys</a> </span> <div style="height: 8px"></div> <div id="footer"> <div id="footer_left"> Maintained by <a href="mailto:groot@kde.org">Adriaan de Groot</a> and <a href="mailto:winter@kde.org">Allen Winter</a>. <br/> KDE and K Desktop Environment are trademarks of <a href="http://www.kde.org/areas/kde-ev/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> | <a href="http://www.kde.org/contact/impressum.php">Legal</a> </div> <div id="footer_right"><img src="/media/images/footer_right.png" style="margin: 0px" alt="" /></div> </div> <!-- WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL BE BLOCKED INSTANTLY AND PERMANENTLY! <a href="mailto:aaaatrap-425acc3b5374943f@kde.org">Block me</a> WARNING END --> </body> </html>