<?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" xml:lang="en"> <head> <title>Syndication::DataRetriever Class Reference</title> <style type="text/css"> .cp-doNotDisplay { display: none; } @media aural, braille, handheld, tty { .cp-doNotDisplay { display: inline; speak: normal; }} .cp-edit { text-align: right; } @media print, embossed { .cp-edit { display: none; }} </style> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta http-equiv="Content-Style-Type" content="text/css" /> <link rel="meta" href="http://www.kde.org/labels.rdf" type="application/rdf+xml" title="ICRA labels" /> <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" /> <meta name="no-email-collection" content="http://www.unspam.com/noemailcollection" /> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link rel="shortcut icon" href="../../favicon.ico" /><link rel="icon" href="../../favicon.ico" /> <link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../../kde.css" /> <link rel="stylesheet" media="print, embossed" type="text/css" href="../../print.css" /> <link rel="stylesheet" media="screen, aural, handheld, tty, braille" type="text/css" title="Flat" href="../../flat.css" /> <link rel="stylesheet" type="text/css" href="../../doxygen.css" /> <link rel="stylesheet" type="text/css" href="../../tabs.css" /> </head> <body> <ul class="cp-doNotDisplay"> <li><a href="#cp-content" accesskey="2">Skip to content</a></li> <li><a href="#cp-menu" accesskey="5">Skip to link menu</a></li> </ul> <div id="container"> <div id="header"> <div id="header_top"><div><div> <img alt ="" src="../../top-kde.jpg"/> </div></div></div> <div id="header_bottom"> <div id="location"> <ul> <li><a href="http://api.kde.org">KDE API Reference</a></li> <li><a href="../../index.html">kdepimlibs-4.10.5 API Reference</a></li> </ul> </div> <div id="menu"> <ul> <li><a href="http://www.kde.org/">KDE Home</a></li> <li><a href="http://kde.org/contact/">Contact Us</a></li> </ul> </div> </div> </div> <!-- End page header --> <div id="body_wrapper"> <div id="body"> <!-- begin main content --> <div id="right"> <div class="content"> <div id="main"> <div class="clearer"> </div> <h2><a name="content"></a>Syndication Library</h2> <!-- BC --> <div id="top"> <!-- Generated by Doxygen 1.8.3.1 --> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="namespaceSyndication.html">Syndication</a></li><li class="navelem"><a class="el" href="classSyndication_1_1DataRetriever.html">DataRetriever</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#signals">Signals</a> | <a href="#pub-methods">Public Member Functions</a> | <a href="classSyndication_1_1DataRetriever-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">Syndication::DataRetriever Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> </div><!--header--> <div class="contents"> <p><code>#include <<a class="el" href="dataretriever_8h_source.html">dataretriever.h</a>></code></p> <div class="dynheader"> Inheritance diagram for Syndication::DataRetriever:</div> <div class="dyncontent"> <div class="center"> <img src="classSyndication_1_1DataRetriever.png" usemap="#Syndication::DataRetriever_map" alt=""/> <map id="Syndication::DataRetriever_map" name="Syndication::DataRetriever_map"> <area href="classSyndication_1_1FileRetriever.html" title="Implements a file retriever, to be used with Loader::loadFrom()." alt="Syndication::FileRetriever" shape="rect" coords="0,56,173,80"/> <area href="classSyndication_1_1OutputRetriever.html" title="Implements a data retriever which executes a program and stores returned by the program on stdout..." alt="Syndication::OutputRetriever" shape="rect" coords="183,56,356,80"/> </map> </div></div> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="signals"></a> Signals</h2></td></tr> <tr class="memitem:af5dd1af46dcd51d6a166c73d25b2894e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSyndication_1_1DataRetriever.html#af5dd1af46dcd51d6a166c73d25b2894e">dataRetrieved</a> (const QByteArray &data, bool success)</td></tr> <tr class="separator:af5dd1af46dcd51d6a166c73d25b2894e"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:a86a9e2c1c9a6cccf047a41d3e1371cc7"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSyndication_1_1DataRetriever.html#a86a9e2c1c9a6cccf047a41d3e1371cc7">DataRetriever</a> ()</td></tr> <tr class="separator:a86a9e2c1c9a6cccf047a41d3e1371cc7"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a90c903044d2982affef233fa112d3ebd"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classSyndication_1_1DataRetriever.html#a90c903044d2982affef233fa112d3ebd">~DataRetriever</a> ()</td></tr> <tr class="separator:a90c903044d2982affef233fa112d3ebd"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a65cd5b3bf022f0e67c66c1660c12a258"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSyndication_1_1DataRetriever.html#a65cd5b3bf022f0e67c66c1660c12a258">abort</a> ()=0</td></tr> <tr class="separator:a65cd5b3bf022f0e67c66c1660c12a258"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad1165f2bf6d331581281d68a2936b17e"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classSyndication_1_1DataRetriever.html#ad1165f2bf6d331581281d68a2936b17e">errorCode</a> () const =0</td></tr> <tr class="separator:ad1165f2bf6d331581281d68a2936b17e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a613a696cbae5e028dc3e867d6f72b34c"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSyndication_1_1DataRetriever.html#a613a696cbae5e028dc3e867d6f72b34c">retrieveData</a> (const KUrl &url)=0</td></tr> <tr class="separator:a613a696cbae5e028dc3e867d6f72b34c"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Abstract baseclass for all data retriever classes. </p> <p>Subclass this to add a new retrieval algorithm which can then be plugged into the RSS loader. </p> <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classSyndication_1_1Loader.html" title="This class is the preferred way of loading feed sources.">Loader</a>, <a class="el" href="classSyndication_1_1FileRetriever.html" title="Implements a file retriever, to be used with Loader::loadFrom().">FileRetriever</a>, <a class="el" href="classSyndication_1_1OutputRetriever.html" title="Implements a data retriever which executes a program and stores returned by the program on stdout...">OutputRetriever</a> </dd></dl> <p>Definition at line <a class="el" href="dataretriever_8h_source.html#l00036">36</a> of file <a class="el" href="dataretriever_8h_source.html">dataretriever.h</a>.</p> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a class="anchor" id="a86a9e2c1c9a6cccf047a41d3e1371cc7"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Syndication::DataRetriever::DataRetriever </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Default constructor. </p> <p>Definition at line <a class="el" href="dataretriever_8cpp_source.html#l00025">25</a> of file <a class="el" href="dataretriever_8cpp_source.html">dataretriever.cpp</a>.</p> </div> </div> <a class="anchor" id="a90c903044d2982affef233fa112d3ebd"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">Syndication::DataRetriever::~DataRetriever </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Destructor. </p> <p>Definition at line <a class="el" href="dataretriever_8cpp_source.html#l00029">29</a> of file <a class="el" href="dataretriever_8cpp_source.html">dataretriever.cpp</a>.</p> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="a65cd5b3bf022f0e67c66c1660c12a258"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual void Syndication::DataRetriever::abort </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>aborts the retrieval process. </p> <p>Implemented in <a class="el" href="classSyndication_1_1FileRetriever.html#a8acd1f7620ebcc5fd5840b5bc19e9776">Syndication::FileRetriever</a>, and <a class="el" href="classSyndication_1_1OutputRetriever.html#a4ae3b97ad2ffe3299e687eadfa36d374">Syndication::OutputRetriever</a>.</p> </div> </div> <a class="anchor" id="af5dd1af46dcd51d6a166c73d25b2894e"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void Syndication::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> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">signal</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Emit this signal to tell the <a class="el" href="classSyndication_1_1Loader.html" title="This class is the preferred way of loading feed sources.">Loader</a> class that the retrieval process was finished. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">data</td><td>Should contain the retrieved data and will get parsed by the <a class="el" href="classSyndication_1_1Loader.html" title="This class is the preferred way of loading feed sources.">Loader</a> class. </td></tr> <tr><td class="paramname">success</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="classSyndication_1_1Loader.html" title="This class is the preferred way of loading feed sources.">Loader</a> that something went wrong and that the data parameter might contain no or invalid data. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="ad1165f2bf6d331581281d68a2936b17e"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual int Syndication::DataRetriever::errorCode </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <dl class="section return"><dt>Returns</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="classSyndication_1_1DataRetriever.html#af5dd1af46dcd51d6a166c73d25b2894e" 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="classSyndication_1_1FileRetriever.html#a1ae7ac893077750cd8f2366b3eb4b38c">Syndication::FileRetriever</a>, and <a class="el" href="classSyndication_1_1OutputRetriever.html#a25c573996f040c1f0b1141747e96093b">Syndication::OutputRetriever</a>.</p> </div> </div> <a class="anchor" id="a613a696cbae5e028dc3e867d6f72b34c"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual void Syndication::DataRetriever::retrieveData </td> <td>(</td> <td class="paramtype">const KUrl & </td> <td class="paramname"><em>url</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Retrieve data from the given URL. </p> <p>This method is supposed to get reimplemented by subclasses. It will be called by the <a class="el" href="classSyndication_1_1Loader.html" title="This class is the preferred way of loading feed sources.">Loader</a> class in case it needs to retrieve the data.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">url</td><td>the URL to retrieve data from</td></tr> </table> </dd> </dl> <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classSyndication_1_1Loader.html#a966e3290ce15d5c195d25dcc901b435a" title="Loads the feed source referenced by the given URL using the specified retrieval algorithm.">Loader::loadFrom()</a> </dd></dl> <p>Implemented in <a class="el" href="classSyndication_1_1FileRetriever.html#a313251adcaed47131fc9d7ab353c0d6f">Syndication::FileRetriever</a>, and <a class="el" href="classSyndication_1_1OutputRetriever.html#ad5c039650a6583b31dd30038a223eda2">Syndication::OutputRetriever</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="dataretriever_8h_source.html">dataretriever.h</a></li> <li><a class="el" href="dataretriever_8cpp_source.html">dataretriever.cpp</a></li> </ul> </div><!-- contents --> <div class="copyrights"> This file is part of the KDE documentation.<br/> Documentation copyright © 1996-2013 The KDE developers.<br/> Generated on Fri Jul 12 2013 16:48:30 by <a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.3.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, © 1997-2006 <p> KDE's <a href="http://techbase.kde.org/Policies/Library_Documentation_Policy">Doxygen guidelines</a> are available online. </p> </div> </div> </div> </div> <div id="left"> <div class="menu_box"> <a name="cp-menu" /><div class="menutitle"><div> <h2 id="cp-menu-project">Syndication Library</h2> <a href="#cp-skip-project" class="cp-doNotDisplay">Skip menu "Syndication Library"</a> </div></div> <ul><li><a href="index.html">Main Page</a></li><li><a href="namespaces.html">Namespace List</a></li><li><a href="namespacemembers.html">Namespace Members</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="hierarchy.html">Class Hierarchy</a></li><li><a href="functions.html">Class Members</a></li><li><a href="files.html">File List</a></li><li><a href="pages.html">Related Pages</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="classSyndication_1_1AbstractParser.html">syndication::abstractparser</option>, <option value="classSyndication_1_1Category.html">syndication::category</option>, <option value="classSyndication_1_1DataRetriever.html">syndication::dataretriever</option>, <option value="classSyndication_1_1DocumentSource.html">syndication::documentsource</option>, <option value="classSyndication_1_1DocumentVisitor.html">syndication::documentvisitor</option>, <option value="classSyndication_1_1ElementWrapper.html">syndication::elementwrapper</option>, <option value="classSyndication_1_1Enclosure.html">syndication::enclosure</option>, <option value="classSyndication_1_1Feed.html">syndication::feed</option>, <option value="classSyndication_1_1FileRetriever.html">syndication::fileretriever</option>, <option value="classSyndication_1_1Image.html">syndication::image</option>, <option value="classSyndication_1_1Item.html">syndication::item</option>, <option value="classSyndication_1_1Loader.html">syndication::loader</option>, <option value="classSyndication_1_1Mapper.html">syndication::mapper</option>, <option value="classSyndication_1_1OutputRetriever.html">syndication::outputretriever</option>, <option value="classSyndication_1_1ParserCollection.html">syndication::parsercollection</option>, <option value="classSyndication_1_1Person.html">syndication::person</option>, <option value="classSyndication_1_1SpecificDocument.html">syndication::specificdocument</option>, <option value="classSyndication_1_1SpecificItem.html">syndication::specificitem</option>, <option value="classSyndication_1_1SpecificItemVisitor.html">syndication::specificitemvisitor</option>, </select> </form> </div> --> <div class="menu_box"> <a name="cp-menu" /><div class="menutitle"><div> <h2 id="cp-menu-project">kdepimlibs-4.10.5 API Reference</h2> <a href="#cp-skip-project" class="cp-doNotDisplay">Skip menu "kdepimlibs-4.10.5 API Reference"</a> </div></div> <div class="nav_list"> <ul> <li><a href="../../akonadi/html/index.html">akonadi</a></li><li> <a href="../../akonadi/contact/html/index.html">contact</a></li><li> <a href="../../akonadi/kmime/html/index.html">kmime</a></li><li> <a href="../../akonadi/socialutils/html/index.html">socialutils</a></li><li><a href="../../kabc/html/index.html">kabc</a></li><li><a href="../../kalarmcal/html/index.html">kalarmcal</a></li><li><a href="../../kblog/html/index.html">kblog</a></li><li><a href="../../kcal/html/index.html">kcal</a></li><li><a href="../../kcalcore/html/index.html">kcalcore</a></li><li><a href="../../kcalutils/html/index.html">kcalutils</a></li><li><a href="../../kholidays/html/index.html">kholidays</a></li><li><a href="../../kimap/html/index.html">kimap</a></li><li><a href="../../kioslave/html/index.html">kioslave</a></li><li> <a href="../../kioslave/imap4/html/index.html">imap4</a></li><li> <a href="../../kioslave/mbox/html/index.html">mbox</a></li><li> <a href="../../kioslave/nntp/html/index.html">nntp</a></li><li><a href="../../kldap/html/index.html">kldap</a></li><li><a href="../../kmbox/html/index.html">kmbox</a></li><li><a href="../../kmime/html/index.html">kmime</a></li><li><a href="../../kontactinterface/html/index.html">kontactinterface</a></li><li><a href="../../kpimidentities/html/index.html">kpimidentities</a></li><li><a href="../../kpimtextedit/html/index.html">kpimtextedit</a></li><li><a href="../../kpimutils/html/index.html">kpimutils</a></li><li><a href="../../kresources/html/index.html">kresources</a></li><li><a href="../../ktnef/html/index.html">ktnef</a></li><li><a href="../../kxmlrpcclient/html/index.html">kxmlrpcclient</a></li><li><a href="../../mailtransport/html/index.html">mailtransport</a></li><li><a href="../../microblog/html/index.html">microblog</a></li><li><a href="../../qgpgme/html/index.html">qgpgme</a></li><li><a href="../../syndication/html/index.html">syndication</a></li><li> <a href="../../syndication/atom/html/index.html">atom</a></li><li> <a href="../../syndication/rdf/html/index.html">rdf</a></li><li> <a href="../../syndication/rss2/html/index.html">rss2</a></li> </ul></div></div> <!-- api_searchbox --> </div> </div> <div class="clearer"></div> </div> <div class="clearer"></div> </div> <div id="end_body"></div> <div id="footer"><div id="footer_text"> Report problems with this website to <a href="https://bugs.kde.org/enter_sysadmin_request.cgi?component=api.kde.org">our bug tracking system</a>.<br> Contact the specific authors with questions and comments about the page contents.<p> KDE<sup>®</sup> and <a href="/media/images/kde_gear_black.png">the K Desktop Environment<sup>®</sup> logo</a> are registered trademarks of <a href="http://ev.kde.org/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> | <a href="http://www.kde.org/contact/impressum.php">Legal</a></p> </div></div> </div> <!-- WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL BE BLOCKED INSTANTLY AND PERMANENTLY! <a href="mailto:aaaatrap-45abe0e0c3bebc77@kde.org">Block me</a> WARNING END --> </body> </html>