QgisPlugin Class Reference

#include <qgisplugin.h>

Collaboration diagram for QgisPlugin:

[legend]List of all members.

---

Detailed Description

Abstract base class from which all plugins must inherit.

Definition at line 34 of file qgisplugin.h.

Public Types
enum	PLUGINTYPE { UI = 1, MAPLAYER, RENDERER }
	Element types that can be added to the interface. 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.

---

Member Enumeration Documentation

enum QgisPlugin::PLUGINTYPE

Element types that can be added to the interface. Enumeration values: UI  MAPLAYER  RENDERER  Definition at line 50 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 58 of file qgisplugin.h. References description(), mDescription, mName, mType, mVersion, name(), type(), and version().

Here is the call graph for this function:

virtual QgisPlugin::~QgisPlugin (   )  [inline, virtual]

Definition at line 68 of file qgisplugin.h.

---

Member Function Documentation

QString& QgisPlugin::description (   )  [inline]

A brief description of the plugin. Definition at line 101 of file qgisplugin.h. References mDescription.

QString const& QgisPlugin::description (   )  const [inline]

A brief description of the plugin. Definition at line 95 of file qgisplugin.h. References mDescription. Referenced by QgisPlugin().

virtual void QgisPlugin::initGui (   )  [pure virtual]

function to initialize connection to GUI Referenced by OmgMainWindow::loadQGisPlugin().

QString& QgisPlugin::name (   )  [inline]

Definition at line 77 of file qgisplugin.h. References mName.

QString const& QgisPlugin::name (   )  const [inline]

Get the name of the plugin. Definition at line 72 of file qgisplugin.h. References mName. Referenced by QgisPlugin().

QgisPlugin::PLUGINTYPE& QgisPlugin::type (   )  [inline]

Plugin type, either UI or map layer. Definition at line 114 of file qgisplugin.h. References mType.

QgisPlugin::PLUGINTYPE const& QgisPlugin::type (   )  const [inline]

Plugin type, either UI or map layer. Definition at line 107 of file qgisplugin.h. References mType. Referenced by QgisPlugin().

virtual void QgisPlugin::unload (   )  [pure virtual]

Unload the plugin and cleanup the GUI.

QString& QgisPlugin::version (   )  [inline]

Version of the plugin. Definition at line 89 of file qgisplugin.h. References mVersion.

QString const& QgisPlugin::version (   )  const [inline]

Version of the plugin. Definition at line 83 of file qgisplugin.h. References mVersion. Referenced by QgisPlugin().

---

Member Data Documentation

QString QgisPlugin::mDescription [private]

description Definition at line 131 of file qgisplugin.h. Referenced by description(), and QgisPlugin().

QString QgisPlugin::mName [private]

plug-in name Definition at line 128 of file qgisplugin.h. Referenced by name(), and QgisPlugin().

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 141 of file qgisplugin.h. Referenced by QgisPlugin(), and type().

QString QgisPlugin::mVersion [private]

version Definition at line 134 of file qgisplugin.h. Referenced by QgisPlugin(), and version().

---

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

• gui/qgisplugin.h

---