diff options
| author | mathieui <mathieui@mathieui.net> | 2011-11-13 19:51:47 +0100 |
|---|---|---|
| committer | mathieui <mathieui@mathieui.net> | 2011-11-13 19:51:47 +0100 |
| commit | 3dbb45dc76a28bf514b42c08f296b779bb1ee9cc (patch) | |
| tree | 78bdabfec8d3bdcefa58be3a798a2635eeda6e64 /doc | |
| parent | 39fcd9a4f6ace2e00f133bfaa15b1eaf0a0dce9a (diff) | |
| download | poezio-3dbb45dc76a28bf514b42c08f296b779bb1ee9cc.tar.gz poezio-3dbb45dc76a28bf514b42c08f296b779bb1ee9cc.tar.bz2 poezio-3dbb45dc76a28bf514b42c08f296b779bb1ee9cc.tar.xz poezio-3dbb45dc76a28bf514b42c08f296b779bb1ee9cc.zip | |
Plugin doc for add_key and del_key
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/en/plugins.txt | 13 |
1 files changed, 12 insertions, 1 deletions
diff --git a/doc/en/plugins.txt b/doc/en/plugins.txt index 87f09cb7..7bb3dbe3 100644 --- a/doc/en/plugins.txt +++ b/doc/en/plugins.txt @@ -61,10 +61,21 @@ Everything else is handled by that _auto_completion()_ method (checking what special completion for that command, just pass None (the default value). *del_command*:: +self+, +name+ + -This command removes a tab command added by your plugin. +This method removes a command added by your plugin. * _name_: (string) the name of the command you want to remove. +*add_key*:: +self+, +key+, +handler+ + +This method adds a global keyboard shortcut on _key_ that will call _handler_. +You can get the keys with _python3 src/keyboard.py_. + +* _key_: String representing the key press in curses. +* _handler_: Method called whenever _key_ is pressed. + +*del_key*:: +self+, +key+ + +This method deletes a keyboard shortcut previously added by your plugin. + +* _key_: String representing the key press in curses. *add_tab_command*:: +self+, +tab_type+, +name+, +handler+, +help+, +completion+ + This method adds a tab-custom command to poezio. For example you can add /dou |