akregator/src

Akregator::PluginManager Class Reference

List of all members.

Detailed Description

Definition at line 29 of file pluginmanager.h.


Static Public Member Functions

static KTrader::OfferList query (const QString &constraint=QString::null)
static Akregator::PlugincreateFromQuery (const QString &constraint=QString::null)
static Akregator::PlugincreateFromService (const KService::Ptr service)
static void unload (Akregator::Plugin *plugin)
static KService::Ptr getService (const Akregator::Plugin *plugin)
static void dump (const KService::Ptr service)
static void showAbout (const QString &constraint)

Static Public Attributes

static const int FrameworkVersion = 1

Member Function Documentation

KTrader::OfferList Akregator::PluginManager::query ( const QString &  constraint = QString::null  )  [static]

It will return a list of services that match your specifications.

The only required parameter is the service type. This is something like 'text/plain' or 'text/html'. The constraint parameter is used to limit the possible choices returned based on the constraints you give it.

The constraint language is rather full. The most common keywords are AND, OR, NOT, IN, and EXIST, all used in an almost spoken-word form. An example is:

 (Type == 'Service') and (('KParts/ReadOnlyPart' in ServiceTypes) or (exist Exec))

The keys used in the query (Type, ServiceType, Exec) are all fields found in the .desktop files.

Parameters:
constraint A constraint to limit the choices returned, QString::null to get all services of the given servicetype
Returns:
A list of services that satisfy the query
See also:
http://developer.kde.org/documentation/library/kdeqt/tradersyntax.html

Definition at line 43 of file pluginmanager.cpp.

Plugin * Akregator::PluginManager::createFromQuery ( const QString &  constraint = QString::null  )  [static]

Load and instantiate plugin from query.

Parameters:
constraint A constraint to limit the choices returned, QString::null to get all services of the given servicetype
Returns:
Pointer to Plugin, or NULL if error
See also:
http://developer.kde.org/documentation/library/kdeqt/tradersyntax.html

Definition at line 61 of file pluginmanager.cpp.

Plugin * Akregator::PluginManager::createFromService ( const KService::Ptr  service  )  [static]

Load and instantiate plugin from service.

Parameters:
service Pointer to KService
Returns:
Pointer to Plugin, or NULL if error

Definition at line 83 of file pluginmanager.cpp.

void Akregator::PluginManager::unload ( Akregator::Plugin plugin  )  [static]

Remove library and delete plugin.

Parameters:
plugin Pointer to plugin

Definition at line 122 of file pluginmanager.cpp.

KService::Ptr Akregator::PluginManager::getService ( const Akregator::Plugin plugin  )  [static]

Look up service for loaded plugin from store.

Parameters:
plugin Pointer to plugin
Returns:
KService, or 0 if not found

Definition at line 139 of file pluginmanager.cpp.

void Akregator::PluginManager::dump ( const KService::Ptr  service  )  [static]

Dump properties from a service to stdout for debugging.

Parameters:
service Pointer to KService

Definition at line 184 of file pluginmanager.cpp.

void Akregator::PluginManager::showAbout ( const QString &  constraint  )  [static]

Show modal info dialog about plugin.

Parameters:
constraint A constraint to limit the choices returned

Definition at line 157 of file pluginmanager.cpp.


Member Data Documentation

Bump this number whenever the plugin framework gets incompatible with older versions.

Definition at line 33 of file pluginmanager.h.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys