QgisPlugin class

Abstract base class from which all plugins must inherit.

Public types

enum PluginType { UI = 1, MapLayer, Renderer }: Interface to gui element collection object.

QgisPlugin(QString const& name = "", QString const& description = "", QString const& category = "", QString const& version = "", PluginType type = MapLayer): Constructor for QgisPlugin.

auto category() const -> QString const &: Plugin category.
auto category() -> QString&: Plugin category.
auto description() const -> QString const &: A brief description of the plugin.
auto description() -> QString&: A brief description of the plugin.
void initGui() pure virtual: function to initialize connection to GUI
auto name() const -> QString const &: Gets the name of the plugin.
auto type() const -> QgisPlugin::PluginType const &: Plugin type, either UI or map layer.
auto type() -> QgisPlugin::PluginType&: Plugin type, either UI or map layer.
void unload() pure virtual: Unload the plugin and cleanup the GUI.
auto version() const -> QString const &: Version of the plugin.
auto version() -> QString&: Version of the plugin.

Interface to gui element collection object.

Element types that can be added to the interface

Enumerators
UI	User interface plug-in.
MapLayer	Map layer plug-in.
Renderer	A plugin for a new renderer class.