From 4c13e1f2d85483e026d79ab05da9f1e8e4b45293 Mon Sep 17 00:00:00 2001 From: hut Date: Sat, 2 Jan 2010 00:10:49 +0100 Subject: updated pydoc documentation --- doc/pydoc/ranger.defaults.keys.html | 29 +++++++++++++++++++++++++---- 1 file changed, 25 insertions(+), 4 deletions(-) (limited to 'doc/pydoc/ranger.defaults.keys.html') diff --git a/doc/pydoc/ranger.defaults.keys.html b/doc/pydoc/ranger.defaults.keys.html index 782ee6d2..f3da9f8f 100644 --- a/doc/pydoc/ranger.defaults.keys.html +++ b/doc/pydoc/ranger.defaults.keys.html @@ -9,7 +9,23 @@  
ranger.defaults.keysindex
/home/hut/work/ranger/ranger/defaults/keys.py -

+

Syntax for binding keys: bind(*keys, fnc)
+ 
+keys are one or more key-combinations which are either:
+* a string
+* an integer which represents an ascii code
+* a tuple of integers
+ 
+fnc is a function which is called with the CommandArgument object.
+ 
+The CommandArgument object has these methods:
+cmdarg.fm: the file manager instance
+cmdarg.wdg: the widget or ui instance
+cmdarg.n: the number typed before the key combination (if allowed)
+cmdarg.keys: the string representation of the used key combination
+cmdarg.keybuffer: the keybuffer instance
+ 
+Check ranger.keyapi for more information

@@ -17,7 +33,7 @@ Modules -
       
curses
+
ranger.gui.widgets.console_mode

@@ -54,7 +70,9 @@
init_pair(...)
initialize_commands(command_list)
Initialize the commands for the main user interface
initialize_console_commands(command_list)
Initialize the commands for the console widget only
-
initialize_process_manager_commands(command_list)
Initialize the commands for the process manager widget
+
initialize_embedded_pager_commands(command_list)
+
initialize_pager_commands(command_list)
+
initialize_taskview_commands(command_list)
Initialize the commands for the TaskView widget
intrflush(...)
is_term_resized(...)
isendwin(...)
@@ -86,6 +104,7 @@
savetty(...)
setsyx(...)
setupterm(...)
+
system_functions(command_list)
Each commandlist should have those.
termattrs(...)
termname(...)
tigetflag(...)
@@ -353,5 +372,7 @@ US = 31
VT = 11
controlnames = ['NUL', 'SOH', 'STX', 'ETX', 'EOT', 'ENQ', 'ACK', 'BEL', 'BS', 'HT', 'LF', 'VT', 'FF', 'CR', 'SO', 'SI', 'DLE', 'DC1', 'DC2', 'DC3', ...]
-version = b'2.2'
+fm = <ranger.keyapi.Wrapper object at 0x7f20a5b429d0>
+version = b'2.2'
+wdg = <ranger.keyapi.Wrapper object at 0x7f20a5b42a10>

\ No newline at end of file -- cgit 1.4.1-2-gfad0