Skip to content

Commit

Permalink
Enhancements to plugin builder:
Browse files Browse the repository at this point in the history 
 - replace tokens in README which was missing from the file list
 - use nice word wrapping in README.whatnext


git-svn-id: http://svn.osgeo.org/qgis/trunk/qgis@7872 c8812cc2-4d05-0410-92ff-de0c093fc19c
  • Loading branch information
timlinux committed Jan 8, 2008
1 parent 044bc42 commit 1dfd005
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 11 deletions.
1 change: 1 addition & 0 deletions src/plugins/plugin_builder.py
View file
Expand Up @@ -125,6 +125,7 @@ def plugin_file(pluginDir, file):
#

files = [ plugin_file(pluginDir, 'CMakeLists.txt'),
plugin_file(pluginDir, 'README'),
plugin_file(pluginDir, pluginLCaseName + '.qrc'),
plugin_file(pluginDir, pluginLCaseName + '.cpp'),
plugin_file(pluginDir, pluginLCaseName + '.h'),
Expand Down
54 changes: 43 additions & 11 deletions src/plugins/plugin_template/README.whatnext
View file
@@ -1,7 +1,8 @@
Welcome to your automatically generated plugin!
-------------------------------------------------------------

This is just a starting point. You now need to modify the code to make it do something useful....read on for a more information to get yourself started.
This is just a starting point. You now need to modify the code to make it do
something useful....read on for a more information to get yourself started.

Documentation:
-------------------------------------------------------------
Expand All @@ -17,33 +18,62 @@ QgsMapCanvas : http://svn.qgis.org/api_doc/html/classQgsMapCanvas.html
QgsMapTool : http://svn.qgis.org/api_doc/html/classQgsMapTool.html
QgsPlugin : http://svn.qgis.org/api_doc/html/classQgisPlugin.html

QGisInterface is an abstract base class (ABC) that specifies what publicly available features of QGIS are exposed to third party code and plugins. 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.
QGisInterface is an abstract base class (ABC) that specifies what publicly
available features of QGIS are exposed to third party code and plugins. 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.

QgsPlugin is an ABC that defines required behaviour your plugin must provide. See below for more details.
QgsPlugin is an ABC that defines required behaviour your plugin must provide.
See below for more details.

What are all the files in my generated plugin directory for?
-------------------------------------------------------------

CMakeLists.txt
This is the generated CMake file that builds the plugin. You should add you application specific dependencies and source files to this file.
This is the generated CMake file that builds the plugin. You should add you
application specific dependencies and source files to this file.

[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 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.
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]gui.ui
This is a Qt designer 'ui' file. It defines the look of the default plugin dialog without implementing any application logic. You can modify this form to suite your needs or completely remove it if your plugin does not need to display a user form (e.g. for custom MapTools).
This is a Qt designer 'ui' file. It defines the look of the default plugin
dialog without implementing any application logic. You can modify this form to
suite your needs or completely remove it if your plugin does not need to
display a user form (e.g. for custom MapTools).


[pluginlcasename]gui.cpp
[pluginlcasename]gui.h
This is the concrete class where application logic for the above mentioned dialog should go. The world is your oyster here really....
This is the concrete class where application logic for the above mentioned
dialog should go. The world is your oyster here really....

[pluginlcasename].qrc
This is the Qt4 resources file for your plugin. The Makefile generated for your plugin is all set up to compile the resource file so all you need to do is add your additional icons etc using the simple xml file format. Note the namespace used for all your resources e.g. (":/[pluginname]/"). It is important to use this prefix for all your resources. We suggest you include any other images and run time data in this resurce file too.
This is the Qt4 resources file for your plugin. The Makefile generated for your
plugin is all set up to compile the resource file so all you need to do is add
your additional icons etc using the simple xml file format. Note the namespace
used for all your resources e.g. (":/[pluginname]/"). It is important to use
this prefix for all your resources. We suggest you include any other images and
run time data in this resurce file too.

[pluginlcasename].png
This is the icon that will be used for your plugin menu entry and toolbar icon. Simply replace this icon with your own icon to make your plugin disctinctive from the rest.
This is the icon that will be used for your plugin menu entry and toolbar icon.
Simply replace this icon with your own icon to make your plugin disctinctive
from the rest.

README
This file contains the documentation you are reading now!
Expand All @@ -52,12 +82,14 @@ This file contains the documentation you are reading now!
Getting developer help:
-------------------------------------------------------------

For Questions and Comments regarding the plugin builder template and creating your features in QGIS using the plugin interface please contact us via:
For Questions and Comments regarding the plugin builder template and creating
your features in QGIS using the plugin interface please contact us via:

* the QGIS developers mailing list, or
* IRC (#qgis on freenode.net)

QGIS is distributed under the Gnu Public License. If you create a useful plugin please consider contributing it back to the community.
QGIS is distributed under the Gnu Public License. If you create a useful plugin
please consider contributing it back to the community.

Have fun and thank you for choosing QGIS.

Expand Down

0 comments on commit 1dfd005

Please sign in to comment.