QgisPlugin Class Reference

Abstract base class from which all plugins must inherit. More...

#include <qgisplugin.h>

Inheritance diagram for QgisPlugin:

[legend]

List of all members.

Public Types
enum	PLUGINTYPE { UI = 1, MAPLAYER, RENDERER, VECTOR_OVERLAY }
	Interface to gui element collection object. More...
Public Member Functions
	QgisPlugin (QString const &name="", QString const &description="", 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.
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	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
VECTOR_OVERLAY

Definition at line 64 of file qgisplugin.h.

---

Constructor & Destructor Documentation

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

Definition at line 73 of file qgisplugin.h.

virtual QgisPlugin::~QgisPlugin

(

)

[inline, virtual]

Definition at line 83 of file qgisplugin.h.

---

Member Function Documentation

QString const& QgisPlugin::name

(

)

const [inline]

Get the name of the plugin.

Definition at line 87 of file qgisplugin.h.

References mName.

QString& QgisPlugin::name

(

)

[inline]

Definition at line 92 of file qgisplugin.h.

References mName.

QString const& QgisPlugin::version

(

)

const [inline]

Version of the plugin.

Definition at line 98 of file qgisplugin.h.

References mVersion.

QString& QgisPlugin::version

(

)

[inline]

Version of the plugin.

Definition at line 104 of file qgisplugin.h.

References mVersion.

QString const& QgisPlugin::description

(

)

const [inline]

A brief description of the plugin.

Definition at line 110 of file qgisplugin.h.

References mDescription.

QString& QgisPlugin::description

(

)

[inline]

A brief description of the plugin.

Definition at line 116 of file qgisplugin.h.

References mDescription.

QgisPlugin::PLUGINTYPE const& QgisPlugin::type

(

)

const [inline]

Plugin type, either UI or map layer.

Definition at line 122 of file qgisplugin.h.

References mType.

QgisPlugin::PLUGINTYPE& QgisPlugin::type

(

)

[inline]

Plugin type, either UI or map layer.

Definition at line 129 of file qgisplugin.h.

References mType.

virtual void QgisPlugin::initGui

(

)

[pure virtual]

function to initialize connection to GUI

virtual void QgisPlugin::unload

(

)

[pure virtual]

Unload the plugin and cleanup the GUI.

---

Member Data Documentation

QString QgisPlugin::mName [private]

plug-in name

Definition at line 143 of file qgisplugin.h.

Referenced by name().

QString QgisPlugin::mDescription [private]

description

Definition at line 146 of file qgisplugin.h.

Referenced by description().

QString QgisPlugin::mVersion [private]

version

Definition at line 149 of file qgisplugin.h.

Referenced by version().

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

Referenced by type().

---

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

• src/plugins/qgisplugin.h