akregator/src/librss

Signals | Public Member Functions | Static Public Member Functions | Protected Slots | List of all members
RSS::FileRetriever Class Reference

#include <loader.h>

Inheritance diagram for RSS::FileRetriever:
RSS::DataRetriever

Signals

void permanentRedirection (const KURL &url)
 
- Signals inherited from RSS::DataRetriever
void dataRetrieved (const TQByteArray &data, bool success)
 

Public Member Functions

 FileRetriever ()
 
virtual ~FileRetriever ()
 
virtual void retrieveData (const KURL &url)
 
virtual int errorCode () const
 
virtual void abort ()
 
- Public Member Functions inherited from RSS::DataRetriever
 DataRetriever ()
 
virtual ~DataRetriever ()
 
virtual void retrieveData (const KURL &url)=0
 
virtual int errorCode () const =0
 
virtual void abort ()=0
 

Static Public Member Functions

static void setUseCache (bool enabled)
 
static void setUserAgent (const TQString &ua)
 
static TQString userAgent ()
 

Protected Slots

void slotTimeout ()
 

Detailed Description

Implements a file retriever, to be used with Loader::loadFrom().

See also
DataRetriever, Loader::loadFrom()

Definition at line 90 of file loader.h.

Constructor & Destructor Documentation

◆ FileRetriever()

FileRetriever::FileRetriever ( )

Default constructor.

Definition at line 62 of file loader.cpp.

◆ ~FileRetriever()

FileRetriever::~FileRetriever ( )
virtual

Destructor.

Definition at line 67 of file loader.cpp.

Member Function Documentation

◆ abort()

void FileRetriever::abort ( )
virtual

Implements RSS::DataRetriever.

Definition at line 162 of file loader.cpp.

◆ errorCode()

int FileRetriever::errorCode ( ) const
virtual
Returns
The error code for the last process of retrieving data. The returned numbers correspond directly to the error codes as defined by TDEIO.

Implements RSS::DataRetriever.

Definition at line 135 of file loader.cpp.

◆ permanentRedirection

void RSS::FileRetriever::permanentRedirection ( const KURL &  url)
signal

Signals a permanent redirection.

The redirection itself is handled internally, so you don't need to call Loader::loadFrom() with the new URL. This signal is useful in case you want to notify the user, or adjust a database entry.

See also
Loader::loadFrom()

◆ retrieveData()

void FileRetriever::retrieveData ( const KURL &  url)
virtual

Downloads the file referenced by the given URL and passes it's contents on to the Loader.

Parameters
urlAn URL referencing a file which is assumed to reference valid XML.
See also
Loader::loadFrom()

Implements RSS::DataRetriever.

Definition at line 93 of file loader.cpp.

◆ setUseCache()

void FileRetriever::setUseCache ( bool  enabled)
static

Definition at line 88 of file loader.cpp.

◆ setUserAgent()

void FileRetriever::setUserAgent ( const TQString &  ua)
static

Definition at line 81 of file loader.cpp.

◆ slotTimeout

void FileRetriever::slotTimeout ( )
protectedslot

Definition at line 123 of file loader.cpp.

◆ userAgent()

TQString FileRetriever::userAgent ( )
static

Definition at line 74 of file loader.cpp.

The documentation for this class was generated from the following files: