mirror of
https://github.com/qgis/QGIS.git
synced 2025-02-26 00:02:08 -05:00
1879b2709d
git-svn-id: http://svn.osgeo.org/qgis/trunk/qgis@3198 c8812cc2-4d05-0410-92ff-de0c093fc19c
126 lines
4.2 KiB
C++
126 lines
4.2 KiB
C++
/***************************************************************************
|
|
plugin.h
|
|
Functions:
|
|
-------------------
|
|
begin : Jan 21, 2004
|
|
copyright : (C) 2004 by Tim Sutton
|
|
email : tim@linfiniti.com
|
|
|
|
***************************************************************************/
|
|
|
|
/***************************************************************************
|
|
* *
|
|
* This program is free software; you can redistribute it and/or modify *
|
|
* it under the terms of the GNU General Public License as published by *
|
|
* the Free Software Foundation; either version 2 of the License, or *
|
|
* (at your option) any later version. *
|
|
* *
|
|
***************************************************************************/
|
|
/* $Id$ */
|
|
/***************************************************************************
|
|
* QGIS Programming conventions:
|
|
*
|
|
* mVariableName - a class level member variable
|
|
* sVariableName - a static class level member variable
|
|
* variableName() - accessor for a class member (no 'get' in front of name)
|
|
* setVariableName() - mutator for a class member (prefix with 'set')
|
|
*
|
|
* Additional useful conventions:
|
|
*
|
|
* theVariableName - a method parameter (prefix with 'the')
|
|
* myVariableName - a locally declared variable within a method ('my' prefix)
|
|
*
|
|
* DO: Use mixed case variable names - myVariableName
|
|
* DON'T: separate variable names using underscores: my_variable_name (NO!)
|
|
*
|
|
* **************************************************************************/
|
|
#ifndef [pluginname]
|
|
#define [pluginname]
|
|
#include "../qgisplugin.h"
|
|
#include <qwidget.h>
|
|
|
|
#include "../../src/qgisapp.h"
|
|
|
|
|
|
/**
|
|
* \class Plugin
|
|
* \brief [name] plugin for QGIS
|
|
* [description]
|
|
*/
|
|
class [pluginname]:public QObject, public QgisPlugin
|
|
{
|
|
Q_OBJECT public:
|
|
|
|
//////////////////////////////////////////////////////////////////////
|
|
//
|
|
// MANDATORY PLUGIN METHODS FOLLOW
|
|
//
|
|
//////////////////////////////////////////////////////////////////////
|
|
|
|
/**
|
|
* Constructor for a plugin. The QgisApp and QgisIface pointers are passed by
|
|
* QGIS when it attempts to instantiate the plugin.
|
|
* @param Pointer to the QgisApp object
|
|
* @param Pointer to the QgisIface object.
|
|
*/
|
|
[pluginname](QgisApp * , QgisIface * );
|
|
//! Destructor
|
|
virtual ~ [pluginname]();
|
|
|
|
public slots:
|
|
//! init the gui
|
|
virtual void initGui();
|
|
//! Show the dialog box
|
|
void run();
|
|
//! unload the plugin
|
|
void unload();
|
|
//! show the help document
|
|
void help();
|
|
|
|
//////////////////////////////////////////////////////////////////////
|
|
//
|
|
// END OF MANDATORY PLUGIN METHODS
|
|
//
|
|
//////////////////////////////////////////////////////////////////////
|
|
//
|
|
// The following methods are provided to demonstrate how you can
|
|
// load a vector or raster layer into the main gui. Please delete
|
|
// if you are not intending to use these. Note also that there are
|
|
// ways in which layers can be loaded.
|
|
//
|
|
|
|
//!draw a raster layer in the qui
|
|
void drawRasterLayer(QString);
|
|
//! Add a vector layer given vectorLayerPath, baseName, providerKey ("ogr" or "postgres");
|
|
void drawVectorLayer(QString,QString,QString);
|
|
|
|
private:
|
|
|
|
////////////////////////////////////////////////////////////////////
|
|
//
|
|
// MANDATORY PLUGIN MEMBER DECLARATIONS .....
|
|
//
|
|
////////////////////////////////////////////////////////////////////
|
|
|
|
int mPluginType;
|
|
//! Id of the plugin's menu. Used for unloading
|
|
int mMenuId;
|
|
//! Pointer to our toolbar
|
|
QToolBar *mToolBarPointer;
|
|
//! Pointer to our menu
|
|
QMenuBar *mMenuBarPointer;
|
|
//! Pionter to QGIS main application object
|
|
QgisApp *mQGisApp;
|
|
//! Pointer to the QGIS interface object
|
|
QgisIface *mQGisIface;
|
|
//!pointer to the qaction for this plugin
|
|
QAction * mQActionPointer;
|
|
////////////////////////////////////////////////////////////////////
|
|
//
|
|
// ADD YOUR OWN MEMBER DECLARATIONS AFTER THIS POINT.....
|
|
//
|
|
////////////////////////////////////////////////////////////////////
|
|
};
|
|
|
|
#endif
|