QGIS API Documentation  2.5.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Types | Public Member Functions | List of all members
QgisPlugin Class Referenceabstract

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

Detailed Description

Abstract base class from which all plugins must inherit.

Member Enumeration Documentation

Interface to gui element collection object.

Element types that can be added to the interface

Enumerator
UI 
MAPLAYER 
RENDERER 

Constructor & Destructor Documentation

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

Member Function Documentation

QString const& QgisPlugin::category ( ) const
inline

Plugin category.

QString& QgisPlugin::category ( )
inline

Plugin category.

QString const& QgisPlugin::description ( ) const
inline

A brief description of the plugin.

QString& QgisPlugin::description ( )
inline

A brief description of the plugin.

virtual void QgisPlugin::initGui ( )
pure virtual

function to initialize connection to GUI

QString const& QgisPlugin::name ( ) const
inline

Get the name of the plugin.

QString& QgisPlugin::name ( )
inline
QgisPlugin::PLUGINTYPE const& QgisPlugin::type ( ) const
inline

Plugin type, either UI or map layer.

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

Plugin type, either UI or map layer.

virtual void QgisPlugin::unload ( )
pure virtual

Unload the plugin and cleanup the GUI.

QString const& QgisPlugin::version ( ) const
inline

Version of the plugin.

QString& QgisPlugin::version ( )
inline

Version of the plugin.


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