• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.10.5 API Reference
  • KDE Home
  • Contact Us
 

Syndication Library

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

#include <dataretriever.h>

Inheritance diagram for Syndication::FileRetriever:
Syndication::DataRetriever

Signals

void permanentRedirection (const KUrl &url)
 
- Signals inherited from Syndication::DataRetriever
void dataRetrieved (const QByteArray &data, bool success)
 

Public Member Functions

 FileRetriever ()
 
virtual ~FileRetriever ()
 
virtual void abort ()
 
virtual int errorCode () const
 
virtual void retrieveData (const KUrl &url)
 
- Public Member Functions inherited from Syndication::DataRetriever
 DataRetriever ()
 
virtual ~DataRetriever ()
 

Static Public Member Functions

static void setUseCache (bool enabled)
 
static void setUserAgent (const QString &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 150 of file dataretriever.h.

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
urlthe 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
urlAn 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
enabledwhether 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
userAgentuser 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
This file is part of the KDE documentation.
Documentation copyright © 1996-2013 The KDE developers.
Generated on Sat Jul 13 2013 01:26:16 by doxygen 1.8.3.1 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

Syndication Library

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

kdepimlibs-4.10.5 API Reference

Skip menu "kdepimlibs-4.10.5 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal