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

Private Attributes
QString	mName
	plug-in name
QString	mDescription
	description
QString	mCategory
	category
QString	mVersion
	version
PLUGINTYPE	mType
	UI or MAPLAYER plug-in.

Detailed Description

Abstract base class from which all plugins must inherit.

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

virtual QgisPlugin::~QgisPlugin ( )

inlinevirtual

Definition at line 84 of file qgisplugin.h.

Member Function Documentation

QString const& QgisPlugin::category ( ) const

inline

Plugin category.

Definition at line 123 of file qgisplugin.h.

References mCategory.

QString& QgisPlugin::category ( )

inline

Plugin category.

Definition at line 129 of file qgisplugin.h.

References mCategory.

QString const& QgisPlugin::description ( ) const

inline

A brief description of the plugin.

Definition at line 111 of file qgisplugin.h.

References mDescription.

QString& QgisPlugin::description ( )

inline

A brief description of the plugin.

Definition at line 117 of file qgisplugin.h.

References mDescription.

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

References mName.

QString& QgisPlugin::name ( )

inline

Definition at line 93 of file qgisplugin.h.

References mName.

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

inline

Plugin type, either UI or map layer.

Definition at line 135 of file qgisplugin.h.

References mType.

QgisPlugin::PLUGINTYPE& QgisPlugin::type ( )

inline

Plugin type, either UI or map layer.

Definition at line 142 of file qgisplugin.h.

References mType.

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

References mVersion.

QString& QgisPlugin::version ( )

inline

Version of the plugin.

Definition at line 105 of file qgisplugin.h.

References mVersion.

Member Data Documentation

QString QgisPlugin::mCategory

private

category

Definition at line 162 of file qgisplugin.h.

Referenced by category().

QString QgisPlugin::mDescription

private

description

Definition at line 159 of file qgisplugin.h.

Referenced by description().

QString QgisPlugin::mName

private

plug-in name

Definition at line 156 of file qgisplugin.h.

Referenced by name().

PLUGINTYPE QgisPlugin::mType

private

UI or MAPLAYER plug-in.

Todo:

Really, might be indicative that this needs to split into maplayer vs. ui plug-in vs. other kind of plug-in

Definition at line 172 of file qgisplugin.h.

Referenced by type().

QString QgisPlugin::mVersion

private

version

Definition at line 165 of file qgisplugin.h.

Referenced by version().

---

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

• /tmp/buildd/qgis-2.2.0+wheezy1/src/plugins/qgisplugin.h