ranger.gui.ui
index
/home/hut/work/ranger/ranger/gui/ui.py

# Copyright (c) 2009, 2010 hut <hut@lavabit.com>
#
# Permission to use, copy, modify, and/or distribute this software for any
# purpose with or without fee is hereby granted, provided that the above
# copyright notice and this permission notice appear in all copies.
#
# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

 
Modules
       
_curses
curses

 
Classes
       
ranger.gui.displayable.DisplayableContainer(ranger.gui.displayable.Displayable)
UI

 
class UI(ranger.gui.displayable.DisplayableContainer)
    
Method resolution order:
UI
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, commandlist=None, env=None, fm=None)
destroy(self)
Destroy all widgets and turn off curses
draw(self)
Erase the window, then draw all objects in the container
finalize(self)
Finalize every object in container and refresh the window
get_next_key(self)
Waits for key input and returns the pressed key
handle_key(self, key)
Handles key input
handle_mouse(self)
Handles mouse input
initialize(self)
initialize curses, then call setup (at the first time) and resize.
redraw(self)
Redraw all widgets
redraw_window(self)
Redraw the window. This only calls self.win.redrawwin().
set_load_mode(self, boolean)
setup(self)
Called after an initialize() call.
Override this!
suspend(self)
Turn off curses
update_size(self)
Update self.env.termsize.
Extend this method to resize all widgets!

Data and other attributes defined here:
is_set_up = False
load_mode = False
mousemask = 268435455

Methods inherited from ranger.gui.displayable.DisplayableContainer:
add_child(self, obj)
Add the objects to the container.
click(self, event)
Recursively called on objects in container
poke(self)
Recursively called on 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.
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 0x7f6a9067fbd0>