OmgScraperPluginRegistry Class Reference
[Library]

#include <omgscraperpluginregistry.h>

Inheritance diagram for OmgScraperPluginRegistry:

[legend]Collaboration diagram for OmgScraperPluginRegistry:

[legend]List of all members.

---

Detailed Description

This class keeps a list of available scraper plugins and can return a pointer to one on demand.

Definition at line 32 of file omgscraperpluginregistry.h.

Public Member Functions
const int	count ()
OmgScraperPluginInterface *	getPlugin (QString thePluginName="")
QStringList	names ()
QMap< QString, QString >	licenses ()
Static Public Member Functions
static OmgScraperPluginRegistry *	instance ()
	Returns the instance pointer, creating the object on the first call.
Protected Member Functions
	OmgScraperPluginRegistry (QObject *parent=0)
	protected constructor
Private Attributes
QMap< QString, OmgScraperPluginInterface * >	mPluginsMap
Static Private Attributes
static OmgScraperPluginRegistry *	mpInstance = 0

---

Constructor & Destructor Documentation

OmgScraperPluginRegistry::OmgScraperPluginRegistry (  QObject *  parent = 0  )  [protected]

protected constructor Definition at line 45 of file omgscraperpluginregistry.cpp. References OmgScraperPluginInterface::getName(), mPluginsMap, and Omgui::pluginDirPath(). Referenced by instance().

Here is the call graph for this function:

---

Member Function Documentation

const int OmgScraperPluginRegistry::count (   )

Return the number of registered scraper plugins. Definition at line 92 of file omgscraperpluginregistry.cpp. References mPluginsMap.

OmgScraperPluginInterface * OmgScraperPluginRegistry::getPlugin (  QString  thePluginName = ""  )

Retrieve a pointer to a loaded plugin by id The client class should never delete the pointer returned by this function. Parameters: theName  of the plugin to return. The parameter is optional. If ommitted the default plugin will be returned. Returns: A OmgScraperPluginInterface instance. Definition at line 97 of file omgscraperpluginregistry.cpp. References mPluginsMap.

OmgScraperPluginRegistry * OmgScraperPluginRegistry::instance (   )  [static]

Returns the instance pointer, creating the object on the first call. Definition at line 32 of file omgscraperpluginregistry.cpp. References mpInstance, and OmgScraperPluginRegistry(). Referenced by OmgAbout::OmgAbout(), OmgDataFetcherWizardLicenseWidget::OmgDataFetcherWizardLicenseWidget(), OmgDataFetcherWizardSearchWidget::OmgDataFetcherWizardSearchWidget(), and OmgDataFetcherWizardProgressPage::search().

Here is the call graph for this function:

QMap< QString, QString > OmgScraperPluginRegistry::licenses (   )

Get the licenses for available scraper plugins Returns: a QMap<QString,QString> where the key is the plugin name and the value is the license text for that plugin. Definition at line 118 of file omgscraperpluginregistry.cpp. References mPluginsMap, and names().

Here is the call graph for this function:

QStringList OmgScraperPluginRegistry::names (   )

Get the available plugins names. Returns: QStringList containing all the registered plugins names. Definition at line 112 of file omgscraperpluginregistry.cpp. References mPluginsMap. Referenced by licenses().

---

Member Data Documentation

OmgScraperPluginRegistry * OmgScraperPluginRegistry::mpInstance = 0 [static, private]

Definition at line 31 of file omgscraperpluginregistry.cpp. Referenced by instance().

QMap<QString,OmgScraperPluginInterface*> OmgScraperPluginRegistry::mPluginsMap [private]

Definition at line 74 of file omgscraperpluginregistry.h. Referenced by count(), getPlugin(), licenses(), names(), and OmgScraperPluginRegistry().

---

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

• lib/omgscraperpluginregistry.h
• lib/omgscraperpluginregistry.cpp

---