From f07bb12fc5c59430e995a64956b36331ce3629b9 Mon Sep 17 00:00:00 2001 From: hut Date: Fri, 25 Dec 2009 21:55:04 +0100 Subject: updated pydoc pages --- doc/ranger.fm.html | 182 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 182 insertions(+) create mode 100644 doc/ranger.fm.html (limited to 'doc/ranger.fm.html') diff --git a/doc/ranger.fm.html b/doc/ranger.fm.html new file mode 100644 index 00000000..2d4f7f62 --- /dev/null +++ b/doc/ranger.fm.html @@ -0,0 +1,182 @@ + +Python: module ranger.fm + + + + + +
 
+ 
ranger.fm (version 1.0.0)		index
/home/hut/work/ranger/ranger/fm.py
+

+

+ + + + + +
 
+Classes
       
+
ranger.actions.Actions(ranger.shared.EnvironmentAware, ranger.shared.settings.SettingsAware) +
+
+
FM +
+
+
+

+ + + + + +
 
+class FM(ranger.actions.Actions)
    
Method resolution order:
+
FM
+
ranger.actions.Actions
+
ranger.shared.EnvironmentAware
+
ranger.shared.Awareness
+
ranger.shared.settings.SettingsAware
+
builtins.object
+
+
+Methods defined here:
+
__init__(self, ui=None, bookmarks=None)
Initialize FM.
+ +
block_input(self, sec=0)
+ +
initialize(self)
If ui/bookmarks are None, they will be initialized here.
+ +
loop(self)
The main loop consists of:
+1. reloading bookmarks if outdated
+2. drawing and finalizing ui
+3. reading and handling user input
+4. after X loops: collecting unused directory objects
+ +
+Data and other attributes defined here:
+
input_blocked = False
+ +
input_blocked_until = 0
+ +
stderr_to_out = False
+ +
+Methods inherited from ranger.actions.Actions:
+
cd = enter_dir(self, path)
Enter the directory at the given path
+ +
copy(self)
Copy the selected items
+ +
cut(self)
+ +
delete(self)
+ +
edit_file(self)
Calls execute_file with the current file and app='editor'
+ +
enter_bookmark(self, key)
Enter the bookmark with the name <key>
+ +
enter_dir(self, path)
Enter the directory at the given path
+ +
execute_file(self, files, app='', flags='', mode=0)
Execute a file.
+app is the name of a method in Applications, without the "app_"
+flags is a string consisting of applications.ALLOWED_FLAGS
+mode is a positive integer.
+Both flags and mode specify how the program is run.
+ +
exit(self)
Exit the program
+ +
force_load_preview(self)
+ +
handle_mouse(self)
Handle mouse-buttons if one was pressed
+ +
history_go(self, relative)
Move back and forth in the history
+ +
interrupt(self)
Waits a short time.
+If CTRL+C is pressed while waiting, the program will be exited.
+ +
mark(self, all=False, toggle=False, val=None, movedown=None)
A wrapper for the directory.mark_xyz functions.
+ 
+Arguments:
+all - change all files of the current directory at once?
+toggle - toggle the marked-status?
+val - mark or unmark?
+ +
mkdir(self, name)
+ +
move_left(self, n=1)
Enter the parent directory
+ +
move_pointer(self, relative=0, absolute=None)
Move the pointer down by <relative> or to <absolute>
+ +
move_pointer_by_pages(self, relative)
Move the pointer down by <relative> pages
+ +
move_pointer_by_percentage(self, relative=0, absolute=None)
Move the pointer down by <relative>% or to <absolute>%
+ +
move_right(self, mode=0)
Enter the current directory or execute the current file
+ +
notify(self, text, duration=4, bad=False)
+ +
open_console(self, mode=':', string='')
Open the console if the current UI supports that
+ +
paste(self)
Paste the selected items into the current directory
+ +
redraw_window(self)
Redraw the window
+ +
reset(self)
Reset the filemanager, clearing the directory buffer
+ +
resize(self)
Update the size of the UI
+ +
scroll(self, relative)
Scroll down by <relative> lines
+ +
search_backward(self)
Search backward for the regexp in self.env.last_search
+ +
search_forward(self)
Search forward for the regexp in self.env.last_search
+ +
set_bookmark(self, key)
Set the bookmark with the name <key> to the current directory
+ +
sort(self, func=None, reverse=None)
+ +
spawn(self, command)
+ +
toggle_boolean_option(self, string)
Toggle a boolean option named <string>
+ +
unset_bookmark(self, key)
Delete the bookmark with the name <key>
+ +
+Data and other attributes inherited from ranger.shared.EnvironmentAware:
+
env = None
+ +
+Data descriptors inherited from ranger.shared.Awareness:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+Data and other attributes inherited from ranger.shared.settings.SettingsAware:
+
settings = <ranger.ext.openstruct.OpenStruct object at 0x154e450>
+ +

+ + + + + +
 
+Functions
       
time(...)
time() -> floating point number
+ 
+Return the current time in seconds since the Epoch.
+Fractions of a second may be present if the system clock provides them.
+

+ + + + + +
 
+Data
       CTRL_C = 3
+TICKS_BEFORE_COLLECTING_GARBAGE = 100
+__version__ = '1.0.0'
+ \ No newline at end of file -- cgit 1.4.1-2-gfad0