ch0ic3/cutter
1
0
Fork 0
mirror of https://github.com/rizinorg/cutter.git synced 2024-12-19 19:36:11 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Document terminate() Method for Python Plugins (#1387)

Browse Source
This commit is contained in:
Florian Märkl 2019-04-14 22:00:39 +02:00 committed by GitHub
parent 7eb62a976c
commit 926b74119e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/source/plugins/tutorial-python.rst
View File

@ -21,6 +21,9 @@ Create a python file, called ``myplugin.py`` for example, and add the following
def setupInterface(self, main): def setupInterface(self, main):
pass pass
def terminate(self):
pass
def create_cutter_plugin(): def create_cutter_plugin():
return MyCutterPlugin() return MyCutterPlugin()
@ -39,6 +42,7 @@ The ``CutterPlugin`` subclass contains some meta-info and two callback methods:
* ``setupPlugin()`` is called right after the plugin is loaded and can be used to initialize the plugin itself. * ``setupPlugin()`` is called right after the plugin is loaded and can be used to initialize the plugin itself.
* ``setupInterface()`` is called with the instance of MainWindow as an argument and should create and register any UI components. * ``setupInterface()`` is called with the instance of MainWindow as an argument and should create and register any UI components.
* ``terminate()`` is called on shutdown and should clean up any resources used by the plugin.
Copy this file into the ``python`` subdirectory located under the plugins directory of Cutter and start the application. Copy this file into the ``python`` subdirectory located under the plugins directory of Cutter and start the application.
You should see an entry for your plugin in the list under Edit -> Preferences -> Plugins. You should see an entry for your plugin in the list under Edit -> Preferences -> Plugins.
@ -251,5 +255,8 @@ Full Code
widget = MyDockWidget(main, action) widget = MyDockWidget(main, action)
main.addPluginDockWidget(widget, action) main.addPluginDockWidget(widget, action)
def terminate(self):
pass
def create_cutter_plugin(): def create_cutter_plugin():
return MyCutterPlugin() return MyCutterPlugin()