<?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::FileRetriever 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_1FileRetriever.html">FileRetriever</a>
</div>
<div class="contents">
<h1>RSS::FileRetriever Class Reference</h1><!-- doxytag: class="RSS::FileRetriever" --><!-- doxytag: inherits="RSS::DataRetriever" --><code>#include <<a class="el" href="loader_8h-source.html">loader.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for RSS::FileRetriever:</div>
<div class="dynsection">
<p><center><img src="classRSS_1_1FileRetriever.png" usemap="#RSS::FileRetriever_map" border="0" alt=""></center>
<map name="RSS::FileRetriever_map">
<area href="classRSS_1_1DataRetriever.html" alt="RSS::DataRetriever" shape="rect" coords="0,0,120,24">
</map>
</div>
<p>
<a href="classRSS_1_1FileRetriever-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Implements a file retriever, to be used with <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>.
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classRSS_1_1DataRetriever.html" title="Abstract baseclass for all data retriever classes.">DataRetriever</a>, <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>Definition at line <a class="el" href="loader_8h-source.html#l00089">89</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_1FileRetriever.html#ffde5f05c293d61c88fe640ac5df7476">permanentRedirection</a> (const KURL &url)</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_1FileRetriever.html#c28c5252538f7158b336771ed3112220">FileRetriever</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_1FileRetriever.html#80014b3e6f3b2a77c272da4605a84b10">~FileRetriever</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_1FileRetriever.html#cfa01a9e959913f34a47c2a798e0498f">retrieveData</a> (const KURL &url)</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_1FileRetriever.html#6a7a5bea6a1f75a2c3ff76a215edb4df">errorCode</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="967a312f44c3a6237014a13cf9a6d1b3"></a><!-- doxytag: member="RSS::FileRetriever::abort" ref="967a312f44c3a6237014a13cf9a6d1b3" args="()" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>abort</b> ()</td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1444ab7ee61ee7bbe14fe218da9917e8"></a><!-- doxytag: member="RSS::FileRetriever::setUseCache" ref="1444ab7ee61ee7bbe14fe218da9917e8" args="(bool enabled)" -->
static void </td><td class="memItemRight" valign="bottom"><b>setUseCache</b> (bool enabled)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a8e1cc8325a28db05482c0bb734f59f5"></a><!-- doxytag: member="RSS::FileRetriever::setUserAgent" ref="a8e1cc8325a28db05482c0bb734f59f5" args="(const QString &ua)" -->
static void </td><td class="memItemRight" valign="bottom"><b>setUserAgent</b> (const QString &ua)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1c968c7f3cb0078ee7b2649fa11af25f"></a><!-- doxytag: member="RSS::FileRetriever::userAgent" ref="1c968c7f3cb0078ee7b2649fa11af25f" args="()" -->
static QString </td><td class="memItemRight" valign="bottom"><b>userAgent</b> ()</td></tr>
<tr><td colspan="2"><br><h2>Protected Slots</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b49eafcfdea559241fc4091f2061cef6"></a><!-- doxytag: member="RSS::FileRetriever::slotTimeout" ref="b49eafcfdea559241fc4091f2061cef6" args="()" -->
void </td><td class="memItemRight" valign="bottom"><b>slotTimeout</b> ()</td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="c28c5252538f7158b336771ed3112220"></a><!-- doxytag: member="RSS::FileRetriever::FileRetriever" ref="c28c5252538f7158b336771ed3112220" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FileRetriever::FileRetriever </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#l00062">62</a> of file <a class="el" href="loader_8cpp-source.html">loader.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="80014b3e6f3b2a77c272da4605a84b10"></a><!-- doxytag: member="RSS::FileRetriever::~FileRetriever" ref="80014b3e6f3b2a77c272da4605a84b10" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FileRetriever::~FileRetriever </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#l00067">67</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="cfa01a9e959913f34a47c2a798e0498f"></a><!-- doxytag: member="RSS::FileRetriever::retrieveData" ref="cfa01a9e959913f34a47c2a798e0498f" args="(const KURL &url)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FileRetriever::retrieveData </td>
<td>(</td>
<td class="paramtype">const KURL & </td>
<td class="paramname"> <em>url</em> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Downloads the file referenced by the given URL and passes it's contents on to the <a class="el" href="classRSS_1_1Loader.html" title="This class is the preferred way of loading RSS files.">Loader</a>.
<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>url</em> </td><td>An URL referencing a file which is assumed to reference valid XML. </td></tr>
</table>
</dl>
<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>Implements <a class="el" href="classRSS_1_1DataRetriever.html#8421788da56923a8842fd6b6e06d9aee">RSS::DataRetriever</a>.</p>
<p>Definition at line <a class="el" href="loader_8cpp-source.html#l00093">93</a> of file <a class="el" href="loader_8cpp-source.html">loader.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="6a7a5bea6a1f75a2c3ff76a215edb4df"></a><!-- doxytag: member="RSS::FileRetriever::errorCode" ref="6a7a5bea6a1f75a2c3ff76a215edb4df" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FileRetriever::errorCode </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The error code for the last process of retrieving data. The returned numbers correspond directly to the error codes <a href="http://developer.kde.org/documentation/library/cvs-api/classref/kio/KIO.html#Error">as defined by KIO</a>. </dd></dl>
<p>Implements <a class="el" href="classRSS_1_1DataRetriever.html#606a13ac58bcec0f2d5d40fedb2e244f">RSS::DataRetriever</a>.</p>
<p>Definition at line <a class="el" href="loader_8cpp-source.html#l00135">135</a> of file <a class="el" href="loader_8cpp-source.html">loader.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="ffde5f05c293d61c88fe640ac5df7476"></a><!-- doxytag: member="RSS::FileRetriever::permanentRedirection" ref="ffde5f05c293d61c88fe640ac5df7476" args="(const KURL &url)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RSS::FileRetriever::permanentRedirection </td>
<td>(</td>
<td class="paramtype">const KURL & </td>
<td class="paramname"> <em>url</em> </td>
<td> ) </td>
<td width="100%"><code> [signal]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Signals a permanent redirection.
<p>
The redirection itself is handled internally, so you don't need to call <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> with the new URL. This signal is useful in case you want to notify the user, or adjust a database entry. <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>
</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>
