• Skip to content
  • Skip to link menu
KDE 4.2 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • Sitemap
  • Contact Us
 

Syndication Library

Syndication::FileRetriever

Syndication::FileRetriever Class Reference

#include <dataretriever.h>

Inheritance diagram for Syndication::FileRetriever:

Inheritance graph
[legend]

List of all members.


Detailed Description

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

See also:
DataRetriever, Loader::loadFrom()

Definition at line 150 of file dataretriever.h.


Signals

void permanentRedirection (const KUrl &url)

Public Member Functions

virtual void abort ()
virtual int errorCode () const
 FileRetriever ()
virtual void retrieveData (const KUrl &url)
virtual ~FileRetriever ()

Static Public Member Functions

static void setUseCache (bool enabled)
static void setUserAgent (const QString &userAgent)

Protected Slots

void slotTimeout ()

Constructor & Destructor Documentation

Syndication::FileRetriever::FileRetriever (  ) 

Default constructor.

Definition at line 51 of file dataretriever.cpp.

Syndication::FileRetriever::~FileRetriever (  )  [virtual]

Destructor.

Definition at line 56 of file dataretriever.cpp.


Member Function Documentation

void Syndication::FileRetriever::abort (  )  [virtual]

aborts the retrieval process.

Implements Syndication::DataRetriever.

Definition at line 141 of file dataretriever.cpp.

int Syndication::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 KIO.

Implements Syndication::DataRetriever.

Definition at line 113 of file dataretriever.cpp.

void Syndication::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.

Parameters:
url the new URL after the redirection
See also:
Loader::loadFrom()

void Syndication::FileRetriever::retrieveData ( const KUrl &  url  )  [virtual]

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

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

Implements Syndication::DataRetriever.

Definition at line 74 of file dataretriever.cpp.

void Syndication::FileRetriever::setUseCache ( bool  enabled  )  [static]

sets whether the retriever should use the KHTML cache or always refetch the file.

By default, the cache is used.

Parameters:
enabled whether to use the HTML cache or not

Definition at line 69 of file dataretriever.cpp.

void Syndication::FileRetriever::setUserAgent ( const QString &  userAgent  )  [static]

sets the user agent string sent to the remote server

Parameters:
userAgent user agent string

Definition at line 64 of file dataretriever.cpp.


The documentation for this class was generated from the following files:
  • dataretriever.h
  • dataretriever.cpp

Syndication Library

Skip menu "Syndication Library"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  • kabc
  • kblog
  • kcal
  • kimap
  • kioslave
  •   imap4
  •   mbox
  • kldap
  • kmime
  • kpimidentities
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.5.6
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal