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 const &type=MAPLAYER)
virtual	~QgisPlugin ()
QString const &	category () const
	Plugin category. More...
QString &	category ()
	Plugin category. More...
QString const &	description () const
	A brief description of the plugin. More...
QString &	description ()
	A brief description of the plugin. More...
virtual void	initGui ()=0
	function to initialize connection to GUI More...
QString const &	name () const
	Get the name of the plugin. More...
QString &	name ()
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	unload ()=0
	Unload the plugin and cleanup the GUI. More...
QString const &	version () const
	Version of the plugin. More...
QString &	version ()
	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 48 of file qgisplugin.h.

Member Enumeration Documentation

enum QgisPlugin::PLUGINTYPE

Interface to gui element collection object.

Element types that can be added to the interface

Enumerator
UI
MAPLAYER
RENDERER

Definition at line 67 of file qgisplugin.h.

Constructor & Destructor Documentation

QgisPlugin::QgisPlugin ( QString const &  name = "", QString const &  description = "", QString const &  category = "", QString const &  version = "", PLUGINTYPE const &  type = MAPLAYER  )

inline

Definition at line 75 of file qgisplugin.h.

virtual QgisPlugin::~QgisPlugin ( )

inlinevirtual

Definition at line 87 of file qgisplugin.h.

Member Function Documentation

QString const& QgisPlugin::category ( ) const

inline

Plugin category.

Definition at line 126 of file qgisplugin.h.

QString& QgisPlugin::category ( )

inline

Plugin category.

Definition at line 132 of file qgisplugin.h.

QString const& QgisPlugin::description ( ) const

inline

A brief description of the plugin.

Definition at line 114 of file qgisplugin.h.

QString& QgisPlugin::description ( )

inline

A brief description of the plugin.

Definition at line 120 of file qgisplugin.h.

virtual void QgisPlugin::initGui ( )

pure virtual

function to initialize connection to GUI

QString const& QgisPlugin::name ( ) const

inline

Get the name of the plugin.

Definition at line 91 of file qgisplugin.h.

QString& QgisPlugin::name ( )

inline

Definition at line 96 of file qgisplugin.h.

QgisPlugin::PLUGINTYPE const& QgisPlugin::type ( ) const

inline

Plugin type, either UI or map layer.

Definition at line 138 of file qgisplugin.h.

QgisPlugin::PLUGINTYPE& QgisPlugin::type ( )

inline

Plugin type, either UI or map layer.

Definition at line 145 of file qgisplugin.h.

virtual void QgisPlugin::unload ( )

pure virtual

Unload the plugin and cleanup the GUI.

QString const& QgisPlugin::version ( ) const

inline

Version of the plugin.

Definition at line 102 of file qgisplugin.h.

QString& QgisPlugin::version ( )

inline

Version of the plugin.

Definition at line 108 of file qgisplugin.h.

---

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

• /tmp/buildd/qgis-2.14.0+99unstable/src/plugins/qgisplugin.h