QGIS API Documentation
2.4.0-Chugiak
|
Abstract base class from which all plugins must inherit. More...
#include <qgisplugin.h>
Public Types | |
enum | PLUGINTYPE { UI = 1, MAPLAYER, RENDERER } |
Interface to gui element collection object. More... | |
Public Member Functions | |
QgisPlugin (QString const &name="", QString const &description="", QString const &category="", QString const &version="", PLUGINTYPE const &type=MAPLAYER) | |
virtual | ~QgisPlugin () |
QString const & | name () const |
Get the name of the plugin. More... | |
QString & | name () |
QString const & | version () const |
Version of the plugin. More... | |
QString & | version () |
Version of the plugin. More... | |
QString const & | description () const |
A brief description of the plugin. More... | |
QString & | description () |
A brief description of the plugin. More... | |
QString const & | category () const |
Plugin category. More... | |
QString & | category () |
Plugin category. More... | |
QgisPlugin::PLUGINTYPE const & | type () const |
Plugin type, either UI or map layer. More... | |
QgisPlugin::PLUGINTYPE & | type () |
Plugin type, either UI or map layer. More... | |
virtual void | initGui ()=0 |
function to initialize connection to GUI More... | |
virtual void | unload ()=0 |
Unload the plugin and cleanup the GUI. More... | |
Private Attributes | |
QString | mName |
plug-in name More... | |
QString | mDescription |
description More... | |
QString | mCategory |
category More... | |
QString | mVersion |
version More... | |
PLUGINTYPE | mType |
UI or MAPLAYER plug-in. More... | |
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
Enumerator | |
---|---|
UI | |
MAPLAYER | |
RENDERER |
Definition at line 64 of file qgisplugin.h.
|
inline |
Definition at line 72 of file qgisplugin.h.
|
inlinevirtual |
Definition at line 84 of file qgisplugin.h.
|
inline |
|
inline |
|
inline |
A brief description of the plugin.
Definition at line 111 of file qgisplugin.h.
References mDescription.
|
inline |
A brief description of the plugin.
Definition at line 117 of file qgisplugin.h.
References mDescription.
|
pure virtual |
function to initialize connection to GUI
|
inline |
|
inline |
Definition at line 93 of file qgisplugin.h.
References mName.
|
inline |
|
inline |
|
pure virtual |
Unload the plugin and cleanup the GUI.
|
inline |
|
inline |
|
private |
|
private |
|
private |
|
private |
UI or MAPLAYER plug-in.
Definition at line 172 of file qgisplugin.h.
Referenced by type().
|
private |