<?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: RSS::DataRetriever Class Reference (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 --> <div class="navpath"><b>RSS</b>::<a class="el" href="classRSS_1_1DataRetriever.html">DataRetriever</a> </div> <div class="contents"> <h1>RSS::DataRetriever Class Reference</h1><!-- doxytag: class="RSS::DataRetriever" --><!-- doxytag: inherits="QObject" --><code>#include <<a class="el" href="loader_8h-source.html">loader.h</a>></code> <p> <div class="dynheader"> Inheritance diagram for RSS::DataRetriever:</div> <div class="dynsection"> <p><center><img src="classRSS_1_1DataRetriever.png" usemap="#RSS::DataRetriever_map" border="0" alt=""></center> <map name="RSS::DataRetriever_map"> <area href="classRSS_1_1FileRetriever.html" alt="RSS::FileRetriever" shape="rect" coords="0,56,131,80"> <area href="classRSS_1_1OutputRetriever.html" alt="RSS::OutputRetriever" shape="rect" coords="141,56,272,80"> </map> </div> <p> <a href="classRSS_1_1DataRetriever-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2> Abstract baseclass for all data retriever classes. <p> Subclass this to add a new retrieval algorithm which can then be plugged into the RSS loader. <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classRSS_1_1Loader.html" title="This class is the preferred way of loading RSS files.">Loader</a>, <a class="el" href="classRSS_1_1FileRetriever.html" title="Implements a file retriever, to be used with Loader::loadFrom().">FileRetriever</a>, <a class="el" href="classRSS_1_1OutputRetriever.html" title="Implements a data retriever which executes a program and stores returned by the program...">OutputRetriever</a> </dd></dl> <p>Definition at line <a class="el" href="loader_8h-source.html#l00035">35</a> of file <a class="el" href="loader_8h-source.html">loader.h</a>.</p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Signals</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRSS_1_1DataRetriever.html#f9952c6facfdfb988eb366b5122f6c7a">dataRetrieved</a> (const QByteArray &data, bool success)</td></tr> <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRSS_1_1DataRetriever.html#154b9c3fbfd303e9c0761915eb208818">DataRetriever</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classRSS_1_1DataRetriever.html#ca73b036154d60bfa410beb1a49c04bb">~DataRetriever</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRSS_1_1DataRetriever.html#8421788da56923a8842fd6b6e06d9aee">retrieveData</a> (const KURL &url)=0</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classRSS_1_1DataRetriever.html#606a13ac58bcec0f2d5d40fedb2e244f">errorCode</a> () const =0</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2865fd19e1c7677f7adaf3019846beba"></a><!-- doxytag: member="RSS::DataRetriever::abort" ref="2865fd19e1c7677f7adaf3019846beba" args="()=0" --> virtual void </td><td class="memItemRight" valign="bottom"><b>abort</b> ()=0</td></tr> </table> <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="154b9c3fbfd303e9c0761915eb208818"></a><!-- doxytag: member="RSS::DataRetriever::DataRetriever" ref="154b9c3fbfd303e9c0761915eb208818" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">DataRetriever::DataRetriever </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> Default constructor. <p> <p>Definition at line <a class="el" href="loader_8cpp-source.html#l00030">30</a> of file <a class="el" href="loader_8cpp-source.html">loader.cpp</a>.</p> </div> </div><p> <a class="anchor" name="ca73b036154d60bfa410beb1a49c04bb"></a><!-- doxytag: member="RSS::DataRetriever::~DataRetriever" ref="ca73b036154d60bfa410beb1a49c04bb" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">DataRetriever::~DataRetriever </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Destructor. <p> <p>Definition at line <a class="el" href="loader_8cpp-source.html#l00034">34</a> of file <a class="el" href="loader_8cpp-source.html">loader.cpp</a>.</p> </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="8421788da56923a8842fd6b6e06d9aee"></a><!-- doxytag: member="RSS::DataRetriever::retrieveData" ref="8421788da56923a8842fd6b6e06d9aee" args="(const KURL &url)=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void RSS::DataRetriever::retrieveData </td> <td>(</td> <td class="paramtype">const KURL & </td> <td class="paramname"> <em>url</em> </td> <td> ) </td> <td width="100%"><code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Retrieve data from the given URL. <p> This method is supposed to get reimplemented by subclasses. It will be called by the <a class="el" href="classRSS_1_1Loader.html" title="This class is the preferred way of loading RSS files.">Loader</a> class in case it needs to retrieve the data. <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classRSS_1_1Loader.html#259a68def7c44a066a980c3e544ac0db" title="Loads the RSS file referenced by the given URL using the specified retrieval algorithm...">Loader::loadFrom()</a> </dd></dl> <p>Implemented in <a class="el" href="classRSS_1_1FileRetriever.html#cfa01a9e959913f34a47c2a798e0498f">RSS::FileRetriever</a>, and <a class="el" href="classRSS_1_1OutputRetriever.html#20ff9a06074aed5241d605975542c4dd">RSS::OutputRetriever</a>.</p> </div> </div><p> <a class="anchor" name="606a13ac58bcec0f2d5d40fedb2e244f"></a><!-- doxytag: member="RSS::DataRetriever::errorCode" ref="606a13ac58bcec0f2d5d40fedb2e244f" args="() const =0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual int RSS::DataRetriever::errorCode </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"> const<code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>An error code which might give a more precise information about what went wrong in case the 'success' flag returned with the <a class="el" href="classRSS_1_1DataRetriever.html#f9952c6facfdfb988eb366b5122f6c7a" title="Emit this signal to tell the Loader class that the retrieval process was finished...">dataRetrieved()</a> signal was 'false'. Note that the meaning of the returned integer depends on the actual data retriever. </dd></dl> <p>Implemented in <a class="el" href="classRSS_1_1FileRetriever.html#6a7a5bea6a1f75a2c3ff76a215edb4df">RSS::FileRetriever</a>, and <a class="el" href="classRSS_1_1OutputRetriever.html#e068f83185c4c244e109691383586a10">RSS::OutputRetriever</a>.</p> </div> </div><p> <a class="anchor" name="f9952c6facfdfb988eb366b5122f6c7a"></a><!-- doxytag: member="RSS::DataRetriever::dataRetrieved" ref="f9952c6facfdfb988eb366b5122f6c7a" args="(const QByteArray &data, bool success)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void RSS::DataRetriever::dataRetrieved </td> <td>(</td> <td class="paramtype">const QByteArray & </td> <td class="paramname"> <em>data</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"> <em>success</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [signal]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Emit this signal to tell the <a class="el" href="classRSS_1_1Loader.html" title="This class is the preferred way of loading RSS files.">Loader</a> class that the retrieval process was finished. <p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>Should contain the retrieved data and will get parsed by the <a class="el" href="classRSS_1_1Loader.html" title="This class is the preferred way of loading RSS files.">Loader</a> class. </td></tr> <tr><td valign="top"></td><td valign="top"><em>success</em> </td><td>Indicates whether there were any problems during the retrieval process. Pass 'true' to indicate that everything went seamlessy, 'false' to tell the <a class="el" href="classRSS_1_1Loader.html" title="This class is the preferred way of loading RSS files.">Loader</a> that something went wrong and that the data parameter might contain no or invalid data. </td></tr> </table> </dl> </div> </div><p> <hr>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="loader_8h-source.html">loader.h</a><li><a class="el" href="loader_8cpp-source.html">loader.cpp</a></ul> </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>