QgisPlugin Class Reference

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. More...
virtual	~QgisPlugin ()=default
QString &	category ()
	Plugin category. More...
QString const &	category () const
	Plugin category. More...
QString &	description ()
	A brief description of the plugin. More...
QString const &	description () const
	A brief description of the plugin. More...
virtual void	initGui ()=0
	function to initialize connection to GUI More...
QString &	name ()
QString const &	name () const
	Gets the name of the plugin. More...
QgisPlugin::PluginType &	type ()
	Plugin type, either UI or map layer. More...
QgisPlugin::PluginType const &	type () const
	Plugin type, either UI or map layer. More...
virtual void	unload ()=0
	Unload the plugin and cleanup the GUI. More...
QString &	version ()
	Version of the plugin. More...
QString const &	version () const
	Version of the plugin. More...

Detailed Description

Abstract base class from which all plugins must inherit.

Note

not available in Python bindings

Definition at line 54 of file qgisplugin.h.

Member Enumeration Documentation

PluginType

enum QgisPlugin::PluginType

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 73 of file qgisplugin.h.

Constructor & Destructor Documentation

QgisPlugin()

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

inline

Constructor for QgisPlugin.

Definition at line 84 of file qgisplugin.h.

~QgisPlugin()

virtual QgisPlugin::~QgisPlugin ( )

virtualdefault

Member Function Documentation

category() [1/2]

QString& QgisPlugin::category ( )

inline

Plugin category.

Definition at line 140 of file qgisplugin.h.

category() [2/2]

QString const& QgisPlugin::category ( ) const

inline

Plugin category.

Definition at line 134 of file qgisplugin.h.

description() [1/2]

QString& QgisPlugin::description ( )

inline

A brief description of the plugin.

Definition at line 128 of file qgisplugin.h.

description() [2/2]

QString const& QgisPlugin::description ( ) const

inline

A brief description of the plugin.

Definition at line 122 of file qgisplugin.h.

initGui()

virtual void QgisPlugin::initGui ( )

pure virtual

function to initialize connection to GUI

name() [1/2]

QString& QgisPlugin::name ( )

inline

Definition at line 104 of file qgisplugin.h.

name() [2/2]

QString const& QgisPlugin::name ( ) const

inline

Gets the name of the plugin.

Definition at line 99 of file qgisplugin.h.

type() [1/2]

QgisPlugin::PluginType& QgisPlugin::type ( )

inline

Plugin type, either UI or map layer.

Definition at line 153 of file qgisplugin.h.

type() [2/2]

QgisPlugin::PluginType const& QgisPlugin::type ( ) const

inline

Plugin type, either UI or map layer.

Definition at line 146 of file qgisplugin.h.

unload()

virtual void QgisPlugin::unload ( )

pure virtual

Unload the plugin and cleanup the GUI.

version() [1/2]

QString& QgisPlugin::version ( )

inline

Version of the plugin.

Definition at line 116 of file qgisplugin.h.

version() [2/2]

QString const& QgisPlugin::version ( ) const

inline

Version of the plugin.

Definition at line 110 of file qgisplugin.h.

---

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

• /build/qgis-3.16.0+99unstable/src/plugins/qgisplugin.h