QGIS API Documentation 3.41.0-Master (cea29feecf2)
|
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 type=MapLayer) | |
Constructor for QgisPlugin. | |
virtual | ~QgisPlugin ()=default |
QString & | category () |
Plugin category. | |
QString const & | category () const |
Plugin category. | |
QString & | description () |
A brief description of the plugin. | |
QString const & | description () const |
A brief description of the plugin. | |
virtual void | initGui ()=0 |
function to initialize connection to GUI | |
QString & | name () |
QString const & | name () const |
Gets the name of the plugin. | |
QgisPlugin::PluginType & | type () |
Plugin type, either UI or map layer. | |
QgisPlugin::PluginType const & | type () const |
Plugin type, either UI or map layer. | |
virtual void | unload ()=0 |
Unload the plugin and cleanup the GUI. | |
QString & | version () |
Version of the plugin. | |
QString const & | version () const |
Version of the plugin. | |
Abstract base class from which all plugins must inherit.
Definition at line 54 of file qgisplugin.h.
Interface to gui element collection object.
Element types that can be added to the interface
Enumerator | |
---|---|
UI | User interface plug-in. |
MapLayer | Map layer plug-in. |
Renderer | A plugin for a new renderer class. |
Definition at line 72 of file qgisplugin.h.
|
inline |
Constructor for QgisPlugin.
Definition at line 83 of file qgisplugin.h.
|
virtualdefault |
|
inline |
Plugin category.
Definition at line 135 of file qgisplugin.h.
|
inline |
Plugin category.
Definition at line 129 of file qgisplugin.h.
|
inline |
A brief description of the plugin.
Definition at line 123 of file qgisplugin.h.
|
inline |
A brief description of the plugin.
Definition at line 117 of file qgisplugin.h.
|
pure virtual |
function to initialize connection to GUI
|
inline |
Definition at line 99 of file qgisplugin.h.
|
inline |
Gets the name of the plugin.
Definition at line 94 of file qgisplugin.h.
|
inline |
Plugin type, either UI or map layer.
Definition at line 148 of file qgisplugin.h.
|
inline |
Plugin type, either UI or map layer.
Definition at line 141 of file qgisplugin.h.
|
pure virtual |
Unload the plugin and cleanup the GUI.
|
inline |
Version of the plugin.
Definition at line 111 of file qgisplugin.h.
|
inline |
Version of the plugin.
Definition at line 105 of file qgisplugin.h.