Quantum GIS API Documentation: OgrPlugin Class Reference

Definition at line 33 of file plugin.h.


Public Slots
virtual void	initGui ()
	Initialize the GUI interface for the plugin.
void	run ()
	Slot called when the menu item is triggered.
void	unload ()
	Unload the plugin by cleaning up the GUI.
void	help ()
	show the help document
Public Member Functions
	OgrPlugin (QgisInterface *theInterface)
	Constructor for a plugin.
virtual	~OgrPlugin ()
	Destructor.
Private Attributes
int	mPluginType
QgisInterface *	mQGisIface
	Pointer to the QGIS interface object.
QAction *	mQActionPointer
	pointer to the qaction for this plugin

Constructor & Destructor Documentation

OgrPlugin::OgrPlugin ( QgisInterface * theInterface )

Constructor for a plugin.

The QgisInterface pointer is passed by QGIS when it attempts to instantiate the plugin.

Parameters:

theInterface

Pointer to the QgisInterface object.

Definition at line 42 of file plugin.cpp.

References mQGisIface.

OgrPlugin::~OgrPlugin ( ) [virtual]

Destructor.

Definition at line 50 of file plugin.cpp.

Member Function Documentation

void OgrPlugin::initGui ( ) [virtual, slot]

Initialize the GUI interface for the plugin.

This is only called once when the plugin is added to the plugin registry in the QGIS application.

Implements QgisPlugin.

Definition at line 54 of file plugin.cpp.

References QgisInterface::addPluginToMenu(), QgisInterface::addToolBarIcon(), mQActionPointer, mQGisIface, and run().

void OgrPlugin::run ( ) [slot]

Slot called when the menu item is triggered.

If you created more menu items / toolbar buttons in initiGui, you should create a separate handler for each action - this single run() method will not be enough.

Definition at line 76 of file plugin.cpp.

References QgisInterface::mainWindow(), QgisGui::ModalDialogFlags, and mQGisIface.

Referenced by initGui().

void OgrPlugin::unload ( ) [virtual, slot]

Unload the plugin by cleaning up the GUI.

Implements QgisPlugin.

Definition at line 85 of file plugin.cpp.

References mQActionPointer, mQGisIface, QgisInterface::removePluginMenu(), and QgisInterface::removeToolBarIcon().

void OgrPlugin::help ( ) [slot]

show the help document

Definition at line 71 of file plugin.cpp.

Member Data Documentation