From 4c13e1f2d85483e026d79ab05da9f1e8e4b45293 Mon Sep 17 00:00:00 2001 From: hut Date: Sat, 2 Jan 2010 00:10:49 +0100 Subject: updated pydoc documentation --- doc/pydoc/ranger.gui.widgets.console.html | 416 +++++++++++++++++++++--------- 1 file changed, 299 insertions(+), 117 deletions(-) (limited to 'doc/pydoc/ranger.gui.widgets.console.html') 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 -- cgit 1.4.1-2-gfad0