Python: module ranger.gui.widgets.console

From 94cb60a6bde75a385c6ad9afbae2c8e738fdc0a0 Mon Sep 17 00:00:00 2001 From: hut Date: Fri, 25 Dec 2009 21:55:36 +0100 Subject: moved pydoc pages to doc/pydoc --- doc/pydoc/ranger.gui.widgets.console.html | 908 ++++++++++++++++++++++++++++++ 1 file changed, 908 insertions(+) create mode 100644 doc/pydoc/ranger.gui.widgets.console.html (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 new file mode 100644 index 00000000..a14b7212 --- /dev/null +++ b/doc/pydoc/ranger.gui.widgets.console.html @@ -0,0 +1,908 @@ + +Python: module ranger.gui.widgets.console + + + + + +

+
ranger.gui.widgets.console

index
/home/hut/work/ranger/ranger/gui/widgets/console.py

The Console widget implements a vim-like console for entering +commands, searching and executing files.

+ + + + + +

+Modules

ranger.commands
+ curses
+

+ + + + + +

+Classes

+
ranger.gui.widgets.Widget(ranger.gui.displayable.Displayable) +
+
+
Console +
+
+
CommandConsole +
+
+
QuickCommandConsole +
+
+
OpenConsole +
QuickOpenConsole +
SearchConsole +
+
+
+
+
+
+ + + + + +

+class CommandConsole(Console)

Method resolution order:
+
CommandConsole
+
Console
+
ranger.gui.widgets.Widget
+
ranger.gui.displayable.Displayable
+
ranger.shared.EnvironmentAware
+
ranger.shared.FileManagerAware
+
ranger.shared.Awareness
+
ranger.shared.settings.SettingsAware
+
builtins.object
+
+
+Methods defined here:
+
execute(self)
+ +
tab(self, n=1)
+ +
+Data and other attributes defined here:
+
prompt = ':'
+ +
+Methods inherited from Console:
+
__init__(self, win)
+ +
add_to_history(self)
+ +
clear(self)
+ +
close(self)
+ +
delete(self, mod)
+ +
delete_rest(self, direction)
+ +
delete_word(self)
+ +
draw(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
+ +
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
+ +
tab_deque = None
+ +
visible = 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
+ +
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
+ +
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.gui.displayable.Displayable:
+
colorscheme = None
+ +
focused = False
+ +
win = None
+ +
+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)
+
+
+Data and other attributes inherited from ranger.shared.settings.SettingsAware:
+
settings = <ranger.ext.openstruct.OpenStruct object at 0x154e450>
+ +

+ + + + + +

+class Console(ranger.gui.widgets.Widget)

Method resolution order:
+
Console
+
ranger.gui.widgets.Widget
+
ranger.gui.displayable.Displayable
+
ranger.shared.EnvironmentAware
+
ranger.shared.FileManagerAware
+
ranger.shared.Awareness
+
ranger.shared.settings.SettingsAware
+
builtins.object
+
+
+Methods defined here:
+
__init__(self, win)
+ +
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)
+ +
tab(self)
+ +
type_key(self, key)
+ +
+Data and other attributes defined here:
+
commandlist = None
+ +
copy = ''
+ +
histories = None
+ +
history = None
+ +
last_cursor_mode = 1
+ +
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
+ +
prompt = ':'
+ +
tab_deque = None
+ +
visible = 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
+ +
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
+ +
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.gui.displayable.Displayable:
+
colorscheme = None
+ +
focused = False
+ +
win = None
+ +
+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)
+
+
+Data and other attributes inherited from ranger.shared.settings.SettingsAware:
+
settings = <ranger.ext.openstruct.OpenStruct object at 0x154e450>
+ +

+ + + + + +

+class OpenConsole(Console)

Method resolution order:
+
OpenConsole
+
Console
+
ranger.gui.widgets.Widget
+
ranger.gui.displayable.Displayable
+
ranger.shared.EnvironmentAware
+
ranger.shared.FileManagerAware
+
ranger.shared.Awareness
+
ranger.shared.settings.SettingsAware
+
builtins.object
+
+
+Data and other attributes defined here:
+
prompt = '!'
+ +
+Methods inherited from Console:
+
__init__(self, win)
+ +
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)
+ +
tab(self)
+ +
type_key(self, key)
+ +
+Data and other attributes inherited from Console:
+
commandlist = None
+ +
copy = ''
+ +
histories = None
+ +
history = None
+ +
last_cursor_mode = 1
+ +
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
+ +
tab_deque = None
+ +
visible = 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
+ +
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
+ +
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.gui.displayable.Displayable:
+
colorscheme = None
+ +
focused = False
+ +
win = None
+ +
+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)
+
+
+Data and other attributes inherited from ranger.shared.settings.SettingsAware:
+
settings = <ranger.ext.openstruct.OpenStruct object at 0x154e450>
+ +

+ + + + + +

+class QuickCommandConsole(CommandConsole)

Method resolution order:
+
QuickCommandConsole
+
CommandConsole
+
Console
+
ranger.gui.widgets.Widget
+
ranger.gui.displayable.Displayable
+
ranger.shared.EnvironmentAware
+
ranger.shared.FileManagerAware
+
ranger.shared.Awareness
+
ranger.shared.settings.SettingsAware
+
builtins.object
+
+
+Methods defined here:
+
on_line_change(self)
+ +
+Data and other attributes defined here:
+
prompt = '>'
+ +
+Methods inherited from CommandConsole:
+
execute(self)
+ +
tab(self, n=1)
+ +
+Methods inherited from Console:
+
__init__(self, win)
+ +
add_to_history(self)
+ +
clear(self)
+ +
close(self)
+ +
delete(self, mod)
+ +
delete_rest(self, direction)
+ +
delete_word(self)
+ +
draw(self)
+ +
finalize(self)
+ +
history_move(self, n)
+ +
init(self)
override this. Called directly after class change
+ +
move(self, relative=0, absolute=None)
+ +
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
+ +
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
+ +
tab_deque = None
+ +
visible = 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
+ +
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
+ +
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.gui.displayable.Displayable:
+
colorscheme = None
+ +
focused = False
+ +
win = None
+ +
+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)
+
+
+Data and other attributes inherited from ranger.shared.settings.SettingsAware:
+
settings = <ranger.ext.openstruct.OpenStruct object at 0x154e450>
+ +

+ + + + + + + +

+class QuickOpenConsole(Console)
    The QuickOpenConsole allows you to open files with +pre-defined programs and modes very quickly. By adding flags +to the command, you can specify precisely how the program is run, +ie. the d-flag will run it detached from the filemanager.

Method resolution order:
+
QuickOpenConsole
+
Console
+
ranger.gui.widgets.Widget
+
ranger.gui.displayable.Displayable
+
ranger.shared.EnvironmentAware
+
ranger.shared.FileManagerAware
+
ranger.shared.Awareness
+
ranger.shared.settings.SettingsAware
+
builtins.object
+
+
+Methods defined here:
+
execute(self)
+ +
init(self)
+ +
+Data and other attributes defined here:
+
prompt = 'open with: '
+ +
+Methods inherited from Console:
+
__init__(self, win)
+ +
add_to_history(self)
+ +
clear(self)
+ +
close(self)
+ +
delete(self, mod)
+ +
delete_rest(self, direction)
+ +
delete_word(self)
+ +
draw(self)
+ +
finalize(self)
+ +
history_move(self, n)
+ +
move(self, relative=0, absolute=None)
+ +
on_line_change(self)
+ +
open(self, mode, string='')
+ +
paste(self)
+ +
press(self, key)
+ +
tab(self)
+ +
type_key(self, key)
+ +
+Data and other attributes inherited from Console:
+
commandlist = None
+ +
copy = ''
+ +
histories = None
+ +
history = None
+ +
last_cursor_mode = 1
+ +
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
+ +
tab_deque = None
+ +
visible = 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
+ +
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
+ +
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.gui.displayable.Displayable:
+
colorscheme = None
+ +
focused = False
+ +
win = None
+ +
+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)
+
+
+Data and other attributes inherited from ranger.shared.settings.SettingsAware:
+
settings = <ranger.ext.openstruct.OpenStruct object at 0x154e450>
+ +

+ + + + + +

+class SearchConsole(Console)

Method resolution order:
+
SearchConsole
+
Console
+
ranger.gui.widgets.Widget
+
ranger.gui.displayable.Displayable
+
ranger.shared.EnvironmentAware
+
ranger.shared.FileManagerAware
+
ranger.shared.Awareness
+
ranger.shared.settings.SettingsAware
+
builtins.object
+
+
+Methods defined here:
+
execute(self)
+ +
init(self)
+ +
+Data and other attributes defined here:
+
prompt = '/'
+ +
+Methods inherited from Console:
+
__init__(self, win)
+ +
add_to_history(self)
+ +
clear(self)
+ +
close(self)
+ +
delete(self, mod)
+ +
delete_rest(self, direction)
+ +
delete_word(self)
+ +
draw(self)
+ +
finalize(self)
+ +
history_move(self, n)
+ +
move(self, relative=0, absolute=None)
+ +
on_line_change(self)
+ +
open(self, mode, string='')
+ +
paste(self)
+ +
press(self, key)
+ +
tab(self)
+ +
type_key(self, key)
+ +
+Data and other attributes inherited from Console:
+
commandlist = None
+ +
copy = ''
+ +
histories = None
+ +
history = None
+ +
last_cursor_mode = 1
+ +
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
+ +
tab_deque = None
+ +
visible = 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
+ +
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
+ +
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.gui.displayable.Displayable:
+
colorscheme = None
+ +
focused = False
+ +
win = None
+ +
+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)
+
+
+Data and other attributes inherited from ranger.shared.settings.SettingsAware:
+
settings = <ranger.ext.openstruct.OpenStruct object at 0x154e450>
+ +

+ + + + + +

+Data
DEFAULT_HISTORY = 0
+QUICKOPEN_HISTORY = 2
+SEARCH_HISTORY = 1
+ \ No newline at end of file -- cgit 1.4.1-2-gfad0

+Data
		DEFAULT_HISTORY = 0 +QUICKOPEN_HISTORY = 2 +SEARCH_HISTORY = 1