pep/poezio
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Plugin doc for add_key and del_key

Browse source
This commit is contained in:
mathieui 2011-11-13 19:51:47 +01:00
parent 39fcd9a4f6
commit 3dbb45dc76
1 changed files with 12 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
doc/en/plugins.txt
View file

@ -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