<?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/librss: loader.h Source File (akregator/src/librss)</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="../../html/index.html">src</a> / <a href=".">librss</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/librss</h2> <!-- Generated by Doxygen 1.5.5 --> <h1>loader.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"> * loader.h</span> <a name="l00003"></a>00003 <span class="comment"> *</span> <a name="l00004"></a>00004 <span class="comment"> * Copyright (c) 2001, 2002, 2003 Frerich Raabe <raabe@kde.org></span> <a name="l00005"></a>00005 <span class="comment"> *</span> <a name="l00006"></a>00006 <span class="comment"> * This program is distributed in the hope that it will be useful, but WITHOUT</span> <a name="l00007"></a>00007 <span class="comment"> * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS</span> <a name="l00008"></a>00008 <span class="comment"> * FOR A PARTICULAR PURPOSE. For licensing and distribution details, check the</span> <a name="l00009"></a>00009 <span class="comment"> * accompanying file 'COPYING'.</span> <a name="l00010"></a>00010 <span class="comment"> */</span> <a name="l00011"></a>00011 <span class="preprocessor">#ifndef LIBRSS_LOADER_H</span> <a name="l00012"></a>00012 <span class="preprocessor"></span><span class="preprocessor">#define LIBRSS_LOADER_H</span> <a name="l00013"></a>00013 <span class="preprocessor"></span> <a name="l00014"></a>00014 <span class="preprocessor">#include "global.h"</span> <a name="l00015"></a>00015 <a name="l00016"></a>00016 <span class="keyword">class </span>KURL; <a name="l00017"></a>00017 <a name="l00018"></a>00018 <span class="preprocessor">#include <qobject.h></span> <a name="l00019"></a>00019 <a name="l00020"></a>00020 <span class="keyword">namespace </span>KIO <a name="l00021"></a>00021 { <a name="l00022"></a>00022 <span class="keyword">class </span>Job; <a name="l00023"></a>00023 } <a name="l00024"></a>00024 <span class="keyword">class </span>KProcess; <a name="l00025"></a>00025 <a name="l00026"></a>00026 <span class="keyword">namespace </span>RSS <a name="l00027"></a>00027 { <a name="l00028"></a>00028 <span class="keyword">class </span>Document; <a name="l00029"></a>00029 <a name="l00035"></a><a class="code" href="classRSS_1_1DataRetriever.html">00035</a> <span class="keyword">class </span>KDE_EXPORT <a class="code" href="classRSS_1_1DataRetriever.html" title="Abstract baseclass for all data retriever classes.">DataRetriever</a> : <span class="keyword">public</span> QObject <a name="l00036"></a>00036 { <a name="l00037"></a>00037 Q_OBJECT <a name="l00038"></a>00038 <span class="keyword">public</span>: <a name="l00042"></a>00042 <a class="code" href="classRSS_1_1DataRetriever.html" title="Abstract baseclass for all data retriever classes.">DataRetriever</a>(); <a name="l00043"></a>00043 <a name="l00047"></a>00047 <span class="keyword">virtual</span> ~<a class="code" href="classRSS_1_1DataRetriever.html" title="Abstract baseclass for all data retriever classes.">DataRetriever</a>(); <a name="l00048"></a>00048 <a name="l00055"></a>00055 <span class="keyword">virtual</span> <span class="keywordtype">void</span> retrieveData(<span class="keyword">const</span> KURL &url) = 0; <a name="l00056"></a>00056 <a name="l00063"></a>00063 <span class="keyword">virtual</span> <span class="keywordtype">int</span> errorCode() <span class="keyword">const</span> = 0; <a name="l00064"></a>00064 <a name="l00065"></a>00065 <span class="keyword">virtual</span> <span class="keywordtype">void</span> abort() = 0; <a name="l00066"></a>00066 signals: <a name="l00078"></a>00078 <span class="keywordtype">void</span> dataRetrieved(<span class="keyword">const</span> QByteArray &data, <span class="keywordtype">bool</span> success); <a name="l00079"></a>00079 <a name="l00080"></a>00080 <span class="keyword">private</span>: <a name="l00081"></a>00081 <a class="code" href="classRSS_1_1DataRetriever.html" title="Abstract baseclass for all data retriever classes.">DataRetriever</a>(<span class="keyword">const</span> <a class="code" href="classRSS_1_1DataRetriever.html" title="Abstract baseclass for all data retriever classes.">DataRetriever</a> &other); <a name="l00082"></a>00082 <a class="code" href="classRSS_1_1DataRetriever.html" title="Abstract baseclass for all data retriever classes.">DataRetriever</a> &operator=(<span class="keyword">const</span> <a class="code" href="classRSS_1_1DataRetriever.html" title="Abstract baseclass for all data retriever classes.">DataRetriever</a> &other); <a name="l00083"></a>00083 }; <a name="l00084"></a>00084 <a name="l00089"></a><a class="code" href="classRSS_1_1FileRetriever.html">00089</a> <span class="keyword">class </span>KDE_EXPORT <a class="code" href="classRSS_1_1FileRetriever.html" title="Implements a file retriever, to be used with Loader::loadFrom().">FileRetriever</a> : <span class="keyword">public</span> <a class="code" href="classRSS_1_1DataRetriever.html" title="Abstract baseclass for all data retriever classes.">DataRetriever</a> <a name="l00090"></a>00090 { <a name="l00091"></a>00091 Q_OBJECT <a name="l00092"></a>00092 <span class="keyword">public</span>: <a name="l00096"></a>00096 <a class="code" href="classRSS_1_1FileRetriever.html" title="Implements a file retriever, to be used with Loader::loadFrom().">FileRetriever</a>(); <a name="l00097"></a>00097 <a name="l00101"></a>00101 <span class="keyword">virtual</span> ~<a class="code" href="classRSS_1_1FileRetriever.html" title="Implements a file retriever, to be used with Loader::loadFrom().">FileRetriever</a>(); <a name="l00102"></a>00102 <a name="l00110"></a>00110 <span class="keyword">virtual</span> <span class="keywordtype">void</span> retrieveData(<span class="keyword">const</span> KURL &url); <a name="l00111"></a>00111 <a name="l00118"></a>00118 <span class="keyword">virtual</span> <span class="keywordtype">int</span> errorCode() <span class="keyword">const</span>; <a name="l00119"></a>00119 <a name="l00120"></a>00120 <span class="keyword">virtual</span> <span class="keywordtype">void</span> abort(); <a name="l00121"></a>00121 <a name="l00122"></a>00122 <span class="keyword">static</span> <span class="keywordtype">void</span> setUseCache(<span class="keywordtype">bool</span> enabled); <a name="l00123"></a>00123 <span class="keyword">static</span> <span class="keywordtype">void</span> setUserAgent(<span class="keyword">const</span> QString &ua); <a name="l00124"></a>00124 <span class="keyword">static</span> QString userAgent(); <a name="l00125"></a>00125 <a name="l00126"></a>00126 signals: <a name="l00134"></a>00134 <span class="keywordtype">void</span> permanentRedirection(<span class="keyword">const</span> KURL &url); <a name="l00135"></a>00135 <a name="l00136"></a>00136 <span class="keyword">protected</span> slots: <a name="l00137"></a>00137 <span class="keywordtype">void</span> slotTimeout(); <a name="l00138"></a>00138 <a name="l00139"></a>00139 <span class="keyword">private</span> slots: <a name="l00140"></a>00140 <span class="keywordtype">void</span> slotData(KIO::Job *job, <span class="keyword">const</span> QByteArray &data); <a name="l00141"></a>00141 <span class="keywordtype">void</span> slotResult(KIO::Job *job); <a name="l00142"></a>00142 <span class="keywordtype">void</span> slotPermanentRedirection(KIO::Job *job, <span class="keyword">const</span> KURL &fromUrl, <a name="l00143"></a>00143 <span class="keyword">const</span> KURL &toUrl); <a name="l00144"></a>00144 <a name="l00145"></a>00145 <span class="keyword">private</span>: <a name="l00146"></a>00146 <span class="keyword">static</span> <span class="keywordtype">bool</span> m_useCache; <a name="l00147"></a>00147 <a name="l00148"></a>00148 <a class="code" href="classRSS_1_1FileRetriever.html" title="Implements a file retriever, to be used with Loader::loadFrom().">FileRetriever</a>(<span class="keyword">const</span> <a class="code" href="classRSS_1_1FileRetriever.html" title="Implements a file retriever, to be used with Loader::loadFrom().">FileRetriever</a> &other); <a name="l00149"></a>00149 <a class="code" href="classRSS_1_1FileRetriever.html" title="Implements a file retriever, to be used with Loader::loadFrom().">FileRetriever</a> &operator=(<span class="keyword">const</span> <a class="code" href="classRSS_1_1FileRetriever.html" title="Implements a file retriever, to be used with Loader::loadFrom().">FileRetriever</a> &other); <a name="l00150"></a>00150 <a name="l00151"></a>00151 <span class="keyword">struct </span>Private; <a name="l00152"></a>00152 Private *d; <a name="l00153"></a>00153 }; <a name="l00154"></a>00154 <a name="l00160"></a><a class="code" href="classRSS_1_1OutputRetriever.html">00160</a> <span class="keyword">class </span><a class="code" href="classRSS_1_1OutputRetriever.html" title="Implements a data retriever which executes a program and stores returned by the program...">OutputRetriever</a> : <span class="keyword">public</span> <a class="code" href="classRSS_1_1DataRetriever.html" title="Abstract baseclass for all data retriever classes.">DataRetriever</a> <a name="l00161"></a>00161 { <a name="l00162"></a>00162 Q_OBJECT <a name="l00163"></a>00163 <span class="keyword">public</span>: <a name="l00167"></a>00167 <a class="code" href="classRSS_1_1OutputRetriever.html#2ebab1cd90d1465f3b2c2571be3501e0" title="Default constructor.">OutputRetriever</a>(); <a name="l00168"></a>00168 <a name="l00172"></a>00172 <span class="keyword">virtual</span> <a class="code" href="classRSS_1_1OutputRetriever.html#08180659864491a776808f8dc98f16a2" title="Destructor.">~OutputRetriever</a>(); <a name="l00173"></a>00173 <a name="l00181"></a>00181 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classRSS_1_1OutputRetriever.html#20ff9a06074aed5241d605975542c4dd" title="Executes the program referenced by the given URL and retrieves the data which the...">retrieveData</a>(<span class="keyword">const</span> KURL &url); <a name="l00182"></a>00182 <a name="l00189"></a>00189 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classRSS_1_1OutputRetriever.html#e068f83185c4c244e109691383586a10">errorCode</a>() <span class="keyword">const</span>; <a name="l00190"></a>00190 <a name="l00191"></a>00191 <span class="keyword">virtual</span> <span class="keywordtype">void</span> abort() {} <a name="l00192"></a>00192 <a name="l00193"></a>00193 <span class="keyword">private</span> slots: <a name="l00194"></a>00194 <span class="keywordtype">void</span> slotOutput(KProcess *process, <span class="keywordtype">char</span> *data, <span class="keywordtype">int</span> length); <a name="l00195"></a>00195 <span class="keywordtype">void</span> slotExited(KProcess *process); <a name="l00196"></a>00196 <a name="l00197"></a>00197 <span class="keyword">private</span>: <a name="l00198"></a>00198 <a class="code" href="classRSS_1_1OutputRetriever.html#2ebab1cd90d1465f3b2c2571be3501e0" title="Default constructor.">OutputRetriever</a>(<span class="keyword">const</span> <a class="code" href="classRSS_1_1OutputRetriever.html" title="Implements a data retriever which executes a program and stores returned by the program...">OutputRetriever</a> &other); <a name="l00199"></a>00199 <a class="code" href="classRSS_1_1OutputRetriever.html" title="Implements a data retriever which executes a program and stores returned by the program...">OutputRetriever</a> &operator=(<span class="keyword">const</span> <a class="code" href="classRSS_1_1OutputRetriever.html" title="Implements a data retriever which executes a program and stores returned by the program...">OutputRetriever</a> &other); <a name="l00200"></a>00200 <a name="l00201"></a>00201 <span class="keyword">struct </span>Private; <a name="l00202"></a>00202 Private *d; <a name="l00203"></a>00203 }; <a name="l00204"></a>00204 <a name="l00254"></a><a class="code" href="classRSS_1_1Loader.html">00254</a> <span class="keyword">class </span>KDE_EXPORT <a class="code" href="classRSS_1_1Loader.html" title="This class is the preferred way of loading RSS files.">Loader</a> : <span class="keyword">public</span> QObject <a name="l00255"></a>00255 { <a name="l00256"></a>00256 Q_OBJECT <a name="l00257"></a>00257 <span class="keyword">friend</span> <span class="keyword">class </span>someClassWhichDoesNotExist; <a name="l00258"></a>00258 <span class="keyword">public</span>: <a name="l00267"></a>00267 <span class="keyword">static</span> <a class="code" href="classRSS_1_1Loader.html" title="This class is the preferred way of loading RSS files.">Loader</a> *create(); <a name="l00268"></a>00268 <a name="l00276"></a>00276 <span class="keyword">static</span> <a class="code" href="classRSS_1_1Loader.html" title="This class is the preferred way of loading RSS files.">Loader</a> *create(QObject *<span class="keywordtype">object</span>, <span class="keyword">const</span> <span class="keywordtype">char</span> *slot); <a name="l00277"></a>00277 <a name="l00293"></a>00293 <span class="keywordtype">void</span> loadFrom(<span class="keyword">const</span> KURL &url, <a class="code" href="classRSS_1_1DataRetriever.html" title="Abstract baseclass for all data retriever classes.">DataRetriever</a> *retriever); <a name="l00294"></a>00294 <a name="l00299"></a>00299 <span class="keywordtype">int</span> errorCode() <span class="keyword">const</span>; <a name="l00300"></a>00300 <a name="l00301"></a>00301 <span class="keyword">const</span> KURL &discoveredFeedURL() <span class="keyword">const</span>; <a name="l00302"></a>00302 <a name="l00303"></a>00303 <span class="keywordtype">void</span> abort(); <a name="l00304"></a>00304 <a name="l00305"></a>00305 signals: <a name="l00323"></a>00323 <span class="keywordtype">void</span> loadingComplete(<a class="code" href="classRSS_1_1Loader.html" title="This class is the preferred way of loading RSS files.">Loader</a> *loader, <a class="code" href="classRSS_1_1Document.html" title="Represents a RSS document and provides all the features and properties as stored...">Document</a> doc, Status status); <a name="l00324"></a>00324 <a name="l00325"></a>00325 <span class="keyword">private</span> slots: <a name="l00326"></a>00326 <span class="keywordtype">void</span> slotRetrieverDone(<span class="keyword">const</span> QByteArray &data, <span class="keywordtype">bool</span> success); <a name="l00327"></a>00327 <a name="l00328"></a>00328 <span class="keyword">private</span>: <a name="l00329"></a>00329 <a class="code" href="classRSS_1_1Loader.html" title="This class is the preferred way of loading RSS files.">Loader</a>(); <a name="l00330"></a>00330 <a class="code" href="classRSS_1_1Loader.html" title="This class is the preferred way of loading RSS files.">Loader</a>(<span class="keyword">const</span> <a class="code" href="classRSS_1_1Loader.html" title="This class is the preferred way of loading RSS files.">Loader</a> &other); <a name="l00331"></a>00331 <a class="code" href="classRSS_1_1Loader.html" title="This class is the preferred way of loading RSS files.">Loader</a> &operator=(<span class="keyword">const</span> <a class="code" href="classRSS_1_1Loader.html" title="This class is the preferred way of loading RSS files.">Loader</a> &other); <a name="l00332"></a>00332 ~<a class="code" href="classRSS_1_1Loader.html" title="This class is the preferred way of loading RSS files.">Loader</a>(); <a name="l00333"></a>00333 <span class="keywordtype">void</span> discoverFeeds(<span class="keyword">const</span> QByteArray &data); <a name="l00334"></a>00334 <a name="l00335"></a>00335 <span class="keyword">struct </span>Private; <a name="l00336"></a>00336 Private *d; <a name="l00337"></a>00337 }; <a name="l00338"></a>00338 } <a name="l00339"></a>00339 <a name="l00340"></a>00340 <span class="preprocessor">#endif // LIBRSS_LOADER_H</span> <a name="l00341"></a>00341 <span class="preprocessor"></span><span class="comment">// vim: noet:ts=4</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/librss</h2> <div class="nav_list"> <ul><li><a href="index.html">Main Page</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="classRSS_1_1Article.html">rss::article</option>, <option value="classRSS_1_1DataRetriever.html">rss::dataretriever</option>, <option value="classRSS_1_1Document.html">rss::document</option>, <option value="classRSS_1_1FeedDetector.html">rss::feeddetector</option>, <option value="classRSS_1_1FileRetriever.html">rss::fileretriever</option>, <option value="classRSS_1_1Image.html">rss::image</option>, <option value="classRSS_1_1Loader.html">rss::loader</option>, <option value="classRSS_1_1OutputRetriever.html">rss::outputretriever</option>, <option value="classRSS_1_1TextInput.html">rss::textinput</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>