sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-02-25 00:58:06 -05:00
Code Issues Packages Projects Releases Wiki Activity

Add proper link to QgisPlugin in dxygen docs

Browse Source 
git-svn-id: http://svn.osgeo.org/qgis/trunk@5206 c8812cc2-4d05-0410-92ff-de0c093fc19c
This commit is contained in:
timlinux 2006-04-07 00:08:07 +00:00
parent 66465476f9
commit d5508f15d6
2 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/plugins/plugin_template/README.whatnext
View File

@ -13,9 +13,9 @@ http://svn.qgis.org/api_doc/html/
In particular look at the following classes:
QGisInterface : http://svn.qgis.org/api_doc/html/classQgisInterface.html
QGisIface : http://svn.qgis.org/api_doc/html/classQgisIface.html
QgsMapTool : http://svn.qgis.org/api_doc/html/classQgsMapTool.html
QgsPlugin :
QGisIface : http://svn.qgis.org/api_doc/html/classQgisIface.html
QgsMapTool : http://svn.qgis.org/api_doc/html/classQgsMapTool.html
QgsPlugin : http://svn.qgis.org/api_doc/html/classQgisPlugin.html
QGisIface is an abstract base class (ABC) that specifies what publicly available features of QGIS are exposed to third party code and plugins. QgisInterface is an concrete implementation of this ABC. The preferred way to carry out operations on QGIS is via the QGisInterface. An instance of the QgisInterface is passed to the plugin when it loads. Please consult the QGIS development team if there is functionality required in the QGisInterface that is not available.
@ -29,7 +29,7 @@ This is the generated Makefile specification for your plugin. You will see that
[pluginlcasename].h
[pluginlcasename].cpp
This is the class that provides the 'glue' between your custom application logic and the QGIS application. You will see that a number of methods are already implemented for you - including some examples of how to add a raster or vector layer to the main application map canvas. This class is a subclass of QgisPlugin which defines required behaviour for a plugin. In particular, a plugin has a number of static methods and members so that the QgsPluginManager and plugin loader logic can identify each plugin, create an appropriate menu entry for it etc. Note there is nothing stopping you creating multiple toolbar icons and menu entries for a single plugin. By default though a single menu entry and toolbar button is created and its pre-configured to call the run() method in this class when selected. This default implementation provided for you by the plugin builder is well documented, so please refer to the code for further advice.
This is the class that provides the 'glue' between your custom application logic and the QGIS application. You will see that a number of methods are already implemented for you - including some examples of how to add a raster or vector layer to the main application map canvas. This class is a concrete implementation of QgisPlugin (which defines required behaviour for a plugin). In particular, a plugin has a number of static methods and members so that the QgsPluginManager and plugin loader logic can identify each plugin, create an appropriate menu entry for it etc. Note there is nothing stopping you creating multiple toolbar icons and menu entries for a single plugin. By default though a single menu entry and toolbar button is created and its pre-configured to call the run() method in this class when selected. This default implementation provided for you by the plugin builder is well documented, so please refer to the code for further advice.
[pluginlcasename]guibase.ui
[pluginlcasename]guibase.ui.h

2
src/plugins/plugin_template/pluginguibase.ui
View File

File diff suppressed because one or more lines are too long