KNS3::Provider Class Reference

#include <provider.h>

Inheritance diagram for KNS3::Provider:

Classes
struct	SearchRequest

Public Types
typedef QList< Provider * >	List
enum	SortMode {   Newest, Alphabetical, Rating, Downloads,   Installed, Updates }

Signals
void	entryDetailsLoaded (const KNS3::EntryInternal &)
void	loadingFailed (const KNS3::Provider::SearchRequest &)
void	loadingFinished (const KNS3::Provider::SearchRequest &, const KNS3::EntryInternal::List &) const
void	payloadLinkLoaded (const KNS3::EntryInternal &)
void	providerInitialized (KNS3::Provider *)
void	signalError (const QString &) const
void	signalInformation (const QString &) const

Public Member Functions
	Provider ()
virtual	~Provider ()
virtual void	becomeFan (const EntryInternal &entry)
virtual KUrl	icon () const
virtual QString	id () const =0
virtual bool	isInitialized () const =0
virtual void	loadEntries (const KNS3::Provider::SearchRequest &request)=0
virtual void	loadEntryDetails (const KNS3::EntryInternal &)
virtual void	loadPayloadLink (const EntryInternal &entry, int linkId)=0
virtual QString	name () const
virtual void	setCachedEntries (const KNS3::EntryInternal::List &cachedEntries)=0
virtual bool	setProviderXML (const QDomElement &xmldata)=0
virtual bool	userCanBecomeFan ()
virtual bool	userCanVote ()
virtual void	vote (const EntryInternal &entry, uint rating)

Protected Attributes
KUrl	mIcon
QString	mName

Detailed Description

KNewStuff Base Provider class.

This class provides accessors for the provider object. It should not be used directly by the application. This class is the base class and will be instantiated for static website providers.

Author

Jeremy Whiting jpwhi.nosp@m.ting.nosp@m.@kde..nosp@m.org

Definition at line 46 of file knewstuff3/core/provider.h.

Member Typedef Documentation

typedef QList<Provider*> KNS3::Provider::List

Definition at line 50 of file knewstuff3/core/provider.h.

Member Enumeration Documentation

enum KNS3::Provider::SortMode

Enumerator
Newest
Alphabetical
Rating
Downloads
Installed
Updates

Definition at line 52 of file knewstuff3/core/provider.h.

Constructor & Destructor Documentation

KNS3::Provider::Provider

(

)

Constructor.

Definition at line 42 of file knewstuff3/core/provider.cpp.

KNS3::Provider::~Provider ( )

virtual

Destructor.

Definition at line 45 of file knewstuff3/core/provider.cpp.

Member Function Documentation

virtual void KNS3::Provider::becomeFan ( const EntryInternal &  entry )

inlinevirtual

Reimplemented in KNS3::AtticaProvider.

Definition at line 133 of file knewstuff3/core/provider.h.

void KNS3::Provider::entryDetailsLoaded ( const KNS3::EntryInternal &  )

signal

KUrl KNS3::Provider::icon ( ) const

virtual

Retrieves the icon URL for this provider.

Returns

icon URL

Definition at line 53 of file knewstuff3/core/provider.cpp.

virtual QString KNS3::Provider::id ( ) const

pure virtual

A unique Id for this provider (the url in most cases)

Implemented in KNS3::AtticaProvider, and KNS3::StaticXmlProvider.

virtual bool KNS3::Provider::isInitialized ( ) const

pure virtual

Implemented in KNS3::AtticaProvider, and KNS3::StaticXmlProvider.

virtual void KNS3::Provider::loadEntries ( const KNS3::Provider::SearchRequest &  request )

pure virtual

load the given search and return given page

Parameters

sortMode	string to select the order in which the results are presented
searchstring	string to search with
page	page number to load

Note: the engine connects to loadingFinished() signal to get the result

Implemented in KNS3::AtticaProvider, and KNS3::StaticXmlProvider.

virtual void KNS3::Provider::loadEntryDetails ( const KNS3::EntryInternal &  )

inlinevirtual

Reimplemented in KNS3::AtticaProvider.

Definition at line 126 of file knewstuff3/core/provider.h.

void KNS3::Provider::loadingFailed ( const KNS3::Provider::SearchRequest &  )

signal

void KNS3::Provider::loadingFinished ( const KNS3::Provider::SearchRequest &  , const KNS3::EntryInternal::List &    ) const

signal

virtual void KNS3::Provider::loadPayloadLink ( const EntryInternal &  entry, int  linkId  )

pure virtual

Implemented in KNS3::AtticaProvider, and KNS3::StaticXmlProvider.

QString KNS3::Provider::name ( ) const

virtual

Retrieves the common name of the provider.

Returns

provider name

Definition at line 48 of file knewstuff3/core/provider.cpp.

void KNS3::Provider::payloadLinkLoaded ( const KNS3::EntryInternal &  )

signal

void KNS3::Provider::providerInitialized ( KNS3::Provider *  )

signal

virtual void KNS3::Provider::setCachedEntries ( const KNS3::EntryInternal::List &  cachedEntries )

pure virtual

Implemented in KNS3::AtticaProvider, and KNS3::StaticXmlProvider.

virtual bool KNS3::Provider::setProviderXML ( const QDomElement &  xmldata )

pure virtual

Set the provider data xml, to initialize the provider.

The Provider needs to have it's ID set in this function and cannot change it from there on.

Implemented in KNS3::AtticaProvider, and KNS3::StaticXmlProvider.

void KNS3::Provider::signalError ( const QString &  ) const

signal

void KNS3::Provider::signalInformation ( const QString &  ) const

signal

virtual bool KNS3::Provider::userCanBecomeFan ( )

inlinevirtual

Reimplemented in KNS3::AtticaProvider.

Definition at line 132 of file knewstuff3/core/provider.h.

virtual bool KNS3::Provider::userCanVote ( )

inlinevirtual

Reimplemented in KNS3::AtticaProvider.

Definition at line 129 of file knewstuff3/core/provider.h.

virtual void KNS3::Provider::vote ( const EntryInternal &  entry, uint  rating  )

inlinevirtual

Reimplemented in KNS3::AtticaProvider.

Definition at line 130 of file knewstuff3/core/provider.h.

Member Data Documentation

KUrl KNS3::Provider::mIcon

protected

Definition at line 149 of file knewstuff3/core/provider.h.

QString KNS3::Provider::mName

protected

Definition at line 148 of file knewstuff3/core/provider.h.

---

The documentation for this class was generated from the following files:

• knewstuff3/core/provider.h
• knewstuff3/core/provider.cpp