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

Syndication Library

  • Syndication
  • DataRetriever
Signals | Public Member Functions | List of all members
Syndication::DataRetriever Class Referenceabstract

#include <dataretriever.h>

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

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
 

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

◆ DataRetriever()

Syndication::DataRetriever::DataRetriever ( )

Default constructor.

Definition at line 25 of file dataretriever.cpp.

◆ ~DataRetriever()

Syndication::DataRetriever::~DataRetriever ( )
virtual

Destructor.

Definition at line 29 of file dataretriever.cpp.

Member Function Documentation

◆ abort()

virtual void Syndication::DataRetriever::abort ( )
pure virtual

aborts the retrieval process.

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

◆ dataRetrieved

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
dataShould contain the retrieved data and will get parsed by the Loader class.
successIndicates 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.

◆ errorCode()

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::OutputRetriever, and Syndication::FileRetriever.

◆ retrieveData()

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
urlthe URL to retrieve data from
See also
Loader::loadFrom()

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


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-2022 The KDE developers.
Generated on Thu Jul 21 2022 00:00:00 by doxygen 1.9.5 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.14.10 API Reference

Skip menu "kdepimlibs-4.14.10 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