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/os.html | 8 +- doc/pydoc/ranger.__main__.html | 31 ++ doc/pydoc/ranger.actions.html | 37 ++- doc/pydoc/ranger.applications.html | 110 ++++++- doc/pydoc/ranger.commands.html | 217 +++++++----- doc/pydoc/ranger.container.bookmarks.html | 69 +--- doc/pydoc/ranger.container.commandlist.html | 31 +- doc/pydoc/ranger.container.environment.html | 11 +- doc/pydoc/ranger.container.history.html | 2 +- doc/pydoc/ranger.container.html | 1 + doc/pydoc/ranger.container.tags.html | 59 ++++ doc/pydoc/ranger.defaults.apps.html | 38 ++- doc/pydoc/ranger.defaults.keys.html | 29 +- doc/pydoc/ranger.defaults.options.html | 3 +- doc/pydoc/ranger.ext.accumulator.html | 4 +- doc/pydoc/ranger.ext.command_parser.html | 55 ++++ doc/pydoc/ranger.ext.html | 5 +- doc/pydoc/ranger.ext.move.html | 22 ++ doc/pydoc/ranger.ext.shutil_generatorized.html | 4 +- doc/pydoc/ranger.ext.trim.html | 31 ++ doc/pydoc/ranger.fm.html | 41 ++- doc/pydoc/ranger.fsobject.directory.html | 20 +- doc/pydoc/ranger.fsobject.html | 2 +- doc/pydoc/ranger.gui.bar.html | 213 ++++++++++++ doc/pydoc/ranger.gui.colorscheme.html | 2 +- doc/pydoc/ranger.gui.curses_shortcuts.html | 88 +++++ doc/pydoc/ranger.gui.defaultui.html | 58 ++-- doc/pydoc/ranger.gui.displayable.html | 224 ++++++------- doc/pydoc/ranger.gui.html | 10 +- doc/pydoc/ranger.gui.ui.html | 47 ++- doc/pydoc/ranger.gui.widgets.browsercolumn.html | 164 ++++++++++ doc/pydoc/ranger.gui.widgets.browserview.html | 138 ++++++++ doc/pydoc/ranger.gui.widgets.console.html | 416 +++++++++++++++++------- doc/pydoc/ranger.gui.widgets.console_mode.html | 37 +++ doc/pydoc/ranger.gui.widgets.html | 56 ++-- doc/pydoc/ranger.gui.widgets.pager.html | 133 ++++++++ doc/pydoc/ranger.gui.widgets.statusbar.html | 108 ++++-- doc/pydoc/ranger.gui.widgets.taskview.html | 151 +++++++++ doc/pydoc/ranger.gui.widgets.titlebar.html | 233 ++----------- doc/pydoc/ranger.html | 20 +- doc/pydoc/ranger.keyapi.html | 413 +++++++++++++++++++++++ doc/pydoc/ranger.shared.settings.html | 4 +- doc/pydoc/sys.html | 6 +- doc/pydoc/test.html | 14 +- doc/pydoc/test.tc_bookmarks.html | 304 +++++++++++++++++ doc/pydoc/test.tc_colorscheme.html | 2 +- doc/pydoc/test.tc_keyapi.html | 282 ++++++++++++++++ doc/pydoc/test.tc_ui.html | 2 - 48 files changed, 3167 insertions(+), 788 deletions(-) create mode 100644 doc/pydoc/ranger.__main__.html create mode 100644 doc/pydoc/ranger.container.tags.html create mode 100644 doc/pydoc/ranger.ext.command_parser.html create mode 100644 doc/pydoc/ranger.ext.move.html create mode 100644 doc/pydoc/ranger.ext.trim.html create mode 100644 doc/pydoc/ranger.gui.bar.html create mode 100644 doc/pydoc/ranger.gui.curses_shortcuts.html create mode 100644 doc/pydoc/ranger.gui.widgets.browsercolumn.html create mode 100644 doc/pydoc/ranger.gui.widgets.browserview.html create mode 100644 doc/pydoc/ranger.gui.widgets.console_mode.html create mode 100644 doc/pydoc/ranger.gui.widgets.pager.html create mode 100644 doc/pydoc/ranger.gui.widgets.taskview.html create mode 100644 doc/pydoc/ranger.keyapi.html create mode 100644 doc/pydoc/test.tc_bookmarks.html create mode 100644 doc/pydoc/test.tc_keyapi.html diff --git a/doc/pydoc/os.html b/doc/pydoc/os.html index fc746061..605e4269 100644 --- a/doc/pydoc/os.html +++ b/doc/pydoc/os.html @@ -85,7 +85,7 @@ Methods defined here:
Data and other attributes defined here:
-
__new__ = <built-in method __new__ of type object at 0x7f327d94afc0>
T.__new__(S, ...) -> a new object with type S, a subtype of T
+
__new__ = <built-in method __new__ of type object at 0x7f20a8d46fc0>
T.__new__(S, ...) -> a new object with type S, a subtype of T
Methods inherited from EnvironmentError:
@@ -225,7 +225,7 @@ Data descriptors defined here:
Data and other attributes defined here:
-
__new__ = <built-in method __new__ of type object at 0x7f327d99e840>
T.__new__(S, ...) -> a new object with type S, a subtype of T
+
__new__ = <built-in method __new__ of type object at 0x7f20a8d9a840>
T.__new__(S, ...) -> a new object with type S, a subtype of T
n_fields = 16
@@ -303,7 +303,7 @@ Data descriptors defined here:
Data and other attributes defined here:
-
__new__ = <built-in method __new__ of type object at 0x7f327d99e9e0>
T.__new__(S, ...) -> a new object with type S, a subtype of T
+
__new__ = <built-in method __new__ of type object at 0x7f20a8d9a9e0>
T.__new__(S, ...) -> a new object with type S, a subtype of T
n_fields = 10
@@ -897,7 +897,7 @@ Write a string to a file descriptor.curdir = '.'
defpath = ':/bin:/usr/bin'
devnull = '/dev/null'
-environ = <os._Environ object at 0x7f327c987e50>
+environ = <os._Environ object at 0x7f20a7d83e50>
linesep = '\n'
name = 'posix'
pardir = '..'
diff --git a/doc/pydoc/ranger.__main__.html b/doc/pydoc/ranger.__main__.html new file mode 100644 index 00000000..ab0dddb2 --- /dev/null +++ b/doc/pydoc/ranger.__main__.html @@ -0,0 +1,31 @@ + +Python: module ranger.__main__ + + + + + +
 
+ 
ranger.__main__		index
/home/hut/work/ranger/ranger/__main__.py
+

+

+ + + + + +
 
+Modules
       
os
+		sys
+

+ + + + + +
 
+Functions
       
main()
initialize objects and run the filemanager
+
+ \ No newline at end of file diff --git a/doc/pydoc/ranger.actions.html b/doc/pydoc/ranger.actions.html index 4d700dc7..6311dad3 100644 --- a/doc/pydoc/ranger.actions.html +++ b/doc/pydoc/ranger.actions.html @@ -17,10 +17,11 @@ Modules         -
ranger.fsobject
+
ranger.gui.widgets.console_mode
+		ranger.fsobject
os
shutil
-

+

 
@@ -65,13 +66,21 @@ Methods defined here:
delete(self)
+
display_command_help(self, console_widget)
+ +
display_file(self)
+ +
display_log(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.
+
execute_command(self, cmd, **kw)
+ +
execute_file(self, files, **kw)
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.
@@ -115,26 +124,38 @@ val - mark or unmark?
redraw_window(self)
Redraw the window
+
rename(self, src, dest)
+
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
+
search(self, order=None, forward=True)
set_bookmark(self, key)
Set the bookmark with the name <key> to the current directory
+
set_filter(self, fltr)
+ +
set_search_method(self, order, forward=True)
+
sort(self, func=None, reverse=None)
-
spawn(self, command)
+
tag_remove(self, movedown=None)
+ +
tag_toggle(self, movedown=None)
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 defined here:
+
search_forward = False
+ +
search_method = 'ctime'
+
Data and other attributes inherited from ranger.shared.EnvironmentAware:
env = None
@@ -149,7 +170,7 @@ Data descriptors inherited from ranger.sh
Data and other attributes inherited from ranger.shared.settings.SettingsAware:
-
settings = <ranger.ext.openstruct.OpenStruct object at 0x154e450>
+
settings = <ranger.ext.openstruct.OpenStruct object at 0x7f20a718ad90>
\ No newline at end of file diff --git a/doc/pydoc/ranger.applications.html b/doc/pydoc/ranger.applications.html index 822ec412..6cda3202 100644 --- a/doc/pydoc/ranger.applications.html +++ b/doc/pydoc/ranger.applications.html @@ -30,7 +30,8 @@

builtins.object
-
Applications +
AppContext +
Applications
@@ -38,12 +39,106 @@ + + + + +
 
+class AppContext(builtins.object)
   An AppContext object abstracts the spawning of processes.
+ 
+At initialization of the object you can define many high-level options.
+When you call the run() function, those options are evaluated and
+translated into Popen() calls.
+ 
+An instances of this class is passed as the only argument to
+app_xyz calls of the Applications object.
+ 
+Attributes:
+action -- a string with a command or a list of arguments for
+        the Popen call.
+app -- the name of the app function. ("vim" for app_vim.)
+        app is used to get an action if the user didn't specify one.
+mode -- a number, mainly used in determining the action in app_xyz()
+flags -- a string with flags which change the way programs are run
+files -- a list containing files, mainly used in app_xyz
+file -- an arbitrary file from that list (or None)
+fm -- the filemanager instance
+wait -- boolean, wait for the end or execute programs in parallel?
+stdout -- directly passed to Popen
+stderr -- directly passed to Popen
+stdin -- directly passed to Popen
+shell -- directly passed to Popen. Should the string be shell-interpreted?
+ 
+List of allowed flags:
+s: silent mode. output will be discarded.
+d: detach the process.
+p: redirect output to the pager
+ 
+An uppercase key ensures that a certain flag will not be used.
 
 Methods defined here:
+
__init__(self, app='default', files=None, mode=0, flags='', fm=None, stdout=None, stderr=None, stdin=None, shell=None, wait=True, action=None)
The necessary parameters are fm and action or app.
+ +
__iter__(self)
Iterates over all file paths
+ +
get_action(self, apps=None)
Get the action from app_xyz
+ +
run(self)
Run the application in the way specified by the options.
+ 
+This function ensures that there is an action.
+ +
squash_flags(self)
Remove duplicates and lowercase counterparts of uppercase flags
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ + + - + + + -
 
class Applications(builtins.object)
    
   This class contains definitions on how to run programs and should
+be extended in ranger.defaults.apps
+ 
+The user can decide what program to run, and if he uses eg. 'vim', the
+function app_vim() will be called.  However, usually the user
+simply wants to "start" the file without specific instructions.
+In such a case, app_default() is called, where you should examine
+the context and decide which program to use.
+ 
+All app functions have a name starting with app_ and return a string
+containing the whole command or a tuple containing a list of the
+arguments.
+It has one argument, which is the AppContext instance.
+ 
+You should define app_default, app_pager and app_editor since
+internal functions depend on those.  Here are sample implementations:
+ 
+def app_default(self, context):
+        if context.file.media:
+                if context.file.video:
+                        # detach videos from the filemanager
+                        context.flags += 'd'
+                return app_mplayer(context)
+        else:
+                return app_editor(context)
+ 
+def app_pager(self, context):
+        return ('less', ) + tuple(context)
+ 
+def app_editor(self, context):
+        return ('vim', ) + tuple(context)
 
  Methods defined here:
all(self)
Returns a list with all application functions
+
app_self(self, context)
Run the file itself
+
get(self, app)
Looks for an application, returns app_default if it doesn't exist
has(self, app)
Returns whether an application is defined
@@ -63,8 +158,12 @@ Data descriptors defined here:
Functions
       
run(*args, **kw)
Run files with the specified parameters
-
spawn(command, fm=None, suspend=True, wait=True)
+
run(action=None, **kw)
Shortcut for creating and immediately running an AppContext.
+
tup(*args)
This helper function creates a tuple out of the arguments.
+ 
+('a', ) + tuple(some_iterator)
+is equivalent to:
+tup('a', *some_iterator)

@@ -73,5 +172,6 @@ Data descriptors defined here:
        ALLOWED_FLAGS = 'sdpSDP'
-null = <_io.TextIOWrapper name='/dev/null' encoding='UTF-8'>
+PIPE = -1
+devnull = <_io.TextIOWrapper name='/dev/null' encoding='UTF-8'> \ No newline at end of file diff --git a/doc/pydoc/ranger.commands.html b/doc/pydoc/ranger.commands.html index d89a7ff3..f41c3a1a 100644 --- a/doc/pydoc/ranger.commands.html +++ b/doc/pydoc/ranger.commands.html @@ -17,8 +17,9 @@ Modules         -
os
-

+
ranger.gui.widgets.console_mode
+		os
+

- + - + + +
 
@@ -26,12 +27,6 @@
       
-
builtins.object -
-
-
parse -
-
ranger.shared.FileManagerAware(ranger.shared.Awareness)
@@ -40,10 +35,12 @@
cd
delete -
delete +
filter
find +
grep
mkdir
quit +
rename
@@ -68,18 +65,14 @@ Methods defined here:
__init__(self, line, mode)
-
execute(self)
+
execute(self)
Override this
-
quick_open(self)
+
quick_open(self)
Override this
-
tab(self)
+
tab(self)
Override this
Data and other attributes defined here:
-
line = ''
- -
mode = ':'
-
name = None
@@ -101,10 +94,13 @@ Data descriptors inherited from ranger.sh class cd(Command)
   The cd command changes the directory. The command 'cd -' is
-equivalent to typing ``. In the quick console, the directory
-will be entered without the need to press enter, as soon as there
-is one unambiguous match.
 
:cd <dirname>
+ 
+The cd command changes the directory.
+The command 'cd -' is equivalent to typing ``.
+ 
+In the quick console, the directory will be entered without the
+need to press enter, as soon as there is one unambiguous match.
 
 
Method resolution order:
cd
@@ -127,10 +123,6 @@ Methods inherited from Command:
Data and other attributes inherited from Command:
-
line = ''
- -
mode = ':'
-
name = None
@@ -151,7 +143,15 @@ Data descriptors inherited from ranger.sh
 
class delete(Command)
    
   :delete
+ 
+Tries to delete the selection.
+ 
+"Selection" is defined as all the "marked files" (by default, you
+can mark files with space or v). If there are no marked files,
+use the "current file" (where the cursor is)
 
 
Method resolution order:
delete
Command
@@ -167,16 +167,58 @@ Methods defined here:
Methods inherited from Command:
__init__(self, line, mode)
-
quick_open(self)
+
quick_open(self)
Override this
-
tab(self)
+
tab(self)
Override this
Data and other attributes inherited from Command:
-
line = ''
+
name = None
+ +
+Data and other attributes inherited from ranger.shared.FileManagerAware:
+
fm = 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)
+
+

+ + + + + + + + - +
 
+class filter(Command)
   :filter <string>
+ 
+Displays only the files which contain <string> in their basename.
 
 
Method resolution order:
+
filter
+
Command
+
ranger.shared.FileManagerAware
+
ranger.shared.Awareness
+
builtins.object
+
+
+Methods defined here:
+
execute(self)
+ +
+Methods inherited from Command:
+
__init__(self, line, mode)
+ +
quick_open(self)
Override this
-
mode = ':'
+
tab(self)
Override this
+
+Data and other attributes inherited from Command:
name = None
@@ -198,10 +240,13 @@ Data descriptors inherited from ranger.sh class find(Command)
   The find command will attempt to find a partial, case insensitive
-match in the filenames of the current directory. In the quick command
-console, once there is one unambiguous match, the file will be run
-automatically.
 
:find <string>
+ 
+The find command will attempt to find a partial, case insensitive
+match in the filenames of the current directory.
+ 
+In the quick command console, once there is one unambiguous match,
+the file will be run automatically.
 
 
Method resolution order:
find
@@ -216,6 +261,8 @@ Methods defined here:
quick_open(self)
+
tab(self)
+
Data and other attributes defined here:
count = 0
@@ -224,14 +271,8 @@ Data and other attributes defined here:
Methods inherited from Command:
__init__(self, line, mode)
-
tab(self)
-
Data and other attributes inherited from Command:
-
line = ''
- -
mode = ':'
-
name = None
@@ -250,11 +291,15 @@ Data descriptors inherited from ranger.sh +class grep(Command) - + + +
 
-class mkdir(Command)
    
   :grep <string>
+ 
+Looks for a string in all marked files or directories
 
 
Method resolution order:
-
mkdir
+
grep
Command
ranger.shared.FileManagerAware
ranger.shared.Awareness
@@ -262,22 +307,18 @@ Data descriptors inherited from ranger.sh
Methods defined here:
-
execute(self)
+
execute(self)
Methods inherited from Command:
-
__init__(self, line, mode)
+
__init__(self, line, mode)
-
quick_open(self)
+
quick_open(self)
Override this
-
tab(self)
+
tab(self)
Override this
Data and other attributes inherited from Command:
-
line = ''
- -
mode = ':'
-
name = None
@@ -296,20 +337,42 @@ Data descriptors inherited from ranger.sh +class mkdir(Command) - + - - +
 
-class parse(builtins.object)
   Parse commands and extract information
 
:mkdir <dirname>
+ 
+Creates a directory with the name <dirname>.
 
 Methods defined here:
-
__add__(self, newpart)
+
Method resolution order:
+
mkdir
+
Command
+
ranger.shared.FileManagerAware
+
ranger.shared.Awareness
+
builtins.object
+
+
+Methods defined here:
+
execute(self)
-
__init__(self, line)
+
+Methods inherited from Command:
+
__init__(self, line, mode)
+ +
quick_open(self)
Override this
+ +
tab(self)
Override this
+ +
+Data and other attributes inherited from Command:
+
name = None
-
chunk(self, n, otherwise='')
+
+Data and other attributes inherited from ranger.shared.FileManagerAware:
+
fm = None
-Data descriptors defined here:
+Data descriptors inherited from ranger.shared.Awareness:
__dict__
dictionary for instance variables (if defined)
@@ -323,7 +386,9 @@ Data descriptors defined here:
class quit(Command)
   Quits the program.
 
:quit
+ 
+Quits the program immediately.
 
 
Method resolution order:
quit
@@ -340,16 +405,12 @@ Methods defined here:
Methods inherited from Command:
__init__(self, line, mode)
-
quick_open(self)
+
quick_open(self)
Override this
-
tab(self)
+
tab(self)
Override this
Data and other attributes inherited from Command:
-
line = ''
- -
mode = ':'
-
name = None
@@ -368,11 +429,15 @@ Data descriptors inherited from ranger.sh +class rename(Command) - + + +
 
-var = class delete(Command)
    
   :rename <newname>
+ 
+Changes the name of the currently highlighted file to <newname>
 
 
Method resolution order:
-
delete
+
rename
Command
ranger.shared.FileManagerAware
ranger.shared.Awareness
@@ -380,22 +445,18 @@ Data descriptors inherited from ranger.sh
Methods defined here:
-
execute(self)
+
execute(self)
+ +
tab(self)
Methods inherited from Command:
-
__init__(self, line, mode)
- -
quick_open(self)
+
__init__(self, line, mode)
-
tab(self)
+
quick_open(self)
Override this
Data and other attributes inherited from Command:
-
line = ''
- -
mode = ':'
-
name = None
@@ -418,6 +479,7 @@ Data descriptors inherited from ranger.sh
       
alias(**kw)
+
command_generator(start)

@@ -425,6 +487,5 @@ Data descriptors inherited from ranger.sh Data -
       by_name = {'cd': <class 'ranger.commands.cd'>, 'delete': <class 'ranger.commands.delete'>, 'find': <class 'ranger.commands.find'>, 'mkdir': <class 'ranger.commands.mkdir'>, 'q': <class 'ranger.commands.quit'>, 'quit': <class 'ranger.commands.quit'>}
-varname = 'delete'
+

by_name = {'cd': <class 'ranger.commands.cd'>, 'delete': <class 'ranger.commands.delete'>, 'filter': <class 'ranger.commands.filter'>, 'find': <class 'ranger.commands.find'>, 'grep': <class 'ranger.commands.grep'>, 'mkdir': <class 'ranger.commands.mkdir'>, 'q': <class 'ranger.commands.quit'>, 'quit': <class 'ranger.commands.quit'>, 'rename': <class 'ranger.commands.rename'>}
 \ No newline at end of file diff --git a/doc/pydoc/ranger.container.bookmarks.html b/doc/pydoc/ranger.container.bookmarks.html index 699524c4..39ff0d50 100644 --- a/doc/pydoc/ranger.container.bookmarks.html +++ b/doc/pydoc/ranger.container.bookmarks.html @@ -28,12 +28,6 @@
       
-
builtins.Exception(builtins.BaseException) -
-
-
NonexistantBookmark -
-
builtins.object
@@ -66,6 +60,8 @@ Optionally, a bookmark.go() method is used for&nbs
__init__(self, bookmarkfile, bookmarktype=<class 'str'>, autosave=False)
<bookmarkfile> specifies the path to the file where
bookmarks are saved in.
+
__iter__(self)
+
__setitem__(self, key, value)
Bookmark <value> to the key <key>.
key is expected to be a 1-character string and element of ALLOWED_KEYS.
value is expected to be a filesystemobject.
@@ -101,67 +97,8 @@ Data and other attributes defined here:
last_mtime = None
-
load_pattern = <_sre.SRE_Pattern object at 0x15161a0>
- -

- - - - - -
 
-class NonexistantBookmark(builtins.Exception)
    
Method resolution order:
-
NonexistantBookmark
-
builtins.Exception
-
builtins.BaseException
-
builtins.object
-
-
-Data descriptors defined here:
-
__weakref__
-
list of weak references to the object (if defined)
-
-
-Methods inherited from builtins.Exception:
-
__init__(...)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
+
load_pattern = <_sre.SRE_Pattern object at 0x7f20a5b7b760>
-
-Data and other attributes inherited from builtins.Exception:
-
__new__ = <built-in method __new__ of type object at 0x7f327d94a120>
T.__new__(S, ...) -> a new object with type S, a subtype of T
- -
-Methods inherited from builtins.BaseException:
-
__delattr__(...)
x.__delattr__('name') <==> del x.name
- -
__getattribute__(...)
x.__getattribute__('name') <==> x.name
- -
__reduce__(...)
- -
__repr__(...)
x.__repr__() <==> repr(x)
- -
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
- -
__setstate__(...)
- -
__str__(...)
x.__str__() <==> str(x)
- -
with_traceback(...)
Exception.with_traceback(tb) --
-set self.__traceback__ to tb and return self.
- -
-Data descriptors inherited from builtins.BaseException:
-
__cause__
-
exception cause
-
-
__context__
-
exception context
-
-
__dict__
-
-
__traceback__
-
-
args
-

diff --git a/doc/pydoc/ranger.container.commandlist.html b/doc/pydoc/ranger.container.commandlist.html index 1620984c..c9ddd62f 100644 --- a/doc/pydoc/ranger.container.commandlist.html +++ b/doc/pydoc/ranger.container.commandlist.html @@ -22,6 +22,7 @@
Command +
CommandArgument
CommandList
Hint
@@ -41,6 +42,8 @@
execute(self, *args)
Execute the command
+
execute_wrap(self, displayable)
+
Data descriptors defined here:
__dict__
@@ -53,6 +56,24 @@ Data descriptors defined here:
Data and other attributes defined here:
keys = []
+

+ + + + + +
 
+class CommandArgument(builtins.object)
    Methods defined here:
+
__init__(self, fm, displayable, keybuffer)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+

@@ -125,5 +146,13 @@ Data and other attributes defined here:
text = ''
-
+

+ + + + + +
 
+Functions
       
cmdarg(displayable)
+
\ No newline at end of file diff --git a/doc/pydoc/ranger.container.environment.html b/doc/pydoc/ranger.container.environment.html index 4909d588..6ee8a0df 100644 --- a/doc/pydoc/ranger.container.environment.html +++ b/doc/pydoc/ranger.container.environment.html @@ -12,6 +12,15 @@

+ + + + +
 
+Modules
       
curses
+		os
+

+ @@ -99,7 +108,7 @@ Data descriptors inherited from ranger.shared.settings.SettingsAware:
-
settings = <ranger.ext.openstruct.OpenStruct object at 0x154e450>
+
settings = <ranger.ext.openstruct.OpenStruct object at 0x7f20a718ad90>
 
Classes
\ No newline at end of file diff --git a/doc/pydoc/ranger.container.history.html b/doc/pydoc/ranger.container.history.html index 5094de92..68fe9cfa 100644 --- a/doc/pydoc/ranger.container.history.html +++ b/doc/pydoc/ranger.container.history.html @@ -97,7 +97,7 @@ Methods inherited from builtins.Exception:

Data and other attributes inherited from builtins.Exception:
-
__new__ = <built-in method __new__ of type object at 0x7f327d94a120>
T.__new__(S, ...) -> a new object with type S, a subtype of T
+
__new__ = <built-in method __new__ of type object at 0x7f20a8d46120>
T.__new__(S, ...) -> a new object with type S, a subtype of T
Methods inherited from builtins.BaseException:
diff --git a/doc/pydoc/ranger.container.html b/doc/pydoc/ranger.container.html index 7154fd15..948e7c64 100644 --- a/doc/pydoc/ranger.container.html +++ b/doc/pydoc/ranger.container.html @@ -23,5 +23,6 @@ used to manage stored data

environment
history
keybuffer
+tags
\ No newline at end of file diff --git a/doc/pydoc/ranger.container.tags.html b/doc/pydoc/ranger.container.tags.html new file mode 100644 index 00000000..9ab557bc --- /dev/null +++ b/doc/pydoc/ranger.container.tags.html @@ -0,0 +1,59 @@ + +Python: module ranger.container.tags + + + + + +
 
+ 
ranger.container.tags		index
/home/hut/work/ranger/ranger/container/tags.py
+

+

+ + + + + +
 
+Classes
       
+
builtins.object +
+
+
Tags +
+
+
+

+ + + + + +
 
+class Tags(builtins.object)
    Methods defined here:
+
__contains__(self, item)
+ +
__init__(self, filename)
+ +
add(self, *items)
+ +
dump(self)
+ +
remove(self, *items)
+ +
sync(self)
+ +
toggle(self, *items)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ \ No newline at end of file diff --git a/doc/pydoc/ranger.defaults.apps.html b/doc/pydoc/ranger.defaults.apps.html index f969eebf..6d22ba72 100644 --- a/doc/pydoc/ranger.defaults.apps.html +++ b/doc/pydoc/ranger.defaults.apps.html @@ -12,6 +12,15 @@

+ + + + +
 
+Modules
       
os
+		sys
+

+ @@ -39,26 +48,28 @@
Methods defined here:
-
app_aunpack(self, **kw)
+
app_aunpack(self, c)
-
app_default(self, **kw)
# How to determine the default application? {{{
+
app_default(self, c)
How to determine the default application?
-
app_editor = app_vim(self, **kw)
+
app_editor = app_vim(self, c)
-
app_evince(self, **kw)
+
app_evince(self, c)
-
app_feh(self, **kw)
+
app_feh(self, c)
-
app_mplayer(self, **kw)
+
app_mplayer(self, c)
-
app_pager(self, **kw)
+
app_pager(self, c)
# ----------------------------------------- application definitions
-
app_vim(self, **kw)
+
app_vim(self, c)
Methods inherited from ranger.applications.Applications:
all(self)
Returns a list with all application functions
+
app_self(self, context)
Run the file itself
+
get(self, app)
Looks for an application, returns app_default if it doesn't exist
has(self, app)
Returns whether an application is defined
@@ -71,5 +82,14 @@ Data descriptors inherited from
__weakref__
list of weak references to the object (if defined)
-
 
Classes
+

+ + + + + +
 
+Data
       ALLOWED_FLAGS = 'sdpSDP'
+PIPE = -1
+devnull = <_io.TextIOWrapper name='/dev/null' encoding='UTF-8'>
\ No newline at end of file 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 diff --git a/doc/pydoc/ranger.defaults.options.html b/doc/pydoc/ranger.defaults.options.html index 09542348..7e095e70 100644 --- a/doc/pydoc/ranger.defaults.options.html +++ b/doc/pydoc/ranger.defaults.options.html @@ -29,11 +29,12 @@         auto_load_preview = True
+autosave_bookmarks = True
collapse_preview = True
directories_first = True
max_dirsize_for_autopreview = None
max_history_size = 20
-preview_files = False
+preview_files = True
reverse = False
scroll_offset = 2
show_hidden = False
diff --git a/doc/pydoc/ranger.ext.accumulator.html b/doc/pydoc/ranger.ext.accumulator.html index 7a1a2304..f830d920 100644 --- a/doc/pydoc/ranger.ext.accumulator.html +++ b/doc/pydoc/ranger.ext.accumulator.html @@ -37,9 +37,11 @@

correct_pointer(self)
+
get_height(self)
OVERRIDE THIS
+
get_list(self)
OVERRIDE THIS
-
move(self, relative=0, absolute=None)
+
move(self, relative=0, absolute=None, pages=False)
move_to_obj(self, arg, attr=None)
diff --git a/doc/pydoc/ranger.ext.command_parser.html b/doc/pydoc/ranger.ext.command_parser.html new file mode 100644 index 00000000..c24232c6 --- /dev/null +++ b/doc/pydoc/ranger.ext.command_parser.html @@ -0,0 +1,55 @@ + +Python: module ranger.ext.command_parser + + + + + +
 
+ 
ranger.ext.command_parser		index
/home/hut/work/ranger/ranger/ext/command_parser.py
+

+

+ + + + + +
 
+Classes
       
+
builtins.object +
+
+
LazyParser +
+
+
+

+ + + + + + + +
 
+class LazyParser(builtins.object)
   Parse commands and extract information
 
 Methods defined here:
+
__add__(self, newpart)
+ +
__init__(self, line)
+ +
chunk(self, n, otherwise='')
Chunks are pieces of the command seperated by spaces
+ +
rest(self, n, otherwise='')
Rests are the strings which come after each word.
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ \ No newline at end of file diff --git a/doc/pydoc/ranger.ext.html b/doc/pydoc/ranger.ext.html index 06848c5d..c0add5b8 100644 --- a/doc/pydoc/ranger.ext.html +++ b/doc/pydoc/ranger.ext.html @@ -18,12 +18,15 @@        
accumulator
+command_parser
debug
get_all_modules
human_readable
+move
openstruct
relpath
-		shutil_generatorized
+shutil_generatorized
+		trim
waitpid_no_intr
\ No newline at end of file diff --git a/doc/pydoc/ranger.ext.move.html b/doc/pydoc/ranger.ext.move.html new file mode 100644 index 00000000..1c8bcf70 --- /dev/null +++ b/doc/pydoc/ranger.ext.move.html @@ -0,0 +1,22 @@ + +Python: module ranger.ext.move + + + + + +
 
+ 
ranger.ext.move		index
/home/hut/work/ranger/ranger/ext/move.py
+

+

+ + + + + +
 
+Functions
       
move_between(current, minimum, maximum, relative=0, absolute=None)
+
+ \ No newline at end of file diff --git a/doc/pydoc/ranger.ext.shutil_generatorized.html b/doc/pydoc/ranger.ext.shutil_generatorized.html index bee4db77..f0d0de11 100644 --- a/doc/pydoc/ranger.ext.shutil_generatorized.html +++ b/doc/pydoc/ranger.ext.shutil_generatorized.html @@ -79,7 +79,7 @@ Data descriptors inherited from builtin

Data and other attributes inherited from builtins.EnvironmentError:
-
__new__ = <built-in method __new__ of type object at 0x7f327d94ac80>
T.__new__(S, ...) -> a new object with type S, a subtype of T
+
__new__ = <built-in method __new__ of type object at 0x7f20a8d46c80>
T.__new__(S, ...) -> a new object with type S, a subtype of T
Methods inherited from builtins.BaseException:
@@ -153,7 +153,7 @@ Data descriptors inherited from builtin
Data and other attributes inherited from builtins.EnvironmentError:
-
__new__ = <built-in method __new__ of type object at 0x7f327d94ac80>
T.__new__(S, ...) -> a new object with type S, a subtype of T
+
__new__ = <built-in method __new__ of type object at 0x7f20a8d46c80>
T.__new__(S, ...) -> a new object with type S, a subtype of T
Methods inherited from builtins.BaseException:
diff --git a/doc/pydoc/ranger.ext.trim.html b/doc/pydoc/ranger.ext.trim.html new file mode 100644 index 00000000..0dbd67f0 --- /dev/null +++ b/doc/pydoc/ranger.ext.trim.html @@ -0,0 +1,31 @@ + +Python: module ranger.ext.trim + + + + + +
 
+ 
ranger.ext.trim		index
/home/hut/work/ranger/ranger/ext/trim.py
+

+

+ + + + + +
 
+Modules
       
sys
+

+ + + + + +
 
+Functions
       
trim_docstring(docstring)
+
trimmed_lines_of_docstring(docstring)
+
+ \ No newline at end of file diff --git a/doc/pydoc/ranger.fm.html b/doc/pydoc/ranger.fm.html index 2d4f7f62..d8b80d0a 100644 --- a/doc/pydoc/ranger.fm.html +++ b/doc/pydoc/ranger.fm.html @@ -42,7 +42,7 @@

Methods defined here:
-
__init__(self, ui=None, bookmarks=None)
Initialize FM.
+
__init__(self, ui=None, bookmarks=None, tags=None)
Initialize FM.
block_input(self, sec=0)
@@ -50,9 +50,10 @@ Methods defined 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
+2. letting the loader work
+3. drawing and finalizing ui
+4. reading and handling user input
+5. after X loops: collecting unused directory objects
Data and other attributes defined here:
@@ -72,13 +73,21 @@ Methods inherited from ranger.actions.Acti
delete(self)
+
display_command_help(self, console_widget)
+ +
display_file(self)
+ +
display_log(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.
+
execute_command(self, cmd, **kw)
+ +
execute_file(self, files, **kw)
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.
@@ -122,26 +131,38 @@ val - mark or unmark?
redraw_window(self)
Redraw the window
+
rename(self, src, dest)
+
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
+
search(self, order=None, forward=True)
set_bookmark(self, key)
Set the bookmark with the name <key> to the current directory
+
set_filter(self, fltr)
+ +
set_search_method(self, order, forward=True)
+
sort(self, func=None, reverse=None)
-
spawn(self, command)
+
tag_remove(self, movedown=None)
+ +
tag_toggle(self, movedown=None)
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.actions.Actions:
+
search_forward = False
+ +
search_method = 'ctime'
+
Data and other attributes inherited from ranger.shared.EnvironmentAware:
env = None
@@ -156,7 +177,7 @@ Data descriptors inherited from ranger.sh
Data and other attributes inherited from ranger.shared.settings.SettingsAware:
-
settings = <ranger.ext.openstruct.OpenStruct object at 0x154e450>
+
settings = <ranger.ext.openstruct.OpenStruct object at 0x7f20a718ad90>

diff --git a/doc/pydoc/ranger.fsobject.directory.html b/doc/pydoc/ranger.fsobject.directory.html index ee87c5bb..0183ea14 100644 --- a/doc/pydoc/ranger.fsobject.directory.html +++ b/doc/pydoc/ranger.fsobject.directory.html @@ -86,6 +86,8 @@ Methods defined here:
correct_pointer(self)
Make sure the pointer is in the valid range
+
cycle(self, forward=True)
+
empty(self)
Is the directory empty?
get_list(self)
@@ -109,7 +111,9 @@ outdated or not done yet
move_to_obj(self, arg)
-
search(self, arg, direction=1)
Search for a regular expression
+
search_fnc(self, fnc, forward=True)
+ +
set_cycle_list(self, lst)
sort(self)
Sort the containing files
@@ -123,6 +127,8 @@ outdated or not done yet
Data and other attributes defined here:
+
cycle_list = None
+
enterable = False
filenames = None
@@ -139,6 +145,8 @@ Data and other attributes defined here:
old_directories_first = None
+
old_filter = None
+
old_reverse = None
old_show_hidden = None
@@ -149,7 +157,7 @@ Data and other attributes defined here:
scroll_offset = 0
-
sort_dict = {'basename': <function sort_by_basename at 0x154a408>, 'mtime': <function <lambda> at 0x1569518>, 'size': <function <lambda> at 0x1569490>, 'type': <function <lambda> at 0x15695a0>}
+
sort_dict = {'basename': <function sort_by_basename at 0x7f20a71a31e8>, 'mtime': <function <lambda> at 0x7f20a71a3848>, 'size': <function <lambda> at 0x7f20a71a37c0>, 'type': <function <lambda> at 0x7f20a71a38d0>}
Methods inherited from ranger.fsobject.fsobject.FileSystemObject:
@@ -255,7 +263,9 @@ Data and other attributes inherited from ranger.ext.accumulator.Accumulator:
-
move(self, relative=0, absolute=None)
+
get_height(self)
OVERRIDE THIS
+ +
move(self, relative=0, absolute=None, pages=False)
pointer_is_synced(self)
@@ -263,7 +273,7 @@ Methods inherited from ranger.
Data and other attributes inherited from ranger.shared.settings.SettingsAware:
-
settings = <ranger.ext.openstruct.OpenStruct object at 0x154e450>
+
settings = <ranger.ext.openstruct.OpenStruct object at 0x7f20a718ad90>

@@ -289,7 +299,7 @@ Methods inherited from builtins.Exception:
Data and other attributes inherited from builtins.Exception:
-
__new__ = <built-in method __new__ of type object at 0x7f327d94a120>
T.__new__(S, ...) -> a new object with type S, a subtype of T
+
__new__ = <built-in method __new__ of type object at 0x7f20a8d46120>
T.__new__(S, ...) -> a new object with type S, a subtype of T
Methods inherited from builtins.BaseException:
diff --git a/doc/pydoc/ranger.fsobject.html b/doc/pydoc/ranger.fsobject.html index fff54d0c..d825a3e8 100644 --- a/doc/pydoc/ranger.fsobject.html +++ b/doc/pydoc/ranger.fsobject.html @@ -61,7 +61,7 @@ Methods inherited from builtins.Exception:
Data and other attributes inherited from builtins.Exception:
-
__new__ = <built-in method __new__ of type object at 0x7f327d94a120>
T.__new__(S, ...) -> a new object with type S, a subtype of T
+
__new__ = <built-in method __new__ of type object at 0x7f20a8d46120>
T.__new__(S, ...) -> a new object with type S, a subtype of T
Methods inherited from builtins.BaseException:
diff --git a/doc/pydoc/ranger.gui.bar.html b/doc/pydoc/ranger.gui.bar.html new file mode 100644 index 00000000..7c5c9f4d --- /dev/null +++ b/doc/pydoc/ranger.gui.bar.html @@ -0,0 +1,213 @@ + +Python: module ranger.gui.bar + + + +
+ +
 
+ 
ranger.gui.bar		index
/home/hut/work/ranger/ranger/gui/bar.py
+

+

+ + + + + +
 
+Classes
       
+
builtins.list(builtins.object) +
+
+
BarSide +
+
+
builtins.object +
+
+
Bar +
ColoredString +
+
+
+

+ + + + + +
 
+class Bar(builtins.object)
    Methods defined here:
+
__init__(self, base_color_tag)
+ +
add(self, *a, **kw)
+ +
addright(self, *a, **kw)
+ +
combine(self)
+ +
fill_gap(self, char, wid, gapwidth=False)
+ +
fixedsize(self)
+ +
shrink_by_cutting(self, wid)
+ +
shrink_by_removing(self, wid)
+ +
sumsize(self)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+Data and other attributes defined here:
+
gap = None
+ +
left = None
+ +
right = None
+ +

+ + + + + +
 
+class BarSide(builtins.list)
    
Method resolution order:
+
BarSide
+
builtins.list
+
builtins.object
+
+
+Methods defined here:
+
__init__(self, base_color_tag)
+ +
add(self, string, *lst, **kw)
+ +
add_space(self, n=1)
+ +
fixedsize(self)
+ +
nonfixed_items(self)
+ +
sumsize(self)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+Methods inherited from builtins.list:
+
__add__(...)
x.__add__(y) <==> x+y
+ +
__contains__(...)
x.__contains__(y) <==> y in x
+ +
__delitem__(...)
x.__delitem__(y) <==> del x[y]
+ +
__eq__(...)
x.__eq__(y) <==> x==y
+ +
__ge__(...)
x.__ge__(y) <==> x>=y
+ +
__getattribute__(...)
x.__getattribute__('name') <==> x.name
+ +
__getitem__(...)
x.__getitem__(y) <==> x[y]
+ +
__gt__(...)
x.__gt__(y) <==> x>y
+ +
__iadd__(...)
x.__iadd__(y) <==> x+=y
+ +
__imul__(...)
x.__imul__(y) <==> x*=y
+ +
__iter__(...)
x.__iter__() <==> iter(x)
+ +
__le__(...)
x.__le__(y) <==> x<=y
+ +
__len__(...)
x.__len__() <==> len(x)
+ +
__lt__(...)
x.__lt__(y) <==> x<y
+ +
__mul__(...)
x.__mul__(n) <==> x*n
+ +
__ne__(...)
x.__ne__(y) <==> x!=y
+ +
__repr__(...)
x.__repr__() <==> repr(x)
+ +
__reversed__(...)
L.__reversed__() -- return a reverse iterator over the list
+ +
__rmul__(...)
x.__rmul__(n) <==> n*x
+ +
__setitem__(...)
x.__setitem__(i, y) <==> x[i]=y
+ +
__sizeof__(...)
L.__sizeof__() -- size of L in memory, in bytes
+ +
append(...)
L.append(object) -- append object to end
+ +
count(...)
L.count(value) -> integer -- return number of occurrences of value
+ +
extend(...)
L.extend(iterable) -- extend list by appending elements from the iterable
+ +
index(...)
L.index(value, [start, [stop]]) -> integer -- return first index of value.
+Raises ValueError if the value is not present.
+ +
insert(...)
L.insert(index, object) -- insert object before index
+ +
pop(...)
L.pop([index]) -> item -- remove and return item at index (default last).
+Raises IndexError if list is empty or index is out of range.
+ +
remove(...)
L.remove(value) -- remove first occurrence of value.
+Raises ValueError if the value is not present.
+ +
reverse(...)
L.reverse() -- reverse *IN PLACE*
+ +
sort(...)
L.sort(key=None, reverse=False) -- stable sort *IN PLACE*
+ +
+Data and other attributes inherited from builtins.list:
+
__hash__ = None
+ +
__new__ = <built-in method __new__ of type object at 0x7f20a8d4e3a0>
T.__new__(S, ...) -> a new object with type S, a subtype of T
+ +

+ + + + + +
 
+class ColoredString(builtins.object)
    Methods defined here:
+
__init__(self, string, *lst)
+ +
__len__(self)
+ +
__str__(self)
+ +
cut_off(self, n)
+ +
cut_off_to(self, n)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+Data and other attributes defined here:
+
fixed = False
+ +

+ \ No newline at end of file diff --git a/doc/pydoc/ranger.gui.colorscheme.html b/doc/pydoc/ranger.gui.colorscheme.html index dd12acae..5bc0e2df 100644 --- a/doc/pydoc/ranger.gui.colorscheme.html +++ b/doc/pydoc/ranger.gui.colorscheme.html @@ -58,5 +58,5 @@ Data descriptors defined here:
Data         -CONTEXT_KEYS = ['reset', 'error', 'in_display', 'in_statusbar', 'in_titlebar', 'in_console', 'in_notify', 'in_pman', 'directory', 'file', 'hostname', 'executable', 'media', 'link', 'video', 'audio', 'image', 'media', 'document', 'container', ...] +CONTEXT_KEYS = ['reset', 'error', 'in_browser', 'in_statusbar', 'in_titlebar', 'in_console', 'in_notify', 'in_taskview', 'directory', 'file', 'hostname', 'executable', 'media', 'link', 'video', 'audio', 'image', 'media', 'document', 'container', ...] \ No newline at end of file diff --git a/doc/pydoc/ranger.gui.curses_shortcuts.html b/doc/pydoc/ranger.gui.curses_shortcuts.html new file mode 100644 index 00000000..49c7db26 --- /dev/null +++ b/doc/pydoc/ranger.gui.curses_shortcuts.html @@ -0,0 +1,88 @@ + +Python: module ranger.gui.curses_shortcuts + + + + + +
 
+ 
ranger.gui.curses_shortcuts		index
/home/hut/work/ranger/ranger/gui/curses_shortcuts.py
+

+

+ + + + + +
 
+Modules
       
_curses
+

+ + + + + +
 
+Classes
       
+
ranger.shared.settings.SettingsAware(builtins.object) +
+
+
CursesShortcuts +
+
+
+

+ + + + + + + +
 
+class CursesShortcuts(ranger.shared.settings.SettingsAware)
   This class defines shortcuts to faciliate operations with curses.
+color(*keys) -- sets the color associated with the keys from
+        the current colorscheme.
+color_at(y, x, wid, *keys) -- sets the color at the given position
+color_reset() -- resets the color to the default
+addstr(*args) -- failsafe version of self.win.addstr(*args)
 
 
Method resolution order:
+
CursesShortcuts
+
ranger.shared.settings.SettingsAware
+
builtins.object
+
+
+Methods defined here:
+
addnstr(self, *args)
+ +
addstr(self, *args)
+ +
color(self, keylist=None, *keys)
Change the colors from now on.
+ +
color_at(self, y, x, wid, keylist=None, *keys)
Change the colors at the specified position
+ +
color_reset(self)
Change the colors to the default colors
+ +
+Data descriptors inherited from ranger.shared.settings.SettingsAware:
+
__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 0x7f20a718ad90>
+ +

+ + + + + +
 
+Functions
       
combine(seq, tup)
Add seq and tup. Ensures that the result is a tuple.
+
+ \ No newline at end of file diff --git a/doc/pydoc/ranger.gui.defaultui.html b/doc/pydoc/ranger.gui.defaultui.html index 4d80acac..b0d56dee 100644 --- a/doc/pydoc/ranger.gui.defaultui.html +++ b/doc/pydoc/ranger.gui.defaultui.html @@ -40,6 +40,7 @@

ranger.shared.EnvironmentAware
ranger.shared.FileManagerAware
ranger.shared.Awareness
+
ranger.gui.curses_shortcuts.CursesShortcuts
ranger.shared.settings.SettingsAware
builtins.object
@@ -47,17 +48,25 @@ Methods defined here:
close_console(self)
-
close_pman(self)
+
close_embedded_pager(self)
-
display(self, *a, **k)
+
close_pager(self)
+ +
close_taskview(self)
hint(self, text=None)
+
notify(self, *a, **k)
+
open_console(self, mode, string='')
-
open_pman(self)
+
open_embedded_pager(self)
+ +
open_pager(self)
-
poke(self)
+
open_taskview(self)
+ +
redraw_main_column(self)
scroll(self, relative)
@@ -103,17 +112,15 @@ Data and other attributes inherited from ranger.
Methods inherited from ranger.gui.displayable.DisplayableContainer:
-
add_obj(self, *objs)
+
add_child(self, obj)
Add the objects to the container.
click(self, event)
Recursively called on objects in container
-
get_focused_obj(self)
Finds a focused displayable object in the container.
+
poke(self)
Recursively called on objects in container
press(self, key)
Recursively called on objects in container
-
-Data and other attributes inherited from ranger.gui.displayable.DisplayableContainer:
-
container = None
+
remove_child(self, obj)
Remove the object from the container.
Methods inherited from ranger.gui.displayable.Displayable:
@@ -122,26 +129,13 @@ item can be an iterable like [y, x] or&n
__nonzero__(self)
Always True
-
color(self, keylist=None, *keys)
Change the colors from now on.
- -
color_at(self, y, x, wid, keylist=None, *keys)
Change the colors at the specified position
- -
color_reset(self)
Change the colors to the default colors
+
__str__(self)
-
contains_point(self, y, x)
Test if the point lies within the boundaries of this object
+
contains_point(self, y, x)
Test whether the point (with absolute coordinates) lies
+within the boundaries of this object.
resize(self, y, x, hei=None, wid=None)
Resize the widget
-
-Data and other attributes inherited from ranger.gui.displayable.Displayable:
-
colorscheme = None
- -
focused = False
- -
visible = True
- -
win = None
-
Data and other attributes inherited from ranger.shared.EnvironmentAware:
env = None
@@ -158,9 +152,21 @@ Data descriptors inherited from ranger.sh
__weakref__
list of weak references to the object (if defined)
+
+Methods inherited from ranger.gui.curses_shortcuts.CursesShortcuts:
+
addnstr(self, *args)
+ +
addstr(self, *args)
+ +
color(self, keylist=None, *keys)
Change the colors from now on.
+ +
color_at(self, y, x, wid, keylist=None, *keys)
Change the colors at the specified position
+ +
color_reset(self)
Change the colors to the default colors
+
Data and other attributes inherited from ranger.shared.settings.SettingsAware:
-
settings = <ranger.ext.openstruct.OpenStruct object at 0x154e450>
+
settings = <ranger.ext.openstruct.OpenStruct object at 0x7f20a718ad90>

diff --git a/doc/pydoc/ranger.gui.displayable.html b/doc/pydoc/ranger.gui.displayable.html index a581fbeb..cbe29b2c 100644 --- a/doc/pydoc/ranger.gui.displayable.html +++ b/doc/pydoc/ranger.gui.displayable.html @@ -12,22 +12,24 @@

+ + + + +
 
+Modules
       
_curses
+

+
 
Classes
       
-
builtins.Exception(builtins.BaseException) +
ranger.gui.curses_shortcuts.CursesShortcuts(ranger.shared.settings.SettingsAware)
-
OutOfBoundsException -
-
-
ranger.shared.EnvironmentAware(ranger.shared.Awareness) -
-
-
Displayable(ranger.shared.EnvironmentAware, ranger.shared.FileManagerAware, ranger.shared.settings.SettingsAware) +
Displayable(ranger.shared.EnvironmentAware, ranger.shared.FileManagerAware, ranger.gui.curses_shortcuts.CursesShortcuts)
DisplayableContainer @@ -35,10 +37,10 @@
-
ranger.shared.FileManagerAware(ranger.shared.Awareness) +
ranger.shared.EnvironmentAware(ranger.shared.Awareness)
-
Displayable(ranger.shared.EnvironmentAware, ranger.shared.FileManagerAware, ranger.shared.settings.SettingsAware) +
Displayable(ranger.shared.EnvironmentAware, ranger.shared.FileManagerAware, ranger.gui.curses_shortcuts.CursesShortcuts)
DisplayableContainer @@ -46,10 +48,10 @@
-
ranger.shared.settings.SettingsAware(builtins.object) +
ranger.shared.FileManagerAware(ranger.shared.Awareness)
-
Displayable(ranger.shared.EnvironmentAware, ranger.shared.FileManagerAware, ranger.shared.settings.SettingsAware) +
Displayable(ranger.shared.EnvironmentAware, ranger.shared.FileManagerAware, ranger.gui.curses_shortcuts.CursesShortcuts)
DisplayableContainer @@ -62,14 +64,48 @@ +class Displayable(ranger.shared.EnvironmentAware, ranger.shared.FileManagerAware, ranger.gui.curses_shortcuts.CursesShortcuts) - + + +
 
-class Displayable(ranger.shared.EnvironmentAware, ranger.shared.FileManagerAware, ranger.shared.settings.SettingsAware)
    
   Displayables are objects which are displayed on the screen.
+ 
+This is just the abstract class, defining basic operations
+such as resizing, printing, changing colors.
+Subclasses of displayable can extend these methods:
+ 
+draw() -- draw the object. Is only called if visible.
+poke() -- is called just before draw(), even if not visible.
+finalize() -- called after all objects finished drawing.
+click(event) -- called with a MouseEvent. This is called on all
+        visible objects under the mouse, until one returns True.
+press(key) -- called after a key press on focused objects.
+destroy() -- called before destroying the displayable object
+ 
+Additionally, there are these methods:
+ 
+__contains__(item) -- is the item (y, x) inside the widget?
+ 
+These attributes are set:
+ 
+Modifiable:
+        focused -- Focused objects receive press() calls.
+        visible -- Visible objects receive draw() and finalize() calls
+        need_redraw -- Should the widget be redrawn? This variable may
+                be set at various places in the script and should eventually be
+                handled (and unset) in the draw() method.
+ 
+Read-Only: (i.e. reccomended not to change manually)
+        win -- the own curses window object
+        parent -- the parent (DisplayableContainer) object or None
+        x, y, wid, hei -- absolute coordinates and boundaries
+        settings, fm, env -- inherited shared variables
 
 
Method resolution order:
Displayable
ranger.shared.EnvironmentAware
ranger.shared.FileManagerAware
ranger.shared.Awareness
+
ranger.gui.curses_shortcuts.CursesShortcuts
ranger.shared.settings.SettingsAware
builtins.object
@@ -82,22 +118,20 @@ item can be an iterable like [y, x] or&n
__nonzero__(self)
Always True
+
__str__(self)
+
click(self, event)
Called when a mouse key is pressed and self.focused is True.
Override this!
-
color(self, keylist=None, *keys)
Change the colors from now on.
- -
color_at(self, y, x, wid, keylist=None, *keys)
Change the colors at the specified position
- -
color_reset(self)
Change the colors to the default colors
- -
contains_point(self, y, x)
Test if the point lies within the boundaries of this object
+
contains_point(self, y, x)
Test whether the point (with absolute coordinates) lies
+within the boundaries of this object.
destroy(self)
Called when the object is destroyed.
Override this!
-
draw(self)
Draw displayable.  Called on every main iteration if the object
-is visible.  Override this!
+
draw(self)
Draw the object. Called on every main iteration if visible.
+Containers should call draw() on their contained objects here.
+Override this!
finalize(self)
Called after every displayable is done drawing.
Override this!
@@ -109,16 +143,6 @@ Override this!
resize(self, y, x, hei=None, wid=None)
Resize the widget
-
-Data and other attributes defined here:
-
colorscheme = None
- -
focused = False
- -
visible = True
- -
win = None
-
Data and other attributes inherited from ranger.shared.EnvironmentAware:
env = None
@@ -135,9 +159,21 @@ Data descriptors inherited from ranger.sh
__weakref__
list of weak references to the object (if defined)
+
+Methods inherited from ranger.gui.curses_shortcuts.CursesShortcuts:
+
addnstr(self, *args)
+ +
addstr(self, *args)
+ +
color(self, keylist=None, *keys)
Change the colors from now on.
+ +
color_at(self, y, x, wid, keylist=None, *keys)
Change the colors at the specified position
+ +
color_reset(self)
Change the colors to the default colors
+
Data and other attributes inherited from ranger.shared.settings.SettingsAware:
-
settings = <ranger.ext.openstruct.OpenStruct object at 0x154e450>
+
settings = <ranger.ext.openstruct.OpenStruct object at 0x7f20a718ad90>

@@ -145,13 +181,29 @@ Data and other attributes inherited from class DisplayableContainer(Displayable) - + + +
    
   DisplayableContainers are Displayables which contain other Displayables.
+ 
+This is also an abstract class. The methods draw, poke, finalize,
+click, press and destroy are extended here and will recursively
+call the function on all contained objects.
+ 
+New methods:
+ 
+add_child(object) -- add the object to the container.
+remove_child(object) -- remove the object from the container.
+ 
+New attributes:
+ 
+container -- a list with all contained objects (rw)
 
 
Method resolution order:
DisplayableContainer
Displayable
ranger.shared.EnvironmentAware
ranger.shared.FileManagerAware
ranger.shared.Awareness
+
ranger.gui.curses_shortcuts.CursesShortcuts
ranger.shared.settings.SettingsAware
builtins.object
@@ -159,7 +211,7 @@ Data and other attributes inherited from __init__(self, win, env=None, fm=None, settings=None) -
add_obj(self, *objs)
+
add_child(self, obj)
Add the objects to the container.
click(self, event)
Recursively called on objects in container
@@ -169,15 +221,11 @@ Methods defined here:
finalize(self)
Recursively called on visible objects in container
-
get_focused_obj(self)
Finds a focused displayable object in the container.
-
poke(self)
Recursively called on objects in container
press(self, key)
Recursively called on objects in container
-
-Data and other attributes defined here:
-
container = None
+
remove_child(self, obj)
Remove the object from the container.
Methods inherited from Displayable:
@@ -186,26 +234,13 @@ item can be an iterable like [y, x] or&n
__nonzero__(self)
Always True
-
color(self, keylist=None, *keys)
Change the colors from now on.
- -
color_at(self, y, x, wid, keylist=None, *keys)
Change the colors at the specified position
+
__str__(self)
-
color_reset(self)
Change the colors to the default colors
- -
contains_point(self, y, x)
Test if the point lies within the boundaries of this object
+
contains_point(self, y, x)
Test whether the point (with absolute coordinates) lies
+within the boundaries of this object.
resize(self, y, x, hei=None, wid=None)
Resize the widget
-
-Data and other attributes inherited from Displayable:
-
colorscheme = None
- -
focused = False
- -
visible = True
- -
win = None
-
Data and other attributes inherited from ranger.shared.EnvironmentAware:
env = None
@@ -223,75 +258,20 @@ Data descriptors inherited from ranger.sh
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>
- -

- - - - - -
 
-class OutOfBoundsException(builtins.Exception)
    
Method resolution order:
-
OutOfBoundsException
-
builtins.Exception
-
builtins.BaseException
-
builtins.object
-
-
-Data descriptors defined here:
-
__weakref__
-
list of weak references to the object (if defined)
-
-
-Methods inherited from builtins.Exception:
-
__init__(...)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
- -
-Data and other attributes inherited from builtins.Exception:
-
__new__ = <built-in method __new__ of type object at 0x7f327d94a120>
T.__new__(S, ...) -> a new object with type S, a subtype of T
- -
-Methods inherited from builtins.BaseException:
-
__delattr__(...)
x.__delattr__('name') <==> del x.name
- -
__getattribute__(...)
x.__getattribute__('name') <==> x.name
- -
__reduce__(...)
+Methods inherited from ranger.gui.curses_shortcuts.CursesShortcuts:
+
addnstr(self, *args)
-
__repr__(...)
x.__repr__() <==> repr(x)
+
addstr(self, *args)
-
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
- -
__setstate__(...)
+
color(self, keylist=None, *keys)
Change the colors from now on.
-
__str__(...)
x.__str__() <==> str(x)
+
color_at(self, y, x, wid, keylist=None, *keys)
Change the colors at the specified position
-
with_traceback(...)
Exception.with_traceback(tb) --
-set self.__traceback__ to tb and return self.
+
color_reset(self)
Change the colors to the default colors
-Data descriptors inherited from builtins.BaseException:
-
__cause__
-
exception cause
-
-
__context__
-
exception context
-
-
__dict__
-
-
__traceback__
-
-
args
-
-

- - - - - -
 
-Functions
       
combine(seq, tup)
Add seq and tup. Ensures that the result is a tuple.
-
+Data and other attributes inherited from ranger.shared.settings.SettingsAware:
+

settings = <ranger.ext.openstruct.OpenStruct object at 0x7f20a718ad90>
+ + \ No newline at end of file diff --git a/doc/pydoc/ranger.gui.html b/doc/pydoc/ranger.gui.html index 58ba2974..601d64f7 100644 --- a/doc/pydoc/ranger.gui.html +++ b/doc/pydoc/ranger.gui.html @@ -17,12 +17,14 @@ Package Contents         -
color
+
bar
+color
colorscheme
-		defaultui
+		curses_shortcuts
+defaultui
displayable
mouse_event
ui
-		widgets (package)
-
+widgets (package)
+ \ No newline at end of file diff --git a/doc/pydoc/ranger.gui.ui.html b/doc/pydoc/ranger.gui.ui.html index 003a4ffd..415de67d 100644 --- a/doc/pydoc/ranger.gui.ui.html +++ b/doc/pydoc/ranger.gui.ui.html @@ -17,8 +17,9 @@ Modules         -
curses
-

+
_curses
+		curses
+

 
@@ -47,6 +48,7 @@
ranger.shared.EnvironmentAware
ranger.shared.FileManagerAware
ranger.shared.Awareness
+
ranger.gui.curses_shortcuts.CursesShortcuts
ranger.shared.settings.SettingsAware
builtins.object
@@ -92,19 +94,15 @@ Data and other attributes defined here:
Methods inherited from ranger.gui.displayable.DisplayableContainer:
-
add_obj(self, *objs)
+
add_child(self, obj)
Add the objects to the container.
click(self, event)
Recursively called on objects in container
-
get_focused_obj(self)
Finds a focused displayable object in the container.
-
poke(self)
Recursively called on objects in container
press(self, key)
Recursively called on objects in container
-
-Data and other attributes inherited from ranger.gui.displayable.DisplayableContainer:
-
container = None
+
remove_child(self, obj)
Remove the object from the container.
Methods inherited from ranger.gui.displayable.Displayable:
@@ -113,26 +111,13 @@ item can be an iterable like [y, x] or&n
__nonzero__(self)
Always True
-
color(self, keylist=None, *keys)
Change the colors from now on.
- -
color_at(self, y, x, wid, keylist=None, *keys)
Change the colors at the specified position
+
__str__(self)
-
color_reset(self)
Change the colors to the default colors
- -
contains_point(self, y, x)
Test if the point lies within the boundaries of this object
+
contains_point(self, y, x)
Test whether the point (with absolute coordinates) lies
+within the boundaries of this object.
resize(self, y, x, hei=None, wid=None)
Resize the widget
-
-Data and other attributes inherited from ranger.gui.displayable.Displayable:
-
colorscheme = None
- -
focused = False
- -
visible = True
- -
win = None
-
Data and other attributes inherited from ranger.shared.EnvironmentAware:
env = None
@@ -149,9 +134,21 @@ Data descriptors inherited from ranger.sh
__weakref__
list of weak references to the object (if defined)
+
+Methods inherited from ranger.gui.curses_shortcuts.CursesShortcuts:
+
addnstr(self, *args)
+ +
addstr(self, *args)
+ +
color(self, keylist=None, *keys)
Change the colors from now on.
+ +
color_at(self, y, x, wid, keylist=None, *keys)
Change the colors at the specified position
+ +
color_reset(self)
Change the colors to the default colors
+
Data and other attributes inherited from ranger.shared.settings.SettingsAware:
-
settings = <ranger.ext.openstruct.OpenStruct object at 0x154e450>
+
settings = <ranger.ext.openstruct.OpenStruct object at 0x7f20a718ad90>
\ No newline at end of file diff --git a/doc/pydoc/ranger.gui.widgets.browsercolumn.html b/doc/pydoc/ranger.gui.widgets.browsercolumn.html new file mode 100644 index 00000000..fbda6d04 --- /dev/null +++ b/doc/pydoc/ranger.gui.widgets.browsercolumn.html @@ -0,0 +1,164 @@ + +Python: module ranger.gui.widgets.browsercolumn + + + + + +
 
+ 
ranger.gui.widgets.browsercolumn		index
/home/hut/work/ranger/ranger/gui/widgets/browsercolumn.py
+

The BrowserColumn widget displays the contents of a directory or file.

+

+ + + + + +
 
+Classes
       
+
ranger.gui.widgets.Widget(ranger.gui.displayable.Displayable) +
+
+
BrowserColumn(ranger.gui.widgets.pager.Pager, ranger.gui.widgets.Widget) +
+
+
ranger.gui.widgets.pager.Pager(ranger.gui.widgets.Widget) +
+
+
BrowserColumn(ranger.gui.widgets.pager.Pager, ranger.gui.widgets.Widget) +
+
+
+

+ + + + + +
 
+class BrowserColumn(ranger.gui.widgets.pager.Pager, ranger.gui.widgets.Widget)
    
Method resolution order:
+
BrowserColumn
+
ranger.gui.widgets.pager.Pager
+
ranger.gui.widgets.Widget
+
ranger.gui.displayable.Displayable
+
ranger.shared.EnvironmentAware
+
ranger.shared.FileManagerAware
+
ranger.shared.Awareness
+
ranger.gui.curses_shortcuts.CursesShortcuts
+
ranger.shared.settings.SettingsAware
+
builtins.object
+
+
+Methods defined here:
+
__init__(self, win, level)
+ +
__str__(self)
+ +
click(self, event)
Handle a MouseEvent
+ +
draw(self)
Call either _draw_file() or _draw_directory()
+ +
has_preview(self)
+ +
poke(self)
+ +
resize(self, y, x, hei, wid)
+ +
scroll(self, relative)
scroll by n lines
+ +
+Data and other attributes defined here:
+
display_infostring = False
+ +
main_column = False
+ +
old_cf = None
+ +
old_dir = None
+ +
postpone_drawing = False
+ +
scroll_begin = 0
+ +
tagged_marker = '*'
+ +
target = None
+ +
+Methods inherited from ranger.gui.widgets.pager.Pager:
+
close(self)
+ +
move(self, relative=0, absolute=None, pages=False)
+ +
move_horizontal(self, relative=0, absolute=None)
+ +
open(self)
+ +
press(self, key)
+ +
set_source(self, source, strip=False)
+ +
+Data and other attributes inherited from ranger.gui.widgets.pager.Pager:
+
old_scroll_begin = 0
+ +
old_source = None
+ +
old_startx = 0
+ +
source = None
+ +
source_is_stream = False
+ +
+Methods inherited from ranger.gui.displayable.Displayable:
+
__contains__(self, item)
Is item inside the boundaries?
+item can be an iterable like [y, x] or an object with x and y methods.
+ +
__nonzero__(self)
Always True
+ +
contains_point(self, y, x)
Test whether the point (with absolute coordinates) lies
+within the boundaries of this object.
+ +
destroy(self)
Called when the object is destroyed.
+Override this!
+ +
finalize(self)
Called after every displayable is done drawing.
+Override this!
+ +
+Data and other attributes inherited from ranger.shared.EnvironmentAware:
+
env = None
+ +
+Data and other attributes inherited from ranger.shared.FileManagerAware:
+
fm = 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)
+
+
+Methods inherited from ranger.gui.curses_shortcuts.CursesShortcuts:
+
addnstr(self, *args)
+ +
addstr(self, *args)
+ +
color(self, keylist=None, *keys)
Change the colors from now on.
+ +
color_at(self, y, x, wid, keylist=None, *keys)
Change the colors at the specified position
+ +
color_reset(self)
Change the colors to the default colors
+ +
+Data and other attributes inherited from ranger.shared.settings.SettingsAware:
+
settings = <ranger.ext.openstruct.OpenStruct object at 0x7f20a718ad90>
+ +

+ \ No newline at end of file diff --git a/doc/pydoc/ranger.gui.widgets.browserview.html b/doc/pydoc/ranger.gui.widgets.browserview.html new file mode 100644 index 00000000..650e5f6f --- /dev/null +++ b/doc/pydoc/ranger.gui.widgets.browserview.html @@ -0,0 +1,138 @@ + +Python: module ranger.gui.widgets.browserview + + + + + +
 
+ 
ranger.gui.widgets.browserview		index
/home/hut/work/ranger/ranger/gui/widgets/browserview.py
+

The BrowserView manages a set of BrowserColumns.

+

+ + + + + +
 
+Classes
       
+
ranger.gui.displayable.DisplayableContainer(ranger.gui.displayable.Displayable) +
+
+
BrowserView(ranger.gui.widgets.Widget, ranger.gui.displayable.DisplayableContainer) +
+
+
ranger.gui.widgets.Widget(ranger.gui.displayable.Displayable) +
+
+
BrowserView(ranger.gui.widgets.Widget, ranger.gui.displayable.DisplayableContainer) +
+
+
+

+ + + + + +
 
+class BrowserView(ranger.gui.widgets.Widget, ranger.gui.displayable.DisplayableContainer)
    
Method resolution order:
+
BrowserView
+
ranger.gui.widgets.Widget
+
ranger.gui.displayable.DisplayableContainer
+
ranger.gui.displayable.Displayable
+
ranger.shared.EnvironmentAware
+
ranger.shared.FileManagerAware
+
ranger.shared.Awareness
+
ranger.gui.curses_shortcuts.CursesShortcuts
+
ranger.shared.settings.SettingsAware
+
builtins.object
+
+
+Methods defined here:
+
__init__(self, win, ratios, preview=True)
+ +
click(self, event)
+ +
close_pager(self)
+ +
draw(self)
+ +
open_pager(self)
+ +
poke(self)
+ +
resize(self, y, x, hei, wid)
Resize all the columns according to the given ratio
+ +
+Data and other attributes defined here:
+
need_clear = False
+ +
preview = True
+ +
preview_available = True
+ +
ratios = None
+ +
stretch_ratios = None
+ +
+Methods inherited from ranger.gui.displayable.DisplayableContainer:
+
add_child(self, obj)
Add the objects to the container.
+ +
destroy(self)
Recursively called on objects in container
+ +
finalize(self)
Recursively called on visible objects in container
+ +
press(self, key)
Recursively called on objects in container
+ +
remove_child(self, obj)
Remove the object from the container.
+ +
+Methods inherited from ranger.gui.displayable.Displayable:
+
__contains__(self, item)
Is item inside the boundaries?
+item can be an iterable like [y, x] or an object with x and y methods.
+ +
__nonzero__(self)
Always True
+ +
__str__(self)
+ +
contains_point(self, y, x)
Test whether the point (with absolute coordinates) lies
+within the boundaries of this object.
+ +
+Data and other attributes inherited from ranger.shared.EnvironmentAware:
+
env = None
+ +
+Data and other attributes inherited from ranger.shared.FileManagerAware:
+
fm = 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)
+
+
+Methods inherited from ranger.gui.curses_shortcuts.CursesShortcuts:
+
addnstr(self, *args)
+ +
addstr(self, *args)
+ +
color(self, keylist=None, *keys)
Change the colors from now on.
+ +
color_at(self, y, x, wid, keylist=None, *keys)
Change the colors at the specified position
+ +
color_reset(self)
Change the colors to the default colors
+ +
+Data and other attributes inherited from ranger.shared.settings.SettingsAware:
+
settings = <ranger.ext.openstruct.OpenStruct object at 0x7f20a718ad90>
+ +

+ \ No newline at end of file diff --git a/doc/pydoc/ranger.gui.widgets.console.html b/doc/pydoc/ranger.gui.widgets.console.html index a14b7212..87ed81c0 100644 --- a/doc/pydoc/ranger.gui.widgets.console.html +++ b/doc/pydoc/ranger.gui.widgets.console.html @@ -34,14 +34,19 @@ commands, searching and executing files.

Console
+
ConsoleWithTab +
+
CommandConsole
QuickCommandConsole
+
QuickOpenConsole +
+
OpenConsole -
QuickOpenConsole
SearchConsole
@@ -52,30 +57,34 @@ commands, searching and executing files.

+class CommandConsole(ConsoleWithTab)
 
-class CommandConsole(Console)
    
Method resolution order:
CommandConsole
+
ConsoleWithTab
Console
ranger.gui.widgets.Widget
ranger.gui.displayable.Displayable
ranger.shared.EnvironmentAware
ranger.shared.FileManagerAware
ranger.shared.Awareness
+
ranger.gui.curses_shortcuts.CursesShortcuts
ranger.shared.settings.SettingsAware
builtins.object
Methods defined here:
-
execute(self)
- -
tab(self, n=1)
+
execute(self, cmd=None)
Data and other attributes defined here:
prompt = ':'
+
+Methods inherited from ConsoleWithTab:
+
tab(self, n=1)
+
Methods inherited from Console:
__init__(self, win)
@@ -126,8 +135,6 @@ Data and other attributes inherited from __nonzero__(self)
Always True
+
__str__(self)
+
click(self, event)
Called when a mouse key is pressed and self.focused is True.
Override this!
-
color(self, keylist=None, *keys)
Change the colors from now on.
- -
color_at(self, y, x, wid, keylist=None, *keys)
Change the colors at the specified position
- -
color_reset(self)
Change the colors to the default colors
- -
contains_point(self, y, x)
Test if the point lies within the boundaries of this object
+
contains_point(self, y, x)
Test whether the point (with absolute coordinates) lies
+within the boundaries of this object.
destroy(self)
Called when the object is destroyed.
Override this!
@@ -161,14 +165,6 @@ Override this!
resize(self, y, x, hei=None, wid=None)
Resize the widget
-
-Data and other attributes inherited from ranger.gui.displayable.Displayable:
-
colorscheme = None
- -
focused = False
- -
win = None
-
Data and other attributes inherited from ranger.shared.EnvironmentAware:
env = None
@@ -185,9 +181,21 @@ Data descriptors inherited from ranger.sh
__weakref__
list of weak references to the object (if defined)
+
+Methods inherited from ranger.gui.curses_shortcuts.CursesShortcuts:
+
addnstr(self, *args)
+ +
addstr(self, *args)
+ +
color(self, keylist=None, *keys)
Change the colors from now on.
+ +
color_at(self, y, x, wid, keylist=None, *keys)
Change the colors at the specified position
+ +
color_reset(self)
Change the colors to the default colors
+
Data and other attributes inherited from ranger.shared.settings.SettingsAware:
-
settings = <ranger.ext.openstruct.OpenStruct object at 0x154e450>
+
settings = <ranger.ext.openstruct.OpenStruct object at 0x7f20a718ad90>

@@ -203,6 +211,7 @@ Data and other attributes inherited from ranger.shared.EnvironmentAware
ranger.shared.FileManagerAware
ranger.shared.Awareness
+
ranger.gui.curses_shortcuts.CursesShortcuts
ranger.shared.settings.SettingsAware
builtins.object
@@ -260,8 +269,6 @@ Data and other attributes defined here:
mode = None
-
mode_classes = {'!': <class 'ranger.gui.widgets.console.OpenConsole'>, '/': <class 'ranger.gui.widgets.console.SearchConsole'>, ':': <class 'ranger.gui.widgets.console.CommandConsole'>, '>': <class 'ranger.gui.widgets.console.QuickCommandConsole'>, '?': <class 'ranger.gui.widgets.console.SearchConsole'>, '@': <class 'ranger.gui.widgets.console.QuickOpenConsole'>}
-
original_line = None
override = None
@@ -279,31 +286,159 @@ item can be an iterable like [y, x] or&n
__nonzero__(self)
Always True
+
__str__(self)
+
click(self, event)
Called when a mouse key is pressed and self.focused is True.
Override this!
+
contains_point(self, y, x)
Test whether the point (with absolute coordinates) lies
+within the boundaries of this object.
+ +
destroy(self)
Called when the object is destroyed.
+Override this!
+ +
poke(self)
Called before drawing, even if invisible
+ +
resize(self, y, x, hei=None, wid=None)
Resize the widget
+ +
+Data and other attributes inherited from ranger.shared.EnvironmentAware:
+
env = None
+ +
+Data and other attributes inherited from ranger.shared.FileManagerAware:
+
fm = 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)
+
+
+Methods inherited from ranger.gui.curses_shortcuts.CursesShortcuts:
+
addnstr(self, *args)
+ +
addstr(self, *args)
+
color(self, keylist=None, *keys)
Change the colors from now on.
color_at(self, y, x, wid, keylist=None, *keys)
Change the colors at the specified position
color_reset(self)
Change the colors to the default colors
-
contains_point(self, y, x)
Test if the point lies within the boundaries of this object
+
+Data and other attributes inherited from ranger.shared.settings.SettingsAware:
+
settings = <ranger.ext.openstruct.OpenStruct object at 0x7f20a718ad90>
-
destroy(self)
Called when the object is destroyed.
-Override this!
+

+ + + + + +
 
+class ConsoleWithTab(Console)
    
Method resolution order:
+
ConsoleWithTab
+
Console
+
ranger.gui.widgets.Widget
+
ranger.gui.displayable.Displayable
+
ranger.shared.EnvironmentAware
+
ranger.shared.FileManagerAware
+
ranger.shared.Awareness
+
ranger.gui.curses_shortcuts.CursesShortcuts
+
ranger.shared.settings.SettingsAware
+
builtins.object
+
+
+Methods defined here:
+
tab(self, n=1)
-
poke(self)
Called before drawing, even if invisible
+
+Methods inherited from Console:
+
__init__(self, win)
-
resize(self, y, x, hei=None, wid=None)
Resize the widget
+
add_to_history(self)
+ +
clear(self)
+ +
close(self)
+ +
delete(self, mod)
+ +
delete_rest(self, direction)
+ +
delete_word(self)
+ +
draw(self)
+ +
execute(self)
+ +
finalize(self)
+ +
history_move(self, n)
+ +
init(self)
override this. Called directly after class change
+ +
move(self, relative=0, absolute=None)
+ +
on_line_change(self)
+ +
open(self, mode, string='')
+ +
paste(self)
+ +
press(self, key)
+ +
type_key(self, key)
+ +
+Data and other attributes inherited from Console:
+
commandlist = None
+ +
copy = ''
+ +
histories = None
+ +
history = None
+ +
last_cursor_mode = 1
+ +
mode = None
+ +
original_line = None
+ +
override = None
+ +
prompt = ':'
+ +
tab_deque = None
+ +
visible = False
-Data and other attributes inherited from ranger.gui.displayable.Displayable:
-
colorscheme = None
+Methods inherited from ranger.gui.displayable.Displayable:
+
__contains__(self, item)
Is item inside the boundaries?
+item can be an iterable like [y, x] or an object with x and y methods.
+ +
__nonzero__(self)
Always True
+ +
__str__(self)
-
focused = False
+
click(self, event)
Called when a mouse key is pressed and self.focused is True.
+Override this!
+ +
contains_point(self, y, x)
Test whether the point (with absolute coordinates) lies
+within the boundaries of this object.
+ +
destroy(self)
Called when the object is destroyed.
+Override this!
-
win = None
+
poke(self)
Called before drawing, even if invisible
+ +
resize(self, y, x, hei=None, wid=None)
Resize the widget
Data and other attributes inherited from ranger.shared.EnvironmentAware:
@@ -321,9 +456,21 @@ Data descriptors inherited from ranger.sh
__weakref__
list of weak references to the object (if defined)
+
+Methods inherited from ranger.gui.curses_shortcuts.CursesShortcuts:
+
addnstr(self, *args)
+ +
addstr(self, *args)
+ +
color(self, keylist=None, *keys)
Change the colors from now on.
+ +
color_at(self, y, x, wid, keylist=None, *keys)
Change the colors at the specified position
+ +
color_reset(self)
Change the colors to the default colors
+
Data and other attributes inherited from ranger.shared.settings.SettingsAware:
-
settings = <ranger.ext.openstruct.OpenStruct object at 0x154e450>
+
settings = <ranger.ext.openstruct.OpenStruct object at 0x7f20a718ad90>

@@ -331,7 +478,22 @@ Data and other attributes inherited from class OpenConsole(Console) - + + +
    
   The OpenConsole allows you to execute shell commands:
+!vim *         will run vim and open all files in the directory.
+ 
+There is a special syntax for more control:
+ 
+!d! mplayer    will run mplayer with flags (d means detached)
+!@ mplayer     will open the selected files with mplayer
+ 
+those two can be combinated:
+ 
+!d!@mplayer    will open the selection with a detached mplayer
+ 
+For a list of other flags than "d", look at the documentation
+of ranger.applications.
 
 
Method resolution order:
OpenConsole
Console
@@ -340,9 +502,16 @@ Data and other attributes inherited from ranger.shared.EnvironmentAware
ranger.shared.FileManagerAware
ranger.shared.Awareness
+
ranger.gui.curses_shortcuts.CursesShortcuts
ranger.shared.settings.SettingsAware
builtins.object
+
+Methods defined here:
+
execute(self)
+ +
init(self)
+
Data and other attributes defined here:
prompt = '!'
@@ -365,14 +534,10 @@ Methods inherited from Console
draw(self)
-
execute(self)
-
finalize(self)
history_move(self, n)
-
init(self)
override this. Called directly after class change
-
move(self, relative=0, absolute=None)
on_line_change(self)
@@ -401,8 +566,6 @@ Data and other attributes inherited from __nonzero__(self)
Always True
+
__str__(self)
+
click(self, event)
Called when a mouse key is pressed and self.focused is True.
Override this!
-
color(self, keylist=None, *keys)
Change the colors from now on.
- -
color_at(self, y, x, wid, keylist=None, *keys)
Change the colors at the specified position
- -
color_reset(self)
Change the colors to the default colors
- -
contains_point(self, y, x)
Test if the point lies within the boundaries of this object
+
contains_point(self, y, x)
Test whether the point (with absolute coordinates) lies
+within the boundaries of this object.
destroy(self)
Called when the object is destroyed.
Override this!
@@ -436,14 +596,6 @@ Override this!
resize(self, y, x, hei=None, wid=None)
Resize the widget
-
-Data and other attributes inherited from ranger.gui.displayable.Displayable:
-
colorscheme = None
- -
focused = False
- -
win = None
-
Data and other attributes inherited from ranger.shared.EnvironmentAware:
env = None
@@ -460,9 +612,21 @@ Data descriptors inherited from ranger.sh
__weakref__
list of weak references to the object (if defined)
+
+Methods inherited from ranger.gui.curses_shortcuts.CursesShortcuts:
+
addnstr(self, *args)
+ +
addstr(self, *args)
+ +
color(self, keylist=None, *keys)
Change the colors from now on.
+ +
color_at(self, y, x, wid, keylist=None, *keys)
Change the colors at the specified position
+ +
color_reset(self)
Change the colors to the default colors
+
Data and other attributes inherited from ranger.shared.settings.SettingsAware:
-
settings = <ranger.ext.openstruct.OpenStruct object at 0x154e450>
+
settings = <ranger.ext.openstruct.OpenStruct object at 0x7f20a718ad90>

@@ -470,16 +634,29 @@ Data and other attributes inherited from class QuickCommandConsole(CommandConsole) - + + +
    
   The QuickCommandConsole is essentially the same as the
+CommandConsole, and includes one additional feature:
+After each letter you type, it checks whether the command as it
+stands there could be executed in a meaningful way, and if it does,
+run it right away.
+ 
+Example:
+>cd ..
+As you type the last dot, The console will recognize what you mean
+and enter the parent directory saving you the time of pressing enter.
 
 
Method resolution order:
QuickCommandConsole
CommandConsole
+
ConsoleWithTab
Console
ranger.gui.widgets.Widget
ranger.gui.displayable.Displayable
ranger.shared.EnvironmentAware
ranger.shared.FileManagerAware
ranger.shared.Awareness
+
ranger.gui.curses_shortcuts.CursesShortcuts
ranger.shared.settings.SettingsAware
builtins.object
@@ -493,8 +670,10 @@ Data and other attributes defined here:
Methods inherited from CommandConsole:
-
execute(self)
+
execute(self, cmd=None)
+
+Methods inherited from ConsoleWithTab:
tab(self, n=1)
@@ -545,8 +724,6 @@ Data and other attributes inherited from __nonzero__(self)
Always True
+
__str__(self)
+
click(self, event)
Called when a mouse key is pressed and self.focused is True.
Override this!
-
color(self, keylist=None, *keys)
Change the colors from now on.
- -
color_at(self, y, x, wid, keylist=None, *keys)
Change the colors at the specified position
- -
color_reset(self)
Change the colors to the default colors
- -
contains_point(self, y, x)
Test if the point lies within the boundaries of this object
+
contains_point(self, y, x)
Test whether the point (with absolute coordinates) lies
+within the boundaries of this object.
destroy(self)
Called when the object is destroyed.
Override this!
@@ -580,14 +754,6 @@ Override this!
resize(self, y, x, hei=None, wid=None)
Resize the widget
-
-Data and other attributes inherited from ranger.gui.displayable.Displayable:
-
colorscheme = None
- -
focused = False
- -
win = None
-
Data and other attributes inherited from ranger.shared.EnvironmentAware:
env = None
@@ -604,15 +770,27 @@ Data descriptors inherited from ranger.sh
__weakref__
list of weak references to the object (if defined)
+
+Methods inherited from ranger.gui.curses_shortcuts.CursesShortcuts:
+
addnstr(self, *args)
+ +
addstr(self, *args)
+ +
color(self, keylist=None, *keys)
Change the colors from now on.
+ +
color_at(self, y, x, wid, keylist=None, *keys)
Change the colors at the specified position
+ +
color_reset(self)
Change the colors to the default colors
+
Data and other attributes inherited from ranger.shared.settings.SettingsAware:
-
settings = <ranger.ext.openstruct.OpenStruct object at 0x154e450>
+
settings = <ranger.ext.openstruct.OpenStruct object at 0x7f20a718ad90>

+class QuickOpenConsole(ConsoleWithTab)
 
-class QuickOpenConsole(Console)
    The QuickOpenConsole allows you to open files with
@@ -622,12 +800,14 @@ ie. the d-flag will run it detached from 
 
Method resolution order:
QuickOpenConsole
+
ConsoleWithTab
Console
ranger.gui.widgets.Widget
ranger.gui.displayable.Displayable
ranger.shared.EnvironmentAware
ranger.shared.FileManagerAware
ranger.shared.Awareness
+
ranger.gui.curses_shortcuts.CursesShortcuts
ranger.shared.settings.SettingsAware
builtins.object
@@ -641,6 +821,10 @@ Methods defined here:
Data and other attributes defined here:
prompt = 'open with: '
+
+Methods inherited from ConsoleWithTab:
+
tab(self, n=1)
+
Methods inherited from Console:
__init__(self, win)
@@ -673,8 +857,6 @@ Methods inherited from Console
press(self, key)
-
tab(self)
-
type_key(self, key)
@@ -691,8 +873,6 @@ Data and other attributes inherited from __nonzero__(self)
Always True
+
__str__(self)
+
click(self, event)
Called when a mouse key is pressed and self.focused is True.
Override this!
-
color(self, keylist=None, *keys)
Change the colors from now on.
- -
color_at(self, y, x, wid, keylist=None, *keys)
Change the colors at the specified position
- -
color_reset(self)
Change the colors to the default colors
- -
contains_point(self, y, x)
Test if the point lies within the boundaries of this object
+
contains_point(self, y, x)
Test whether the point (with absolute coordinates) lies
+within the boundaries of this object.
destroy(self)
Called when the object is destroyed.
Override this!
@@ -726,14 +903,6 @@ Override this!
resize(self, y, x, hei=None, wid=None)
Resize the widget
-
-Data and other attributes inherited from ranger.gui.displayable.Displayable:
-
colorscheme = None
- -
focused = False
- -
win = None
-
Data and other attributes inherited from ranger.shared.EnvironmentAware:
env = None
@@ -750,9 +919,21 @@ Data descriptors inherited from ranger.sh
__weakref__
list of weak references to the object (if defined)
+
+Methods inherited from ranger.gui.curses_shortcuts.CursesShortcuts:
+
addnstr(self, *args)
+ +
addstr(self, *args)
+ +
color(self, keylist=None, *keys)
Change the colors from now on.
+ +
color_at(self, y, x, wid, keylist=None, *keys)
Change the colors at the specified position
+ +
color_reset(self)
Change the colors to the default colors
+
Data and other attributes inherited from ranger.shared.settings.SettingsAware:
-
settings = <ranger.ext.openstruct.OpenStruct object at 0x154e450>
+
settings = <ranger.ext.openstruct.OpenStruct object at 0x7f20a718ad90>

@@ -769,6 +950,7 @@ Data and other attributes inherited from ranger.shared.EnvironmentAware
ranger.shared.FileManagerAware
ranger.shared.Awareness
+
ranger.gui.curses_shortcuts.CursesShortcuts
ranger.shared.settings.SettingsAware
builtins.object
@@ -832,8 +1014,6 @@ Data and other attributes inherited from __nonzero__(self)
Always True
+
__str__(self)
+
click(self, event)
Called when a mouse key is pressed and self.focused is True.
Override this!
-
color(self, keylist=None, *keys)
Change the colors from now on.
- -
color_at(self, y, x, wid, keylist=None, *keys)
Change the colors at the specified position
- -
color_reset(self)
Change the colors to the default colors
- -
contains_point(self, y, x)
Test if the point lies within the boundaries of this object
+
contains_point(self, y, x)
Test whether the point (with absolute coordinates) lies
+within the boundaries of this object.
destroy(self)
Called when the object is destroyed.
Override this!
@@ -867,14 +1044,6 @@ Override this!
resize(self, y, x, hei=None, wid=None)
Resize the widget
-
-Data and other attributes inherited from ranger.gui.displayable.Displayable:
-
colorscheme = None
- -
focused = False
- -
win = None
-
Data and other attributes inherited from ranger.shared.EnvironmentAware:
env = None
@@ -891,9 +1060,21 @@ Data descriptors inherited from ranger.sh
__weakref__
list of weak references to the object (if defined)
+
+Methods inherited from ranger.gui.curses_shortcuts.CursesShortcuts:
+
addnstr(self, *args)
+ +
addstr(self, *args)
+ +
color(self, keylist=None, *keys)
Change the colors from now on.
+ +
color_at(self, y, x, wid, keylist=None, *keys)
Change the colors at the specified position
+ +
color_reset(self)
Change the colors to the default colors
+
Data and other attributes inherited from ranger.shared.settings.SettingsAware:
-
settings = <ranger.ext.openstruct.OpenStruct object at 0x154e450>
+
settings = <ranger.ext.openstruct.OpenStruct object at 0x7f20a718ad90>

@@ -903,6 +1084,7 @@ Data and other attributes inherited from       
  DEFAULT_HISTORY = 0
+OPEN_HISTORY = 3
QUICKOPEN_HISTORY = 2
SEARCH_HISTORY = 1
\ No newline at end of file diff --git a/doc/pydoc/ranger.gui.widgets.console_mode.html b/doc/pydoc/ranger.gui.widgets.console_mode.html new file mode 100644 index 00000000..c62ed61c --- /dev/null +++ b/doc/pydoc/ranger.gui.widgets.console_mode.html @@ -0,0 +1,37 @@ + +Python: module ranger.gui.widgets.console_mode + + + + + +
 
+ 
ranger.gui.widgets.console_mode		index
/home/hut/work/ranger/ranger/gui/widgets/console_mode.py
+

+

+ + + + + +
 
+Functions
       
all_modes(mode)
Returns a generator containing all valid modes.
+
is_valid_mode(mode)
Returns True or False depending on whether the mode is valid or not.
+
mode_to_class(mode)
Associates modes with the actual classes
+from ranger.gui.widgets.console.
+

+ + + + + +
 
+Data
       COMMAND = 1
+COMMAND_QUICK = 2
+DEFAULT = 0
+OPEN = 3
+OPEN_QUICK = 4
+SEARCH = 5
+ \ No newline at end of file diff --git a/doc/pydoc/ranger.gui.widgets.html b/doc/pydoc/ranger.gui.widgets.html index 7c93bf98..38ff3224 100644 --- a/doc/pydoc/ranger.gui.widgets.html +++ b/doc/pydoc/ranger.gui.widgets.html @@ -17,13 +17,14 @@ Package Contents         -
console
-filelist
-		filelistcontainer
-notify
-		process_manager
+
browsercolumn
+browserview
+		console
+console_mode
+		pager
statusbar
-		titlebar
+		taskview
+titlebar

@@ -32,7 +33,7 @@
ranger.shared.EnvironmentAware
ranger.shared.FileManagerAware
ranger.shared.Awareness
+
ranger.gui.curses_shortcuts.CursesShortcuts
ranger.shared.settings.SettingsAware
builtins.object
@@ -67,22 +69,20 @@ item can be an iterable like [y, x] or&n
__nonzero__(self)
Always True
+
__str__(self)
+
click(self, event)
Called when a mouse key is pressed and self.focused is True.
Override this!
-
color(self, keylist=None, *keys)
Change the colors from now on.
- -
color_at(self, y, x, wid, keylist=None, *keys)
Change the colors at the specified position
- -
color_reset(self)
Change the colors to the default colors
- -
contains_point(self, y, x)
Test if the point lies within the boundaries of this object
+
contains_point(self, y, x)
Test whether the point (with absolute coordinates) lies
+within the boundaries of this object.
destroy(self)
Called when the object is destroyed.
Override this!
-
draw(self)
Draw displayable.  Called on every main iteration if the object
-is visible.  Override this!
+
draw(self)
Draw the object. Called on every main iteration if visible.
+Containers should call draw() on their contained objects here.
+Override this!
finalize(self)
Called after every displayable is done drawing.
Override this!
@@ -94,16 +94,6 @@ Override this!
resize(self, y, x, hei=None, wid=None)
Resize the widget
-
-Data and other attributes inherited from ranger.gui.displayable.Displayable:
-
colorscheme = None
- -
focused = False
- -
visible = True
- -
win = None
-
Data and other attributes inherited from ranger.shared.EnvironmentAware:
env = None
@@ -120,9 +110,21 @@ Data descriptors inherited from ranger.sh
__weakref__
list of weak references to the object (if defined)
+
+Methods inherited from ranger.gui.curses_shortcuts.CursesShortcuts:
+
addnstr(self, *args)
+ +
addstr(self, *args)
+ +
color(self, keylist=None, *keys)
Change the colors from now on.
+ +
color_at(self, y, x, wid, keylist=None, *keys)
Change the colors at the specified position
+ +
color_reset(self)
Change the colors to the default colors
+
Data and other attributes inherited from ranger.shared.settings.SettingsAware:
-
settings = <ranger.ext.openstruct.OpenStruct object at 0x154e450>
+
settings = <ranger.ext.openstruct.OpenStruct object at 0x7f20a718ad90>
       
-
ranger.gui.displayable.Displayable(ranger.shared.EnvironmentAware, ranger.shared.FileManagerAware, ranger.shared.settings.SettingsAware) +
ranger.gui.displayable.Displayable(ranger.shared.EnvironmentAware, ranger.shared.FileManagerAware, ranger.gui.curses_shortcuts.CursesShortcuts)
Widget @@ -55,6 +56,7 @@ classification of widgets.
 
\ No newline at end of file diff --git a/doc/pydoc/ranger.gui.widgets.pager.html b/doc/pydoc/ranger.gui.widgets.pager.html new file mode 100644 index 00000000..e6df29e6 --- /dev/null +++ b/doc/pydoc/ranger.gui.widgets.pager.html @@ -0,0 +1,133 @@ + +Python: module ranger.gui.widgets.pager + + + + + +
 
+ 
ranger.gui.widgets.pager		index
/home/hut/work/ranger/ranger/gui/widgets/pager.py
+

The pager displays text and allows you to scroll inside it.

+

+ + + + + +
 
+Classes
       
+
ranger.gui.widgets.Widget(ranger.gui.displayable.Displayable) +
+
+
Pager +
+
+
+

+ + + + + +
 
+class Pager(ranger.gui.widgets.Widget)
    
Method resolution order:
+
Pager
+
ranger.gui.widgets.Widget
+
ranger.gui.displayable.Displayable
+
ranger.shared.EnvironmentAware
+
ranger.shared.FileManagerAware
+
ranger.shared.Awareness
+
ranger.gui.curses_shortcuts.CursesShortcuts
+
ranger.shared.settings.SettingsAware
+
builtins.object
+
+
+Methods defined here:
+
__init__(self, win, embedded=False)
+ +
click(self, event)
+ +
close(self)
+ +
draw(self)
+ +
move(self, relative=0, absolute=None, pages=False)
+ +
move_horizontal(self, relative=0, absolute=None)
+ +
open(self)
+ +
press(self, key)
+ +
set_source(self, source, strip=False)
+ +
+Data and other attributes defined here:
+
old_scroll_begin = 0
+ +
old_source = None
+ +
old_startx = 0
+ +
source = None
+ +
source_is_stream = False
+ +
+Methods inherited from ranger.gui.displayable.Displayable:
+
__contains__(self, item)
Is item inside the boundaries?
+item can be an iterable like [y, x] or an object with x and y methods.
+ +
__nonzero__(self)
Always True
+ +
__str__(self)
+ +
contains_point(self, y, x)
Test whether the point (with absolute coordinates) lies
+within the boundaries of this object.
+ +
destroy(self)
Called when the object is destroyed.
+Override this!
+ +
finalize(self)
Called after every displayable is done drawing.
+Override this!
+ +
poke(self)
Called before drawing, even if invisible
+ +
resize(self, y, x, hei=None, wid=None)
Resize the widget
+ +
+Data and other attributes inherited from ranger.shared.EnvironmentAware:
+
env = None
+ +
+Data and other attributes inherited from ranger.shared.FileManagerAware:
+
fm = 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)
+
+
+Methods inherited from ranger.gui.curses_shortcuts.CursesShortcuts:
+
addnstr(self, *args)
+ +
addstr(self, *args)
+ +
color(self, keylist=None, *keys)
Change the colors from now on.
+ +
color_at(self, y, x, wid, keylist=None, *keys)
Change the colors at the specified position
+ +
color_reset(self)
Change the colors to the default colors
+ +
+Data and other attributes inherited from ranger.shared.settings.SettingsAware:
+
settings = <ranger.ext.openstruct.OpenStruct object at 0x7f20a718ad90>
+ +

+ \ No newline at end of file diff --git a/doc/pydoc/ranger.gui.widgets.statusbar.html b/doc/pydoc/ranger.gui.widgets.statusbar.html index 9144105d..52d245b8 100644 --- a/doc/pydoc/ranger.gui.widgets.statusbar.html +++ b/doc/pydoc/ranger.gui.widgets.statusbar.html @@ -9,9 +9,11 @@  
ranger.gui.widgets.statusbarindex
/home/hut/work/ranger/ranger/gui/widgets/statusbar.py -

The StatusBar displays information about the currently selected file
-in the same form as the "ls -l" command on the left side, and
-some additional info about the current directory on the right side.

+

The statusbar displays information about the current file and directory.
+ 
+On the left side, there is a display similar to what "ls -l" would
+print for the current file.  The right side shows directory information
+such as the space used by all the files in this directory.

@@ -20,6 +22,12 @@ some additional info about the current directory&n
       
+
builtins.object +
+
+
Message +
+
ranger.gui.widgets.Widget(ranger.gui.displayable.Displayable)
@@ -31,12 +39,42 @@ some additional info about the current directory&n + + +
 
+class Message(builtins.object)
    Methods defined here:
+
__init__(self, text, duration, bad)
+ +
is_alive(self)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+Data and other attributes defined here:
+
bad = False
+ +
elapse = None
+ +
text = None
+ +

+ + + - +
 
class StatusBar(ranger.gui.widgets.Widget)
   The StatusBar displays information about the currently selected file
-in the same form as the "ls -l" command on the left side, and
-some additional info about the current directory on the right side.
 
The statusbar displays information about the current file and directory.
+ 
+On the left side, there is a display similar to what "ls -l" would
+print for the current file.  The right side shows directory information
+such as the space used by all the files in this directory.
 
 
Method resolution order:
StatusBar
@@ -45,26 +83,31 @@ some additional info about the current directory&n
ranger.shared.EnvironmentAware
ranger.shared.FileManagerAware
ranger.shared.Awareness
+
ranger.gui.curses_shortcuts.CursesShortcuts
ranger.shared.settings.SettingsAware
builtins.object
Methods defined here:
-
__init__(self, win, filelist=None)
+
__init__(self, win, column=None)
draw(self)
Draw the statusbar
+
notify(self, text, duration=4, bad=False)
+
Data and other attributes defined here:
groups = {}
-
old_cf = None
+
hint = None
-
old_mtime = None
+
msg = None
+ +
old_cf = None
-
old_wid = None
+
old_hint = None
-
override = None
+
old_mtime = None
owners = {}
@@ -75,22 +118,19 @@ Data and other attributes defined here:
Methods inherited from ranger.gui.displayable.Displayable:
__contains__(self, item)
Is item inside the boundaries?
-item can be an iterable like [y, x] or an object with x and y methods.
+item can be an iterable like [y, x] or an object with x and y methods.
__nonzero__(self)
Always True
+
__str__(self)
+
click(self, event)
Called when a mouse key is pressed and self.focused is True.
Override this!
-
color(self, keylist=None, *keys)
Change the colors from now on.
+
contains_point(self, y, x)
Test whether the point (with absolute coordinates) lies
+within the boundaries of this object.
-
color_at(self, y, x, wid, keylist=None, *keys)
Change the colors at the specified position
- -
color_reset(self)
Change the colors to the default colors
- -
contains_point(self, y, x)
Test if the point lies within the boundaries of this object
- -
destroy(self)
Called when the object is destroyed.
+
destroy(self)
Called when the object is destroyed.
Override this!
finalize(self)
Called after every displayable is done drawing.
@@ -103,16 +143,6 @@ Override this!
resize(self, y, x, hei=None, wid=None)
Resize the widget
-
-Data and other attributes inherited from ranger.gui.displayable.Displayable:
-
colorscheme = None
- -
focused = False
- -
visible = True
- -
win = None
-
Data and other attributes inherited from ranger.shared.EnvironmentAware:
env = None
@@ -129,9 +159,21 @@ Data descriptors inherited from ranger.sh
__weakref__
list of weak references to the object (if defined)
+
+Methods inherited from ranger.gui.curses_shortcuts.CursesShortcuts:
+
addnstr(self, *args)
+ +
addstr(self, *args)
+ +
color(self, keylist=None, *keys)
Change the colors from now on.
+ +
color_at(self, y, x, wid, keylist=None, *keys)
Change the colors at the specified position
+ +
color_reset(self)
Change the colors to the default colors
+
Data and other attributes inherited from ranger.shared.settings.SettingsAware:
-
settings = <ranger.ext.openstruct.OpenStruct object at 0x154e450>
+
settings = <ranger.ext.openstruct.OpenStruct object at 0x7f20a718ad90>

@@ -160,5 +202,9 @@ When 'seconds' is not passed in, convert the& Convert a time tuple to a string according to a format specification.
See the library reference manual for formatting codes. When the time tuple
is not present, current time as returned by localtime() is used. +
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.
\ No newline at end of file diff --git a/doc/pydoc/ranger.gui.widgets.taskview.html b/doc/pydoc/ranger.gui.widgets.taskview.html new file mode 100644 index 00000000..548d55d9 --- /dev/null +++ b/doc/pydoc/ranger.gui.widgets.taskview.html @@ -0,0 +1,151 @@ + +Python: module ranger.gui.widgets.taskview + + + + + +
 
+ 
ranger.gui.widgets.taskview		index
/home/hut/work/ranger/ranger/gui/widgets/taskview.py
+

The TaskView allows you to modify what the loader is doing.

+

+ + + + + +
 
+Modules
       
curses
+

+ + + + + +
 
+Classes
       
+
ranger.ext.accumulator.Accumulator(builtins.object) +
+
+
TaskView(ranger.gui.widgets.Widget, ranger.ext.accumulator.Accumulator) +
+
+
ranger.gui.widgets.Widget(ranger.gui.displayable.Displayable) +
+
+
TaskView(ranger.gui.widgets.Widget, ranger.ext.accumulator.Accumulator) +
+
+
+

+ + + + + +
 
+class TaskView(ranger.gui.widgets.Widget, ranger.ext.accumulator.Accumulator)
    
Method resolution order:
+
TaskView
+
ranger.gui.widgets.Widget
+
ranger.gui.displayable.Displayable
+
ranger.shared.EnvironmentAware
+
ranger.shared.FileManagerAware
+
ranger.shared.Awareness
+
ranger.gui.curses_shortcuts.CursesShortcuts
+
ranger.shared.settings.SettingsAware
+
ranger.ext.accumulator.Accumulator
+
builtins.object
+
+
+Methods defined here:
+
__init__(self, win)
+ +
draw(self)
+ +
get_list(self)
+ +
press(self, key)
+ +
task_move(self, absolute, i=None)
+ +
task_remove(self, i=None)
+ +
+Data and other attributes defined here:
+
old_lst = None
+ +
+Methods inherited from ranger.gui.displayable.Displayable:
+
__contains__(self, item)
Is item inside the boundaries?
+item can be an iterable like [y, x] or an object with x and y methods.
+ +
__nonzero__(self)
Always True
+ +
__str__(self)
+ +
click(self, event)
Called when a mouse key is pressed and self.focused is True.
+Override this!
+ +
contains_point(self, y, x)
Test whether the point (with absolute coordinates) lies
+within the boundaries of this object.
+ +
destroy(self)
Called when the object is destroyed.
+Override this!
+ +
finalize(self)
Called after every displayable is done drawing.
+Override this!
+ +
poke(self)
Called before drawing, even if invisible
+ +
resize(self, y, x, hei=None, wid=None)
Resize the widget
+ +
+Data and other attributes inherited from ranger.shared.EnvironmentAware:
+
env = None
+ +
+Data and other attributes inherited from ranger.shared.FileManagerAware:
+
fm = 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)
+
+
+Methods inherited from ranger.gui.curses_shortcuts.CursesShortcuts:
+
addnstr(self, *args)
+ +
addstr(self, *args)
+ +
color(self, keylist=None, *keys)
Change the colors from now on.
+ +
color_at(self, y, x, wid, keylist=None, *keys)
Change the colors at the specified position
+ +
color_reset(self)
Change the colors to the default colors
+ +
+Data and other attributes inherited from ranger.shared.settings.SettingsAware:
+
settings = <ranger.ext.openstruct.OpenStruct object at 0x7f20a718ad90>
+ +
+Methods inherited from ranger.ext.accumulator.Accumulator:
+
correct_pointer(self)
+ +
get_height(self)
OVERRIDE THIS
+ +
move(self, relative=0, absolute=None, pages=False)
+ +
move_to_obj(self, arg, attr=None)
+ +
pointer_is_synced(self)
+ +
sync_index(self, **kw)
+ +

+ \ No newline at end of file diff --git a/doc/pydoc/ranger.gui.widgets.titlebar.html b/doc/pydoc/ranger.gui.widgets.titlebar.html index c7052477..fc12df2a 100644 --- a/doc/pydoc/ranger.gui.widgets.titlebar.html +++ b/doc/pydoc/ranger.gui.widgets.titlebar.html @@ -9,8 +9,9 @@  
ranger.gui.widgets.titlebarindex
/home/hut/work/ranger/ranger/gui/widgets/titlebar.py -

The TitleBar widget displays the current path and some other useful
-information.

+

The titlebar is the widget at the top, giving you broad orientation.
+ 
+It displays the current path among other things.

@@ -19,19 +20,6 @@ information.

       
-
builtins.list(builtins.object) -
-
-
BarSide -
-
-
builtins.object -
-
-
Bar -
ColoredString -
-
ranger.gui.widgets.Widget(ranger.gui.displayable.Displayable)
@@ -43,181 +31,6 @@ information.

- - -
 
-class Bar(builtins.object)
    Methods defined here:
-
__init__(self)
- -
add(self, *a, **kw)
- -
addright(self, *a, **kw)
- -
combine(self)
- -
fill_gap(self, char, wid, gapwidth=False)
- -
fixedsize(self)
- -
shrink_by_cutting(self, wid)
- -
shrink_by_removing(self, wid)
- -
sumsize(self)
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables (if defined)
-
-
__weakref__
-
list of weak references to the object (if defined)
-
-
-Data and other attributes defined here:
-
gap = None
- -
left = None
- -
right = None
- -

- - - - - -
 
-class BarSide(builtins.list)
    
Method resolution order:
-
BarSide
-
builtins.list
-
builtins.object
-
-
-Methods defined here:
-
add(self, string, *lst, **kw)
- -
fixedsize(self)
- -
nonfixed_items(self)
- -
sumsize(self)
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables (if defined)
-
-
__weakref__
-
list of weak references to the object (if defined)
-
-
-Methods inherited from builtins.list:
-
__add__(...)
x.__add__(y) <==> x+y
- -
__contains__(...)
x.__contains__(y) <==> y in x
- -
__delitem__(...)
x.__delitem__(y) <==> del x[y]
- -
__eq__(...)
x.__eq__(y) <==> x==y
- -
__ge__(...)
x.__ge__(y) <==> x>=y
- -
__getattribute__(...)
x.__getattribute__('name') <==> x.name
- -
__getitem__(...)
x.__getitem__(y) <==> x[y]
- -
__gt__(...)
x.__gt__(y) <==> x>y
- -
__iadd__(...)
x.__iadd__(y) <==> x+=y
- -
__imul__(...)
x.__imul__(y) <==> x*=y
- -
__init__(...)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
- -
__iter__(...)
x.__iter__() <==> iter(x)
- -
__le__(...)
x.__le__(y) <==> x<=y
- -
__len__(...)
x.__len__() <==> len(x)
- -
__lt__(...)
x.__lt__(y) <==> x<y
- -
__mul__(...)
x.__mul__(n) <==> x*n
- -
__ne__(...)
x.__ne__(y) <==> x!=y
- -
__repr__(...)
x.__repr__() <==> repr(x)
- -
__reversed__(...)
L.__reversed__() -- return a reverse iterator over the list
- -
__rmul__(...)
x.__rmul__(n) <==> n*x
- -
__setitem__(...)
x.__setitem__(i, y) <==> x[i]=y
- -
__sizeof__(...)
L.__sizeof__() -- size of L in memory, in bytes
- -
append(...)
L.append(object) -- append object to end
- -
count(...)
L.count(value) -> integer -- return number of occurrences of value
- -
extend(...)
L.extend(iterable) -- extend list by appending elements from the iterable
- -
index(...)
L.index(value, [start, [stop]]) -> integer -- return first index of value.
-Raises ValueError if the value is not present.
- -
insert(...)
L.insert(index, object) -- insert object before index
- -
pop(...)
L.pop([index]) -> item -- remove and return item at index (default last).
-Raises IndexError if list is empty or index is out of range.
- -
remove(...)
L.remove(value) -- remove first occurrence of value.
-Raises ValueError if the value is not present.
- -
reverse(...)
L.reverse() -- reverse *IN PLACE*
- -
sort(...)
L.sort(key=None, reverse=False) -- stable sort *IN PLACE*
- -
-Data and other attributes inherited from builtins.list:
-
__hash__ = None
- -
__new__ = <built-in method __new__ of type object at 0x7f327d9523a0>
T.__new__(S, ...) -> a new object with type S, a subtype of T
- -

- - - - - -
 
-class ColoredString(builtins.object)
    Methods defined here:
-
__init__(self, string, *lst)
- -
__len__(self)
- -
__str__(self)
- -
cut_off(self, n)
- -
cut_off_to(self, n)
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables (if defined)
-
-
__weakref__
-
list of weak references to the object (if defined)
-
-
-Data and other attributes defined here:
-
fixed = False
- -

- - - @@ -228,6 +41,7 @@ Data and other attributes defined here:
ranger.shared.EnvironmentAware
ranger.shared.FileManagerAware
ranger.shared.Awareness
+
ranger.gui.curses_shortcuts.CursesShortcuts
ranger.shared.settings.SettingsAware
builtins.object
@@ -250,24 +64,21 @@ Data and other attributes defined here:
Methods inherited from ranger.gui.displayable.Displayable:
__contains__(self, item)
Is item inside the boundaries?
-item can be an iterable like [y, x] or an object with x and y methods.
+item can be an iterable like [y, x] or an object with x and y methods.
__init__(self, win, env=None, fm=None, settings=None)
__nonzero__(self)
Always True
+
__str__(self)
+
click(self, event)
Called when a mouse key is pressed and self.focused is True.
Override this!
-
color(self, keylist=None, *keys)
Change the colors from now on.
- -
color_at(self, y, x, wid, keylist=None, *keys)
Change the colors at the specified position
+
contains_point(self, y, x)
Test whether the point (with absolute coordinates) lies
+within the boundaries of this object.
-
color_reset(self)
Change the colors to the default colors
- -
contains_point(self, y, x)
Test if the point lies within the boundaries of this object
- -
destroy(self)
Called when the object is destroyed.
+
destroy(self)
Called when the object is destroyed.
Override this!
finalize(self)
Called after every displayable is done drawing.
@@ -280,16 +91,6 @@ Override this!
resize(self, y, x, hei=None, wid=None)
Resize the widget
-
-Data and other attributes inherited from ranger.gui.displayable.Displayable:
-
colorscheme = None
- -
focused = False
- -
visible = True
- -
win = None
-
Data and other attributes inherited from ranger.shared.EnvironmentAware:
env = None
@@ -306,9 +107,21 @@ Data descriptors inherited from ranger.sh
__weakref__
list of weak references to the object (if defined)
+
+Methods inherited from ranger.gui.curses_shortcuts.CursesShortcuts:
+
addnstr(self, *args)
+ +
addstr(self, *args)
+ +
color(self, keylist=None, *keys)
Change the colors from now on.
+ +
color_at(self, y, x, wid, keylist=None, *keys)
Change the colors at the specified position
+ +
color_reset(self)
Change the colors to the default colors
+
Data and other attributes inherited from ranger.shared.settings.SettingsAware:
-
settings = <ranger.ext.openstruct.OpenStruct object at 0x154e450>
+
settings = <ranger.ext.openstruct.OpenStruct object at 0x7f20a718ad90>
 
class TitleBar(ranger.gui.widgets.Widget)
    

diff --git a/doc/pydoc/ranger.html b/doc/pydoc/ranger.html index 0fd5ba08..b55b09f6 100644 --- a/doc/pydoc/ranger.html +++ b/doc/pydoc/ranger.html @@ -17,27 +17,21 @@ Package Contents -
       
actions
+
__main__
+actions
applications
colorschemes (package)
commands
container (package)
defaults (package)
-		ext (package)
-fm
+ext (package)
+		fm
fsobject (package)
-		gui (package)
-shared (package)
+gui (package)
+keyapi
+		shared (package)

- - - - -
 
-Functions
       
main()
initialize objects and run the filemanager
-

- diff --git a/doc/pydoc/ranger.keyapi.html b/doc/pydoc/ranger.keyapi.html new file mode 100644 index 00000000..dfb97892 --- /dev/null +++ b/doc/pydoc/ranger.keyapi.html @@ -0,0 +1,413 @@ + +Python: module ranger.keyapi + + + +
 
Data
+ +
 
+ 
ranger.keyapi		index
/home/hut/work/ranger/ranger/keyapi.py
+

+

+ + + + + +
 
+Modules
       
ranger.gui.widgets.console_mode
+

+ + + + + +
 
+Classes
       
+
builtins.object +
+
+
Wrapper +
nwrap +
+
+
+

+ + + + + +
 
+class Wrapper(builtins.object)
    Methods defined here:
+
__getattr__(self, attr)
+ +
__init__(self, firstattr)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ + + + + + + +
 
+class nwrap(builtins.object)
   # Another wrapper for common actions which use a numerical argument:
 
 Static methods defined here:
+
move(relative=0, absolute=None, pages=False)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ + + + + +
 
+Functions
       
baudrate(...)
+
beep(...)
+
can_change_color(...)
+
cbreak(...)
+
color_content(...)
+
color_pair(...)
+
curs_set(...)
+
def_prog_mode(...)
+
def_shell_mode(...)
+
delay_output(...)
+
doupdate(...)
+
echo(...)
+
endwin(...)
+
erasechar(...)
+
filter(...)
+
flash(...)
+
flushinp(...)
+
getmouse(...)
+
getsyx(...)
+
getwin(...)
+
halfdelay(...)
+
has_colors(...)
+
has_ic(...)
+
has_il(...)
+
has_key(...)
+
init_color(...)
+
init_pair(...)
+
intrflush(...)
+
is_term_resized(...)
+
isendwin(...)
+
keyname(...)
+
killchar(...)
+
longname(...)
+
make_abbreviations(command_list)
+
meta(...)
+
mouseinterval(...)
+
mousemask(...)
+
napms(...)
+
newpad(...)
+
newwin(...)
+
nl(...)
+
nocbreak(...)
+
noecho(...)
+
nonl(...)
+
noqiflush(...)
+
noraw(...)
+
pair_content(...)
+
pair_number(...)
+
putp(...)
+
qiflush(...)
+
raw(...)
+
reset_prog_mode(...)
+
reset_shell_mode(...)
+
resetty(...)
+
resize_term(...)
+
resizeterm(...)
+
savetty(...)
+
setsyx(...)
+
setupterm(...)
+
termattrs(...)
+
termname(...)
+
tigetflag(...)
+
tigetnum(...)
+
tigetstr(...)
+
tparm(...)
+
typeahead(...)
+
ungetch(...)
+
ungetmouse(...)
+
use_default_colors(...)
+
use_env(...)
+

+ + + + + +
 
+Data
       ACK = 6
+ALLOWED_BOOKMARK_KEYS = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789`'"
+ALL_MOUSE_EVENTS = 134217727
+A_ALTCHARSET = 4194304
+A_ATTRIBUTES = 4294967040
+A_BLINK = 524288
+A_BOLD = 2097152
+A_CHARTEXT = 255
+A_COLOR = 65280
+A_DIM = 1048576
+A_HORIZONTAL = 33554432
+A_INVIS = 8388608
+A_LEFT = 67108864
+A_LOW = 134217728
+A_NORMAL = 0
+A_PROTECT = 16777216
+A_REVERSE = 262144
+A_RIGHT = 268435456
+A_STANDOUT = 65536
+A_TOP = 536870912
+A_UNDERLINE = 131072
+A_VERTICAL = 1073741824
+BEL = 7
+BS = 8
+BUTTON1_CLICKED = 4
+BUTTON1_DOUBLE_CLICKED = 8
+BUTTON1_PRESSED = 2
+BUTTON1_RELEASED = 1
+BUTTON1_TRIPLE_CLICKED = 16
+BUTTON2_CLICKED = 256
+BUTTON2_DOUBLE_CLICKED = 512
+BUTTON2_PRESSED = 128
+BUTTON2_RELEASED = 64
+BUTTON2_TRIPLE_CLICKED = 1024
+BUTTON3_CLICKED = 16384
+BUTTON3_DOUBLE_CLICKED = 32768
+BUTTON3_PRESSED = 8192
+BUTTON3_RELEASED = 4096
+BUTTON3_TRIPLE_CLICKED = 65536
+BUTTON4_CLICKED = 1048576
+BUTTON4_DOUBLE_CLICKED = 2097152
+BUTTON4_PRESSED = 524288
+BUTTON4_RELEASED = 262144
+BUTTON4_TRIPLE_CLICKED = 4194304
+BUTTON_ALT = 67108864
+BUTTON_CTRL = 16777216
+BUTTON_SHIFT = 33554432
+CAN = 24
+COLOR_BLACK = 0
+COLOR_BLUE = 4
+COLOR_CYAN = 6
+COLOR_GREEN = 2
+COLOR_MAGENTA = 5
+COLOR_RED = 1
+COLOR_WHITE = 7
+COLOR_YELLOW = 3
+CR = 13
+DC1 = 17
+DC2 = 18
+DC3 = 19
+DC4 = 20
+DEL = 127
+DLE = 16
+EM = 25
+ENQ = 5
+EOT = 4
+ERR = -1
+ESC = 27
+ETB = 23
+ETX = 3
+FF = 12
+FS = 28
+GS = 29
+HT = 9
+KEY_A1 = 348
+KEY_A3 = 349
+KEY_B2 = 350
+KEY_BACKSPACE = 263
+KEY_BEG = 354
+KEY_BREAK = 257
+KEY_BTAB = 353
+KEY_C1 = 351
+KEY_C3 = 352
+KEY_CANCEL = 355
+KEY_CATAB = 342
+KEY_CLEAR = 333
+KEY_CLOSE = 356
+KEY_COMMAND = 357
+KEY_COPY = 358
+KEY_CREATE = 359
+KEY_CTAB = 341
+KEY_DC = 330
+KEY_DL = 328
+KEY_DOWN = 258
+KEY_EIC = 332
+KEY_END = 360
+KEY_ENTER = 343
+KEY_EOL = 335
+KEY_EOS = 334
+KEY_EXIT = 361
+KEY_F0 = 264
+KEY_F1 = 265
+KEY_F10 = 274
+KEY_F11 = 275
+KEY_F12 = 276
+KEY_F13 = 277
+KEY_F14 = 278
+KEY_F15 = 279
+KEY_F16 = 280
+KEY_F17 = 281
+KEY_F18 = 282
+KEY_F19 = 283
+KEY_F2 = 266
+KEY_F20 = 284
+KEY_F21 = 285
+KEY_F22 = 286
+KEY_F23 = 287
+KEY_F24 = 288
+KEY_F25 = 289
+KEY_F26 = 290
+KEY_F27 = 291
+KEY_F28 = 292
+KEY_F29 = 293
+KEY_F3 = 267
+KEY_F30 = 294
+KEY_F31 = 295
+KEY_F32 = 296
+KEY_F33 = 297
+KEY_F34 = 298
+KEY_F35 = 299
+KEY_F36 = 300
+KEY_F37 = 301
+KEY_F38 = 302
+KEY_F39 = 303
+KEY_F4 = 268
+KEY_F40 = 304
+KEY_F41 = 305
+KEY_F42 = 306
+KEY_F43 = 307
+KEY_F44 = 308
+KEY_F45 = 309
+KEY_F46 = 310
+KEY_F47 = 311
+KEY_F48 = 312
+KEY_F49 = 313
+KEY_F5 = 269
+KEY_F50 = 314
+KEY_F51 = 315
+KEY_F52 = 316
+KEY_F53 = 317
+KEY_F54 = 318
+KEY_F55 = 319
+KEY_F56 = 320
+KEY_F57 = 321
+KEY_F58 = 322
+KEY_F59 = 323
+KEY_F6 = 270
+KEY_F60 = 324
+KEY_F61 = 325
+KEY_F62 = 326
+KEY_F63 = 327
+KEY_F7 = 271
+KEY_F8 = 272
+KEY_F9 = 273
+KEY_FIND = 362
+KEY_HELP = 363
+KEY_HOME = 262
+KEY_IC = 331
+KEY_IL = 329
+KEY_LEFT = 260
+KEY_LL = 347
+KEY_MARK = 364
+KEY_MAX = 511
+KEY_MESSAGE = 365
+KEY_MIN = 257
+KEY_MOUSE = 409
+KEY_MOVE = 366
+KEY_NEXT = 367
+KEY_NPAGE = 338
+KEY_OPEN = 368
+KEY_OPTIONS = 369
+KEY_PPAGE = 339
+KEY_PREVIOUS = 370
+KEY_PRINT = 346
+KEY_REDO = 371
+KEY_REFERENCE = 372
+KEY_REFRESH = 373
+KEY_REPLACE = 374
+KEY_RESET = 345
+KEY_RESIZE = 410
+KEY_RESTART = 375
+KEY_RESUME = 376
+KEY_RIGHT = 261
+KEY_SAVE = 377
+KEY_SBEG = 378
+KEY_SCANCEL = 379
+KEY_SCOMMAND = 380
+KEY_SCOPY = 381
+KEY_SCREATE = 382
+KEY_SDC = 383
+KEY_SDL = 384
+KEY_SELECT = 385
+KEY_SEND = 386
+KEY_SEOL = 387
+KEY_SEXIT = 388
+KEY_SF = 336
+KEY_SFIND = 389
+KEY_SHELP = 390
+KEY_SHOME = 391
+KEY_SIC = 392
+KEY_SLEFT = 393
+KEY_SMESSAGE = 394
+KEY_SMOVE = 395
+KEY_SNEXT = 396
+KEY_SOPTIONS = 397
+KEY_SPREVIOUS = 398
+KEY_SPRINT = 399
+KEY_SR = 337
+KEY_SREDO = 400
+KEY_SREPLACE = 401
+KEY_SRESET = 344
+KEY_SRIGHT = 402
+KEY_SRSUME = 403
+KEY_SSAVE = 404
+KEY_SSUSPEND = 405
+KEY_STAB = 340
+KEY_SUNDO = 406
+KEY_SUSPEND = 407
+KEY_UNDO = 408
+KEY_UP = 259
+LF = 10
+NAK = 21
+NL = 10
+NUL = 0
+OK = 0
+RANGERDIR = '/home/hut/work/ranger/ranger'
+REPORT_MOUSE_POSITION = 134217728
+RS = 30
+SI = 15
+SO = 14
+SOH = 1
+SP = 32
+STX = 2
+SUB = 26
+SYN = 22
+TAB = 9
+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', ...]
+fm = <ranger.keyapi.Wrapper object at 0x7f20a5b429d0>
+version = b'2.2'
+wdg = <ranger.keyapi.Wrapper object at 0x7f20a5b42a10>
+ \ No newline at end of file diff --git a/doc/pydoc/ranger.shared.settings.html b/doc/pydoc/ranger.shared.settings.html index ec661e76..46f01956 100644 --- a/doc/pydoc/ranger.shared.settings.html +++ b/doc/pydoc/ranger.shared.settings.html @@ -41,7 +41,7 @@

Data and other attributes defined here:
-
settings = <ranger.ext.openstruct.OpenStruct object at 0x154e450>
+
settings = <ranger.ext.openstruct.OpenStruct object at 0x7f20a718ad90>

@@ -50,5 +50,5 @@ Data and other attributes defined here:
Data -
       ALLOWED_SETTINGS = ['show_hidden', 'scroll_offset', 'directories_first', 'sort', 'reverse', 'preview_files', 'max_history_size', 'colorscheme', 'collapse_preview', 'auto_load_preview', 'max_dirsize_for_autopreview', 'apps', 'keys']
+ALLOWED_SETTINGS = ['show_hidden', 'scroll_offset', 'directories_first', 'sort', 'reverse', 'preview_files', 'max_history_size', 'colorscheme', 'collapse_preview', 'auto_load_preview', 'max_dirsize_for_autopreview', 'autosave_bookmarks', 'apps', 'keys'] \ No newline at end of file diff --git a/doc/pydoc/sys.html b/doc/pydoc/sys.html index b3de7023..93aed3b6 100644 --- a/doc/pydoc/sys.html +++ b/doc/pydoc/sys.html @@ -228,10 +228,10 @@ function call.  See the debugger chapter in&n maxsize = 9223372036854775807
maxunicode = 1114111
meta_path = []
-modules = {'__future__': <module '__future__' from '/usr/lib/python3.1/__future__.py'>, '__init__': <module '__init__' from '/home/hut/.ranger/__init__.py'>, '__main__': <module '__main__' from './make_doc.py'>, '_abcoll': <module '_abcoll' from '/usr/lib/python3.1/_abcoll.py'>, '_bisect': <module '_bisect' from '/usr/lib/python3.1/lib-dynload/_bisect.so'>, '_codecs': <module '_codecs' (built-in)>, '_collections': <module '_collections' from '/usr/lib/python3.1/lib-dynload/_collections.so'>, '_curses': <module '_curses' from '/usr/lib/python3.1/lib-dynload/_curses.so'>, '_functools': <module '_functools' (built-in)>, '_heapq': <module '_heapq' from '/usr/lib/python3.1/lib-dynload/_heapq.so'>, ...}
-path = ['/home/hut/.ranger', '/home/hut/work/ranger', '/usr/lib/python31.zip', '/usr/lib/python3.1', '/usr/lib/python3.1/plat-linux2', '/usr/lib/python3.1/lib-dynload', '/usr/lib/python3.1/site-packages', '/home/hut/.ranger']
+modules = {'__future__': <module '__future__' from '/usr/lib/python3.1/__future__.py'>, '__main__': <module '__main__' from './make_doc.py'>, '_abcoll': <module '_abcoll' from '/usr/lib/python3.1/_abcoll.py'>, '_bisect': <module '_bisect' from '/usr/lib/python3.1/lib-dynload/_bisect.so'>, '_codecs': <module '_codecs' (built-in)>, '_collections': <module '_collections' from '/usr/lib/python3.1/lib-dynload/_collections.so'>, '_compat_pickle': <module '_compat_pickle' from '/usr/lib/python3.1/_compat_pickle.py'>, '_curses': <module '_curses' from '/usr/lib/python3.1/lib-dynload/_curses.so'>, '_functools': <module '_functools' (built-in)>, '_heapq': <module '_heapq' from '/usr/lib/python3.1/lib-dynload/_heapq.so'>, ...}
+path = ['/home/hut/work/ranger', '/usr/lib/python31.zip', '/usr/lib/python3.1', '/usr/lib/python3.1/plat-linux2', '/usr/lib/python3.1/lib-dynload', '/usr/lib/python3.1/site-packages', '/home/hut/.ranger']
path_hooks = [<class 'zipimport.zipimporter'>]
-path_importer_cache = {'.': None, './make_doc.py': <imp.NullImporter object at 0x7f327d9e39f0>, '/home/hut/.ranger': None, '/home/hut/.ranger/colorschemes': None, '/home/hut/work/ranger': None, '/home/hut/work/ranger/ranger': None, '/home/hut/work/ranger/ranger/colorschemes': None, '/home/hut/work/ranger/ranger/container': None, '/home/hut/work/ranger/ranger/defaults': None, '/home/hut/work/ranger/ranger/ext': None, ...}
+path_importer_cache = {'.': None, './make_doc.py': <imp.NullImporter object at 0x7f20a8ddf9f0>, '/home/hut/.ranger': None, '/home/hut/work/ranger': None, '/home/hut/work/ranger/ranger': None, '/home/hut/work/ranger/ranger/colorschemes': None, '/home/hut/work/ranger/ranger/container': None, '/home/hut/work/ranger/ranger/defaults': None, '/home/hut/work/ranger/ranger/ext': None, '/home/hut/work/ranger/ranger/fsobject': None, ...}
platform = 'linux2'
prefix = '/usr'
stderr = <_io.TextIOWrapper name='<stderr>' encoding='UTF-8'>
diff --git a/doc/pydoc/test.html b/doc/pydoc/test.html index 5d239e76..a75011da 100644 --- a/doc/pydoc/test.html +++ b/doc/pydoc/test.html @@ -17,18 +17,20 @@ Package Contents         -
tc_colorscheme
-tc_directory
-		tc_displayable
-tc_history
+
tc_bookmarks
+tc_colorscheme
+		tc_directory
+tc_displayable
+		tc_history
+tc_keyapi
tc_ui
test
-

+

-
 
Data
       __all__ = ['tc_history', 'tc_directory', 'tc_ui', 'tc_history', 'tc_ui', 'tc_displayable', 'tc_colorscheme', 'tc_directory', 'tc_colorscheme', 'tc_displayable']
+__all__ = ['tc_history', 'tc_directory', 'tc_ui', 'tc_bookmarks', 'tc_history', 'tc_keyapi', 'tc_ui', 'tc_displayable', 'tc_keyapi', 'tc_colorscheme', 'tc_bookmarks', 'tc_directory', 'tc_colorscheme', 'tc_displayable'] \ No newline at end of file diff --git a/doc/pydoc/test.tc_bookmarks.html b/doc/pydoc/test.tc_bookmarks.html new file mode 100644 index 00000000..75cc9954 --- /dev/null +++ b/doc/pydoc/test.tc_bookmarks.html @@ -0,0 +1,304 @@ + +Python: module test.tc_bookmarks + + + + + +
 
+ 
test.tc_bookmarks		index
/home/hut/work/ranger/test/tc_bookmarks.py
+

+

+ + + + + +
 
+Modules
       
os
+		time
+		unittest
+

+ + + + + +
 
+Classes
       
+
unittest.TestCase(builtins.object) +
+
+
TestDisplayable +
+
+
+

+ + + + + +
 
+class TestDisplayable(unittest.TestCase)
    
Method resolution order:
+
TestDisplayable
+
unittest.TestCase
+
builtins.object
+
+
+Methods defined here:
+
setUp(self)
+ +
tearDown(self)
+ +
test_adding_bookmarks(self)
+ +
test_messing_around(self)
+ +
test_sharing_bookmarks_between_instances(self)
+ +
+Methods inherited from unittest.TestCase:
+
__call__(self, *args, **kwds)
+ +
__eq__(self, other)
+ +
__hash__(self)
+ +
__init__(self, methodName='runTest')
Create an instance of the class that will use the named test
+method when executed. Raises a ValueError if the instance does
+not have a method with the specified name.
+ +
__ne__(self, other)
+ +
__repr__(self)
+ +
__str__(self)
+ +
addCleanup(self, function, *args, **kwargs)
Add a function, with arguments, to be called when the test is
+completed. Functions added are called on a LIFO basis and are
+called after tearDown on test failure or success.
+ 
+Cleanup items are called even if setUp fails (unlike tearDown).
+ +
addTypeEqualityFunc(self, typeobj, function)
Add a type specific assertEqual style function to compare a type.
+ 
+This method is for use by TestCase subclasses that need to register
+their own type equality functions to provide nicer error messages.
+ 
+Args:
+    typeobj: The data type to call this function on when both values
+            are of the same type in assertEqual().
+    function: The callable taking two arguments and an optional
+            msg= argument that raises self.failureException with a
+            useful error message when the two arguments are not equal.
+ +
assertAlmostEqual(self, first, second, *, places=7, msg=None)
Fail if the two objects are unequal as determined by their
+difference rounded to the given number of decimal places
+(default 7) and comparing to zero.
+ 
+Note that decimal places (from zero) are usually not the same
+as significant digits (measured from the most signficant digit).
+ +
assertAlmostEquals = assertAlmostEqual(self, first, second, *, places=7, msg=None)
Fail if the two objects are unequal as determined by their
+difference rounded to the given number of decimal places
+(default 7) and comparing to zero.
+ 
+Note that decimal places (from zero) are usually not the same
+as significant digits (measured from the most signficant digit).
+ +
assertDictContainsSubset(self, expected, actual, msg=None)
Checks whether actual is a superset of expected.
+ +
assertDictEqual(self, d1, d2, msg=None)
+ +
assertEqual(self, first, second, msg=None)
Fail if the two objects are unequal as determined by the '=='
+operator.
+ +
assertEquals = assertEqual(self, first, second, msg=None)
Fail if the two objects are unequal as determined by the '=='
+operator.
+ +
assertFalse(self, expr, msg=None)
Fail the test if the expression is true.
+ +
assertGreater(self, a, b, msg=None)
Just like assertTrue(a > b), but with a nicer default message.
+ +
assertGreaterEqual(self, a, b, msg=None)
Just like assertTrue(a >= b), but with a nicer default message.
+ +
assertIn(self, member, container, msg=None)
Just like assertTrue(a in b), but with a nicer default message.
+ +
assertIs(self, expr1, expr2, msg=None)
Just like assertTrue(a is b), but with a nicer default message.
+ +
assertIsNone(self, obj, msg=None)
Same as assertTrue(obj is None), with a nicer default message.
+ +
assertIsNot(self, expr1, expr2, msg=None)
Just like assertTrue(a is not b), but with a nicer default message.
+ +
assertIsNotNone(self, obj, msg=None)
Included for symmetry with assertIsNone.
+ +
assertLess(self, a, b, msg=None)
Just like assertTrue(a < b), but with a nicer default message.
+ +
assertLessEqual(self, a, b, msg=None)
Just like assertTrue(a <= b), but with a nicer default message.
+ +
assertListEqual(self, list1, list2, msg=None)
A list-specific equality assertion.
+ 
+Args:
+    list1: The first list to compare.
+    list2: The second list to compare.
+    msg: Optional message to use on failure instead of a list of
+            differences.
+ +
assertMultiLineEqual(self, first, second, msg=None)
Assert that two multi-line strings are equal.
+ +
assertNotAlmostEqual(self, first, second, *, places=7, msg=None)
Fail if the two objects are equal as determined by their
+difference rounded to the given number of decimal places
+(default 7) and comparing to zero.
+ 
+Note that decimal places (from zero) are usually not the same
+as significant digits (measured from the most signficant digit).
+ +
assertNotAlmostEquals = assertNotAlmostEqual(self, first, second, *, places=7, msg=None)
Fail if the two objects are equal as determined by their
+difference rounded to the given number of decimal places
+(default 7) and comparing to zero.
+ 
+Note that decimal places (from zero) are usually not the same
+as significant digits (measured from the most signficant digit).
+ +
assertNotEqual(self, first, second, msg=None)
Fail if the two objects are equal as determined by the '=='
+operator.
+ +
assertNotEquals = assertNotEqual(self, first, second, msg=None)
Fail if the two objects are equal as determined by the '=='
+operator.
+ +
assertNotIn(self, member, container, msg=None)
Just like assertTrue(a not in b), but with a nicer default message.
+ +
assertRaises(self, excClass, callableObj=None, *args, **kwargs)
Fail unless an exception of class excClass is thrown
+by callableObj when invoked with arguments args and keyword
+arguments kwargs. If a different type of exception is
+thrown, it will not be caught, and the test case will be
+deemed to have suffered an error, exactly as for an
+unexpected exception.
+ 
+If called with callableObj omitted or None, will return a
+context object used like this::
+ 
+     with assertRaises(some_error_class):
+         do_something()
+ +
assertRaisesRegexp(self, expected_exception, expected_regexp, callable_obj=None, *args, **kwargs)
Asserts that the message in a raised exception matches a regexp.
+ 
+Args:
+    expected_exception: Exception class expected to be raised.
+    expected_regexp: Regexp (re pattern object or string) expected
+            to be found in error message.
+    callable_obj: Function to be called.
+    args: Extra args.
+    kwargs: Extra kwargs.
+ +
assertRegexpMatches(self, text, expected_regex, msg=None)
+ +
assertSameElements(self, expected_seq, actual_seq, msg=None)
An unordered sequence specific comparison.
+ 
+Raises with an error message listing which elements of expected_seq
+are missing from actual_seq and vice versa if any.
+ +
assertSequenceEqual(self, seq1, seq2, msg=None, seq_type=None)
An equality assertion for ordered sequences (like lists and tuples).
+ 
+For the purposes of this function, a valid orderd sequence type is one
+which can be indexed, has a length, and has an equality operator.
+ 
+Args:
+    seq1: The first sequence to compare.
+    seq2: The second sequence to compare.
+    seq_type: The expected datatype of the sequences, or None if no
+            datatype should be enforced.
+    msg: Optional message to use on failure instead of a list of
+            differences.
+ +
assertSetEqual(self, set1, set2, msg=None)
A set-specific equality assertion.
+ 
+Args:
+    set1: The first set to compare.
+    set2: The second set to compare.
+    msg: Optional message to use on failure instead of a list of
+            differences.
+ 
+For more general containership equality, assertSameElements will work
+with things other than sets.    This uses ducktyping to support
+different types of sets, and is optimized for sets specifically
+(parameters must support a difference method).
+ +
assertTrue(self, expr, msg=None)
Fail the test unless the expression is true.
+ +
assertTupleEqual(self, tuple1, tuple2, msg=None)
A tuple-specific equality assertion.
+ 
+Args:
+    tuple1: The first tuple to compare.
+    tuple2: The second tuple to compare.
+    msg: Optional message to use on failure instead of a list of
+            differences.
+ +
assert_ = assertTrue(self, expr, msg=None)
Fail the test unless the expression is true.
+ +
countTestCases(self)
+ +
debug(self)
Run the test without collecting errors in a TestResult
+ +
defaultTestResult(self)
+ +
doCleanups(self)
Execute all cleanup functions. Normally called for you after
+tearDown.
+ +
fail(self, msg=None)
Fail immediately, with the given message.
+ +
failIf = deprecated_func(*args, **kwargs)
+ +
failIfAlmostEqual = deprecated_func(*args, **kwargs)
+ +
failIfEqual = deprecated_func(*args, **kwargs)
+ +
failUnless = deprecated_func(*args, **kwargs)
+ +
failUnlessAlmostEqual = deprecated_func(*args, **kwargs)
+ +
failUnlessEqual = deprecated_func(*args, **kwargs)
+ +
failUnlessRaises = deprecated_func(*args, **kwargs)
+ +
id(self)
+ +
run(self, result=None)
+ +
shortDescription(self)
Returns both the test method name and first line of its docstring.
+ 
+If no docstring is given, only returns the method name.
+ 
+This method overrides unittest.TestCase.shortDescription(), which
+only returns the first line of the docstring, obscuring the name
+of the test upon failure.
+ +
skipTest(self, reason)
Skip this test.
+ +
+Data descriptors inherited from unittest.TestCase:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+Data and other attributes inherited from unittest.TestCase:
+
failureException = <class 'AssertionError'>
Assertion failed.
+ +
longMessage = False
+ +

+ + + + + +
 
+Data
       BMFILE = '/home/hut/work/ranger/test/testdir/bookmarks'
+TESTDIR = '/home/hut/work/ranger/test/testdir'
+ \ No newline at end of file diff --git a/doc/pydoc/test.tc_colorscheme.html b/doc/pydoc/test.tc_colorscheme.html index fbd73399..c191ee32 100644 --- a/doc/pydoc/test.tc_colorscheme.html +++ b/doc/pydoc/test.tc_colorscheme.html @@ -294,5 +294,5 @@ Data and other attributes inherited from unitte Data         -CONTEXT_KEYS = ['reset', 'error', 'in_display', 'in_statusbar', 'in_titlebar', 'in_console', 'in_notify', 'in_pman', 'directory', 'file', 'hostname', 'executable', 'media', 'link', 'video', 'audio', 'image', 'media', 'document', 'container', ...] +CONTEXT_KEYS = ['reset', 'error', 'in_browser', 'in_statusbar', 'in_titlebar', 'in_console', 'in_notify', 'in_taskview', 'directory', 'file', 'hostname', 'executable', 'media', 'link', 'video', 'audio', 'image', 'media', 'document', 'container', ...] \ No newline at end of file diff --git a/doc/pydoc/test.tc_keyapi.html b/doc/pydoc/test.tc_keyapi.html new file mode 100644 index 00000000..bd802343 --- /dev/null +++ b/doc/pydoc/test.tc_keyapi.html @@ -0,0 +1,282 @@ + +Python: module test.tc_keyapi + + + + + +
 
+ 
test.tc_keyapi		index
/home/hut/work/ranger/test/tc_keyapi.py
+

+

+ + + + + +
 
+Classes
       
+
unittest.TestCase(builtins.object) +
+
+
Test +
+
+
+

+ + + + + +
 
+class Test(unittest.TestCase)
    
Method resolution order:
+
Test
+
unittest.TestCase
+
builtins.object
+
+
+Methods defined here:
+
test_wrapper(self)
+ +
+Methods inherited from unittest.TestCase:
+
__call__(self, *args, **kwds)
+ +
__eq__(self, other)
+ +
__hash__(self)
+ +
__init__(self, methodName='runTest')
Create an instance of the class that will use the named test
+method when executed. Raises a ValueError if the instance does
+not have a method with the specified name.
+ +
__ne__(self, other)
+ +
__repr__(self)
+ +
__str__(self)
+ +
addCleanup(self, function, *args, **kwargs)
Add a function, with arguments, to be called when the test is
+completed. Functions added are called on a LIFO basis and are
+called after tearDown on test failure or success.
+ 
+Cleanup items are called even if setUp fails (unlike tearDown).
+ +
addTypeEqualityFunc(self, typeobj, function)
Add a type specific assertEqual style function to compare a type.
+ 
+This method is for use by TestCase subclasses that need to register
+their own type equality functions to provide nicer error messages.
+ 
+Args:
+    typeobj: The data type to call this function on when both values
+            are of the same type in assertEqual().
+    function: The callable taking two arguments and an optional
+            msg= argument that raises self.failureException with a
+            useful error message when the two arguments are not equal.
+ +
assertAlmostEqual(self, first, second, *, places=7, msg=None)
Fail if the two objects are unequal as determined by their
+difference rounded to the given number of decimal places
+(default 7) and comparing to zero.
+ 
+Note that decimal places (from zero) are usually not the same
+as significant digits (measured from the most signficant digit).
+ +
assertAlmostEquals = assertAlmostEqual(self, first, second, *, places=7, msg=None)
Fail if the two objects are unequal as determined by their
+difference rounded to the given number of decimal places
+(default 7) and comparing to zero.
+ 
+Note that decimal places (from zero) are usually not the same
+as significant digits (measured from the most signficant digit).
+ +
assertDictContainsSubset(self, expected, actual, msg=None)
Checks whether actual is a superset of expected.
+ +
assertDictEqual(self, d1, d2, msg=None)
+ +
assertEqual(self, first, second, msg=None)
Fail if the two objects are unequal as determined by the '=='
+operator.
+ +
assertEquals = assertEqual(self, first, second, msg=None)
Fail if the two objects are unequal as determined by the '=='
+operator.
+ +
assertFalse(self, expr, msg=None)
Fail the test if the expression is true.
+ +
assertGreater(self, a, b, msg=None)
Just like assertTrue(a > b), but with a nicer default message.
+ +
assertGreaterEqual(self, a, b, msg=None)
Just like assertTrue(a >= b), but with a nicer default message.
+ +
assertIn(self, member, container, msg=None)
Just like assertTrue(a in b), but with a nicer default message.
+ +
assertIs(self, expr1, expr2, msg=None)
Just like assertTrue(a is b), but with a nicer default message.
+ +
assertIsNone(self, obj, msg=None)
Same as assertTrue(obj is None), with a nicer default message.
+ +
assertIsNot(self, expr1, expr2, msg=None)
Just like assertTrue(a is not b), but with a nicer default message.
+ +
assertIsNotNone(self, obj, msg=None)
Included for symmetry with assertIsNone.
+ +
assertLess(self, a, b, msg=None)
Just like assertTrue(a < b), but with a nicer default message.
+ +
assertLessEqual(self, a, b, msg=None)
Just like assertTrue(a <= b), but with a nicer default message.
+ +
assertListEqual(self, list1, list2, msg=None)
A list-specific equality assertion.
+ 
+Args:
+    list1: The first list to compare.
+    list2: The second list to compare.
+    msg: Optional message to use on failure instead of a list of
+            differences.
+ +
assertMultiLineEqual(self, first, second, msg=None)
Assert that two multi-line strings are equal.
+ +
assertNotAlmostEqual(self, first, second, *, places=7, msg=None)
Fail if the two objects are equal as determined by their
+difference rounded to the given number of decimal places
+(default 7) and comparing to zero.
+ 
+Note that decimal places (from zero) are usually not the same
+as significant digits (measured from the most signficant digit).
+ +
assertNotAlmostEquals = assertNotAlmostEqual(self, first, second, *, places=7, msg=None)
Fail if the two objects are equal as determined by their
+difference rounded to the given number of decimal places
+(default 7) and comparing to zero.
+ 
+Note that decimal places (from zero) are usually not the same
+as significant digits (measured from the most signficant digit).
+ +
assertNotEqual(self, first, second, msg=None)
Fail if the two objects are equal as determined by the '=='
+operator.
+ +
assertNotEquals = assertNotEqual(self, first, second, msg=None)
Fail if the two objects are equal as determined by the '=='
+operator.
+ +
assertNotIn(self, member, container, msg=None)
Just like assertTrue(a not in b), but with a nicer default message.
+ +
assertRaises(self, excClass, callableObj=None, *args, **kwargs)
Fail unless an exception of class excClass is thrown
+by callableObj when invoked with arguments args and keyword
+arguments kwargs. If a different type of exception is
+thrown, it will not be caught, and the test case will be
+deemed to have suffered an error, exactly as for an
+unexpected exception.
+ 
+If called with callableObj omitted or None, will return a
+context object used like this::
+ 
+     with assertRaises(some_error_class):
+         do_something()
+ +
assertRaisesRegexp(self, expected_exception, expected_regexp, callable_obj=None, *args, **kwargs)
Asserts that the message in a raised exception matches a regexp.
+ 
+Args:
+    expected_exception: Exception class expected to be raised.
+    expected_regexp: Regexp (re pattern object or string) expected
+            to be found in error message.
+    callable_obj: Function to be called.
+    args: Extra args.
+    kwargs: Extra kwargs.
+ +
assertRegexpMatches(self, text, expected_regex, msg=None)
+ +
assertSameElements(self, expected_seq, actual_seq, msg=None)
An unordered sequence specific comparison.
+ 
+Raises with an error message listing which elements of expected_seq
+are missing from actual_seq and vice versa if any.
+ +
assertSequenceEqual(self, seq1, seq2, msg=None, seq_type=None)
An equality assertion for ordered sequences (like lists and tuples).
+ 
+For the purposes of this function, a valid orderd sequence type is one
+which can be indexed, has a length, and has an equality operator.
+ 
+Args:
+    seq1: The first sequence to compare.
+    seq2: The second sequence to compare.
+    seq_type: The expected datatype of the sequences, or None if no
+            datatype should be enforced.
+    msg: Optional message to use on failure instead of a list of
+            differences.
+ +
assertSetEqual(self, set1, set2, msg=None)
A set-specific equality assertion.
+ 
+Args:
+    set1: The first set to compare.
+    set2: The second set to compare.
+    msg: Optional message to use on failure instead of a list of
+            differences.
+ 
+For more general containership equality, assertSameElements will work
+with things other than sets.    This uses ducktyping to support
+different types of sets, and is optimized for sets specifically
+(parameters must support a difference method).
+ +
assertTrue(self, expr, msg=None)
Fail the test unless the expression is true.
+ +
assertTupleEqual(self, tuple1, tuple2, msg=None)
A tuple-specific equality assertion.
+ 
+Args:
+    tuple1: The first tuple to compare.
+    tuple2: The second tuple to compare.
+    msg: Optional message to use on failure instead of a list of
+            differences.
+ +
assert_ = assertTrue(self, expr, msg=None)
Fail the test unless the expression is true.
+ +
countTestCases(self)
+ +
debug(self)
Run the test without collecting errors in a TestResult
+ +
defaultTestResult(self)
+ +
doCleanups(self)
Execute all cleanup functions. Normally called for you after
+tearDown.
+ +
fail(self, msg=None)
Fail immediately, with the given message.
+ +
failIf = deprecated_func(*args, **kwargs)
+ +
failIfAlmostEqual = deprecated_func(*args, **kwargs)
+ +
failIfEqual = deprecated_func(*args, **kwargs)
+ +
failUnless = deprecated_func(*args, **kwargs)
+ +
failUnlessAlmostEqual = deprecated_func(*args, **kwargs)
+ +
failUnlessEqual = deprecated_func(*args, **kwargs)
+ +
failUnlessRaises = deprecated_func(*args, **kwargs)
+ +
id(self)
+ +
run(self, result=None)
+ +
setUp(self)
Hook method for setting up the test fixture before exercising it.
+ +
shortDescription(self)
Returns both the test method name and first line of its docstring.
+ 
+If no docstring is given, only returns the method name.
+ 
+This method overrides unittest.TestCase.shortDescription(), which
+only returns the first line of the docstring, obscuring the name
+of the test upon failure.
+ +
skipTest(self, reason)
Skip this test.
+ +
tearDown(self)
Hook method for deconstructing the test fixture after testing it.
+ +
+Data descriptors inherited from unittest.TestCase:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+Data and other attributes inherited from unittest.TestCase:
+
failureException = <class 'AssertionError'>
Assertion failed.
+ +
longMessage = False
+ +

+ \ No newline at end of file diff --git a/doc/pydoc/test.tc_ui.html b/doc/pydoc/test.tc_ui.html index fcea943d..8e18f671 100644 --- a/doc/pydoc/test.tc_ui.html +++ b/doc/pydoc/test.tc_ui.html @@ -55,8 +55,6 @@ Methods defined here:

test_passing(self)
-
test_scrolling(self)
-
Methods inherited from unittest.TestCase:
__call__(self, *args, **kwds)
-- cgit 1.4.1-2-gfad0