ranger.gui.ui
index
../../ranger/gui/ui.py

# Copyright (C) 2009-2013  Roman Zimbelmann <hut@lavabit.com>
# This software is distributed under the terms of the GNU GPL version 3.

 
Modules
       
_curses
curses
os
sys

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

 
class UI(ranger.gui.displayable.DisplayableContainer)
    # TODO: progress bar
# TODO: branch view
 
 
Method resolution order:
UI
ranger.gui.displayable.DisplayableContainer
ranger.gui.displayable.Displayable
ranger.core.shared.EnvironmentAware
ranger.core.shared.FileManagerAware
ranger.gui.curses_shortcuts.CursesShortcuts
ranger.core.shared.SettingsAware
builtins.object

Methods defined here:
__init__(self, env=None, fm=None)
close_console(self)
close_embedded_pager(self)
close_pager(self)
close_taskview(self)
destroy(self)
Destroy all widgets and turn off curses
draw(self)
Draw all objects in the container
finalize(self)
Finalize every object in container and refresh the window
get_pager(self)
handle_input(self)
handle_key(self, key)
Handles key input
handle_keys(self, *keys)
handle_mouse(self)
Handles mouse input
hint(self, text=None)
initialize(self)
initialize curses, then call setup (at the first time) and resize.
open_console(self, string='', prompt=None, position=None)
open_embedded_pager(self)
open_pager(self)
open_taskview(self)
press(self, key)
redraw(self)
Redraw all widgets
redraw_main_column(self)
redraw_window(self)
Redraw the window. This only calls self.win.redrawwin().
set_load_mode(self, boolean)
setup(self)
Build up the UI by initializing widgets.
setup_curses(self)
suspend(self)
Turn off curses
throbber(self, string='.', remove=False)
update_size(self)
resize all widgets

Data and other attributes defined here:
is_on = False
is_set_up = False
load_mode = False
termsize = None

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
remove_child(self, obj)
Remove the object from the container.

Methods inherited from ranger.gui.displayable.Displayable:
__bool__ = __nonzero__(self)
Always True
__contains__(self, item)
Checks if item is 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 lies inside this object.
 
x and y should be absolute coordinates.
resize(self, y, x, hei=None, wid=None)
Resize the widget

Methods inherited from ranger.core.shared.EnvironmentAware:
env = None
Data descriptors inherited from ranger.core.shared.EnvironmentAware:
__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:
addch(self, *args)
addnstr(self, *args)
addstr(self, *args)
color(self, *keys)
Change the colors from now on.
color_at(self, y, x, wid, *keys)
Change the colors at the specified position
color_reset(self)
Change the colors to the default colors
set_fg_bg_attr(self, fg, bg, attr)

 
Functions
       
ascii_only(string)

 
Data
        ALT_KEY = 9003
MOUSEMASK = 268435455