Quantum GIS API Documentation  1.8
Public Types | Public Member Functions | Private Attributes
QgisPlugin Class Reference

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

#include <qgisplugin.h>

Inheritance diagram for QgisPlugin:
Inheritance graph
[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 &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::PLUGINTYPEtype ()
 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

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 &  category = "",
QString const &  version = "",
PLUGINTYPE const &  type = MAPLAYER 
) [inline]

Definition at line 73 of file qgisplugin.h.

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

Definition at line 85 of file qgisplugin.h.


Member Function Documentation

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

Plugin category.

Definition at line 124 of file qgisplugin.h.

References mCategory.

QString& QgisPlugin::category ( ) [inline]

Plugin category.

Definition at line 130 of file qgisplugin.h.

References mCategory.

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

A brief description of the plugin.

Definition at line 112 of file qgisplugin.h.

References mDescription.

QString& QgisPlugin::description ( ) [inline]

A brief description of the plugin.

Definition at line 118 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 89 of file qgisplugin.h.

References mName.

QString& QgisPlugin::name ( ) [inline]

Definition at line 94 of file qgisplugin.h.

References mName.

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

Plugin type, either UI or map layer.

Definition at line 136 of file qgisplugin.h.

References mType.

Plugin type, either UI or map layer.

Definition at line 143 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 100 of file qgisplugin.h.

References mVersion.

QString& QgisPlugin::version ( ) [inline]

Version of the plugin.

Definition at line 106 of file qgisplugin.h.

References mVersion.


Member Data Documentation

QString QgisPlugin::mCategory [private]

category

Definition at line 163 of file qgisplugin.h.

Referenced by category().

QString QgisPlugin::mDescription [private]

description

Definition at line 160 of file qgisplugin.h.

Referenced by description().

QString QgisPlugin::mName [private]

plug-in name

Definition at line 157 of file qgisplugin.h.

Referenced by name().

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

Referenced by type().

QString QgisPlugin::mVersion [private]

version

Definition at line 166 of file qgisplugin.h.

Referenced by version().


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines