del net-oscar
[learning-git.git] / pgworksheet_yvesf / plugins / README_PLUGINS
blob2df2b5304d83b9cb86a87207fa718d679a34106e
1 === General
2  * You can put the plugin wherever you want under plugins/
4 === SidebarPlugin
6 <<<<<<
8 #Your imports
9 from pgw.Plugin import SidebarPlugin;
11 class <Your Plugin Class>(SidebarPlugin):
12     name = "PLugin Title"
13     def __init__(self):
14         SidebarPlugin.__init__(self)
15         self.my_box = gtk.HBox()
17         <do somethin>
19         self.add(self.my_box)
21     def on_init(self):
22         #called after setting self.app
23     def on_connection(self):
24         #called everytime a new connection is established
26     ...
29 EXPORTS=[<Your Plugin Class>]
31 <<<<<EOF
33  * SidebarPlugin is a subclass of gtk.VBox()
36 === ResultViewPlugin
37  * See plugins/ResultViewPluginNull for a example
38  * pgworksheet reloads the plugins for every query-results, 
39    that means you dont have to restart it to test your changes