Changes between Version 76 and Version 77 of DevelopGuide

Timestamp:

Mar 31, 2009, 3:23:57 PM (16 years ago)

Author:

Frédéric

Comment:

--

DevelopGuide

@@ -107 +107 @@
 You seems to be familiar with programing. So, I will explain you the way to develop plugins for Papywizard. First, I suggest you use the svn repository:
 
-    svn co http://svn.gbiloba.org/papywizard/trunk papywizard
-
-Plugins implements one or more 'capacity'. Possible capacities are:
+{{{
+$ svn co http://svn.gbiloba.org/papywizard/trunk papywizard
+}}}
+
+''Note: under Windows, you can use [http://tortoisesvn.tigris.org TortoiseSVN].''
+
+Plugins implements one or more 'capacity'. Available capacities are:
 
  * ''yawAxis''
@@ -119 +123 @@
 A plugin needs to implement 2 classes (for each implemented capacity): one for the model (real work), and one for the controller (configuration dialog).
 
-All model classes inherit from the AbstractPlugin class (defined in the papywizard/common/ package).
-
-Then, plugins implementing 'yawAxis' and 'pitchAxis' capacities can inherit from AbstractAxisPlugin, and plugins implementing the 'shutter' capacity can inherits from AbstractShutterPlugin (defined in the papywizard/hardware/ package).
-
-
-
-Controller classes inherits from AbstractPluginController class (defined in the papywizard/controller/ package). This abstract class inherits from other classes, which are responsible to load the .ui GUI defining file.
-
-_defineGui()
-
-Last, a plugin has to implement a register() function, which will be called at startup to register the plugin in Papywizard.
-
-In you case, you need to implement the 'shutter' capacity.
-
-Have a look at the default plugins, in the papywizard/plugins/ package to see concrete examples.
+==== Plugin model ====
+
+All model classes inherit from the '''{{{AbstractPlugin}}}''' class (defined in {{{the papywizard.common.abstractPlugin}}} module).
+
+Then, plugins implementing 'yawAxis' and 'pitchAxis' capacities must inherit from '''{{{AbstractAxisPlugin}}}''', and plugins implementing the 'shutter' capacity must inherit from '''{{{AbstractShutterPlugin}}}''' (defined in the {{{papywizard.hardware.abstractShutterPlugin}}} module). Depending of the implemented capacity, the plugin must overload some methods for Papywizard to work. Have a look at the above classes to see which ones.
+
+The plugin model may need some user parameters in order to work. These parameters must be defined in the '''{{{_defineConfig()}}}''' method. For example:
+
+{{{
+def _defineConfig(self):
+    self._addConfigKey('_myParam', 'MY_PARAM', default='a value')
+}}}
+
+will add a config param named '''{{{MY_PARAM}}}'''. All plugins user params are saved in the config. file. If there is no previous value defined there, the '''{{{default}}}''' argument tells Papywizard which value to use. This config param will be saved using '''{{{MY_PARAM}}}''' as key.
+
+In the plugin, this config param can be used through '''{{{self._config['MY_PARAM']}}}''' (in a future release, it will be automatically binded to '''{{{self._myParam}}}'''). It should not be modified from the model (see below).
+
+==== Plugin controller ====
+
+Controller classes inherits from '''{{{AbstractPluginController}}}''' class (defined in the {{{papywizard/controller/}}} package). This abstract class inherits from other classes, which are responsible to load the .ui GUI defining file (see previous chapters). The only method which needs to be oversloaded is '''{{{_defineGui()}}}'''. This is where the dialog interface is defined. For example:
+
+{{{
+def _defineGui(self):
+    self._addWidget('Main', "My param", LineEditField, (), 'MY_PARAM')
+}}}
+
+will create an entry to customize our previous config param. The first argument is the ''notebook widget tab'' under which the param will be displayed ('''Main''' is the first default ''tab''). The second argument is the label for the config param. The third argument is the field type to use. Availabe fields are defined in the '''{{{papywizard.view.pluginFields}}}''' module. The 4th argument is a tuple containing the init arguments of the field. The last argument is the name of the config param, as defined in the plugin model.
+
+Here is another example:
+
+{{{
+def _defineGui(self):
+    self._addTab('Driver')
+    self._addWidget('Driver', "Type", ComboBoxField, (['bluetooth', 'serial', 'ethernet'],), 'DRIVER_TYPE')
+}}}
+
+The main addition is that we first create a new ''tab'', and then add a '''{{{ComboBoxField}}}'''.
+
+==== Plugin registration ====
+
+Both previous classes must be defined in the same module. To register the plugin, the module also has to implement a '''{{{register()}}}''' function, which will be called at startup. For example:
+
+{{{
+def register():
+    PluginManager().register(MyModelClass, MyModelController)
+}}}
+
+If the plugin module implements several model/controller capacities, just put additional PluginManager().register() calls.
+
+==== Complete example ====
+
+Here is the '''Tethered''' plugin, defined in the '''{{{papywizard/plugins/tetheredPlugins}}}''' module:
+