Syndication::FileRetriever Class Reference

#include <dataretriever.h>

Inheritance diagram for Syndication::FileRetriever:

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 ()
Public Member Functions inherited from QObject
	QObject (QObject *parent)
	QObject (QObject *parent, const char *name)
bool	blockSignals (bool block)
QObject *	child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
const QObjectList &	children () const
const char *	className () const
bool	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const QObject *receiver, const char *method)
bool	disconnect (const char *signal, const QObject *receiver, const char *method)
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name) const
QList< T >	findChildren (const QRegExp &regExp) const
QList< T >	findChildren (const QString &name) const
bool	inherits (const char *className) const
void	insertChild (QObject *object)
void	installEventFilter (QObject *filterObj)
bool	isA (const char *className) const
bool	isWidgetType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
const char *	name () const
const char *	name (const char *defaultName) const
QString	objectName () const
QObject *	parent () const
QVariant	property (const char *name) const
void	removeChild (QObject *object)
void	removeEventFilter (QObject *obj)
void	setName (const char *name)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval)
QThread *	thread () const

Static Public Member Functions
static void	setUseCache (bool enabled)
static void	setUserAgent (const QString &userAgent)
Static Public Member Functions inherited from QObject
bool	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
bool	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)

Protected Slots
void	slotTimeout ()

Additional Inherited Members
Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char *signal, const QObject *object, const char *method)
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const char *signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const char *signal)
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *event)
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)
Properties inherited from QObject
	objectName

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

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