QgsPluginRegistry Class Reference

#include <qgspluginregistry.h>

Collaboration diagram for QgsPluginRegistry:

[legend]List of all members.

---

Detailed Description

This class tracks plugins that are currently loaded an provides a means to fetch a pointer to a plugin and unload it.

Definition at line 32 of file qgspluginregistry.h.

Public Member Functions
QString	library (QString pluginKey)
	Return the full path to the plugins library using the plugin name as a key.
QgsPluginMetadata *	pluginMetadata (QString name)
	Retrieve the metadata for a plugin by name.
QgisPlugin *	plugin (QString name)
	Retrieve a pointer to a loaded plugin by name.
bool	isPythonPlugin (QString name)
	Return whether the plugin is pythonic.
void	addPlugin (QString _library, QString _name, QgisPlugin *_plugin)
	Add a plugin to the map of loaded plugins.
void	addPythonPlugin (QString packageName, QString pluginName)
	Add a plugin written in python.
void	removePlugin (QString name)
	Remove a plugin from the list of loaded plugins.
Static Public Member Functions
static QgsPluginRegistry *	instance ()
	Returns the instance pointer, creating the object on the first call.
Protected Member Functions
	QgsPluginRegistry ()
	protected constructor
Private Attributes
std::map< QString, QgsPluginMetadata * >	plugins
Static Private Attributes
static QgsPluginRegistry *	_instance = 0

---

Constructor & Destructor Documentation

QgsPluginRegistry::QgsPluginRegistry (   )  [protected]

protected constructor Definition at line 39 of file qgspluginregistry.cpp. Referenced by instance().

---

Member Function Documentation

void QgsPluginRegistry::addPlugin (  QString  _library, QString  _name, QgisPlugin *  _plugin )

Add a plugin to the map of loaded plugins. Definition at line 79 of file qgspluginregistry.cpp. References plugin(), and plugins. Referenced by OmgMainWindow::loadQGisPlugin().

Here is the call graph for this function:

void QgsPluginRegistry::addPythonPlugin (  QString  packageName, QString  pluginName )

Add a plugin written in python. Definition at line 85 of file qgspluginregistry.cpp. References plugins.

QgsPluginRegistry * QgsPluginRegistry::instance (   )  [static]

Returns the instance pointer, creating the object on the first call. Definition at line 30 of file qgspluginregistry.cpp. References _instance, and QgsPluginRegistry(). Referenced by OmgMainWindow::loadQGisPlugin().

Here is the call graph for this function:

bool QgsPluginRegistry::isPythonPlugin (  QString  name  )

Return whether the plugin is pythonic. Definition at line 70 of file qgspluginregistry.cpp. References QgsPluginMetadata::isPython(), and plugins.

Here is the call graph for this function:

QString QgsPluginRegistry::library (  QString  pluginKey  )

Return the full path to the plugins library using the plugin name as a key. Definition at line 43 of file qgspluginregistry.cpp. References QgsPluginMetadata::library(), and plugins. Referenced by OmgMainWindow::loadQGisPlugin().

Here is the call graph for this function:

QgisPlugin * QgsPluginRegistry::plugin (  QString  name  )

Retrieve a pointer to a loaded plugin by name. Definition at line 59 of file qgspluginregistry.cpp. References QgsPluginMetadata::plugin(), and plugins. Referenced by addPlugin().

Here is the call graph for this function:

QgsPluginMetadata * QgsPluginRegistry::pluginMetadata (  QString  name  )

Retrieve the metadata for a plugin by name. Definition at line 54 of file qgspluginregistry.cpp. References plugins.

void QgsPluginRegistry::removePlugin (  QString  name  )

Remove a plugin from the list of loaded plugins. Definition at line 90 of file qgspluginregistry.cpp. References plugins.

---

Member Data Documentation

QgsPluginRegistry * QgsPluginRegistry::_instance = 0 [static, private]

Definition at line 29 of file qgspluginregistry.cpp. Referenced by instance().

std::map<QString,QgsPluginMetadata*> QgsPluginRegistry::plugins [private]

Definition at line 56 of file qgspluginregistry.h. Referenced by addPlugin(), addPythonPlugin(), isPythonPlugin(), library(), plugin(), pluginMetadata(), and removePlugin().

---

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

• gui/qgspluginregistry.h
• gui/qgspluginregistry.cpp

---