#include <dataretriever.h>

Inheritance diagram for Syndication::DataRetriever:

Signals
void	dataRetrieved (const QByteArray &data, bool success)

Public Member Functions
	DataRetriever ()

virtual	~DataRetriever ()

virtual void	abort ()=0

virtual int	errorCode () const =0

virtual void	retrieveData (const KUrl &url)=0

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

Additional Inherited Members
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 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

Abstract baseclass for all data retriever classes.

Subclass this to add a new retrieval algorithm which can then be plugged into the RSS loader.

See also: Loader, FileRetriever, OutputRetriever

Definition at line 36 of file dataretriever.h.

Constructor & Destructor Documentation

Syndication::DataRetriever::DataRetriever ( )

Default constructor.

Definition at line 25 of file dataretriever.cpp.

Syndication::DataRetriever::~DataRetriever ( )

virtual

Destructor.

Definition at line 29 of file dataretriever.cpp.

Member Function Documentation

virtual void Syndication::DataRetriever::abort ( )

pure virtual

aborts the retrieval process.

Implemented in Syndication::FileRetriever, and Syndication::OutputRetriever.

void Syndication::DataRetriever::dataRetrieved	(	const QByteArray &	data,
		bool	success
	)

signal

Emit this signal to tell the Loader class that the retrieval process was finished.

Parameters

data	Should contain the retrieved data and will get parsed by the Loader class.
success	Indicates whether there were any problems during the retrieval process. Pass 'true' to indicate that everything went seamlessy, 'false' to tell the Loader that something went wrong and that the data parameter might contain no or invalid data.

virtual int Syndication::DataRetriever::errorCode ( ) const

pure virtual

Returns: An error code which might give a more precise information about what went wrong in case the 'success' flag returned with the dataRetrieved() signal was 'false'. Note that the meaning of the returned integer depends on the actual data retriever.

Implemented in Syndication::FileRetriever, and Syndication::OutputRetriever.

virtual void Syndication::DataRetriever::retrieveData ( const KUrl & url )

pure virtual

Retrieve data from the given URL.

This method is supposed to get reimplemented by subclasses. It will be called by the Loader class in case it needs to retrieve the data.

Parameters