Quantum GIS API Documentation
1.7.4
|
Abstract base class from which all plugins must inherit. More...
#include <qgisplugin.h>
Public Types | |
enum | PLUGINTYPE { UI = 1, MAPLAYER, RENDERER, VECTOR_OVERLAY } |
Interface to gui element collection object. More... | |
Public Member Functions | |
QgisPlugin (QString const &name="", QString const &description="", QString const &version="", PLUGINTYPE const &type=MAPLAYER) | |
virtual | ~QgisPlugin () |
QString const & | name () const |
Get the name of the plugin. | |
QString & | name () |
QString const & | version () const |
Version of the plugin. | |
QString & | version () |
Version of the plugin. | |
QString const & | description () const |
A brief description of the plugin. | |
QString & | description () |
A brief description of the plugin. | |
QgisPlugin::PLUGINTYPE const & | type () const |
Plugin type, either UI or map layer. | |
QgisPlugin::PLUGINTYPE & | type () |
Plugin type, either UI or map layer. | |
virtual void | initGui ()=0 |
function to initialize connection to GUI | |
virtual void | unload ()=0 |
Unload the plugin and cleanup the GUI. | |
Private Attributes | |
QString | mName |
plug-in name | |
QString | mDescription |
description | |
QString | mVersion |
version | |
PLUGINTYPE | mType |
UI or MAPLAYER plug-in. |
Abstract base class from which all plugins must inherit.
Definition at line 48 of file qgisplugin.h.
Interface to gui element collection object.
Element types that can be added to the interface
Definition at line 64 of file qgisplugin.h.
QgisPlugin::QgisPlugin | ( | QString const & | name = "" , |
QString const & | description = "" , |
||
QString const & | version = "" , |
||
PLUGINTYPE const & | type = MAPLAYER |
||
) | [inline] |
Definition at line 73 of file qgisplugin.h.
virtual QgisPlugin::~QgisPlugin | ( | ) | [inline, virtual] |
Definition at line 83 of file qgisplugin.h.
QString const& QgisPlugin::description | ( | ) | const [inline] |
A brief description of the plugin.
Definition at line 110 of file qgisplugin.h.
References mDescription.
QString& QgisPlugin::description | ( | ) | [inline] |
A brief description of the plugin.
Definition at line 116 of file qgisplugin.h.
References mDescription.
virtual void QgisPlugin::initGui | ( | ) | [pure virtual] |
function to initialize connection to GUI
QString const& QgisPlugin::name | ( | ) | const [inline] |
QString& QgisPlugin::name | ( | ) | [inline] |
Definition at line 92 of file qgisplugin.h.
References mName.
QgisPlugin::PLUGINTYPE const& QgisPlugin::type | ( | ) | const [inline] |
QgisPlugin::PLUGINTYPE& QgisPlugin::type | ( | ) | [inline] |
virtual void QgisPlugin::unload | ( | ) | [pure virtual] |
Unload the plugin and cleanup the GUI.
QString const& QgisPlugin::version | ( | ) | const [inline] |
QString& QgisPlugin::version | ( | ) | [inline] |
QString QgisPlugin::mDescription [private] |
QString QgisPlugin::mName [private] |
PLUGINTYPE QgisPlugin::mType [private] |
UI or MAPLAYER plug-in.
ui plug-in vs. other kind of plug-in
Definition at line 156 of file qgisplugin.h.
Referenced by type().
QString QgisPlugin::mVersion [private] |