ranger.gui.widgets
index
/home/hut/ranger/ranger/gui/widgets/__init__.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.

 
Package Contents
       
browsercolumn
browserview
console
console_mode
pager
statusbar
taskview
titlebar

 
Classes
       
ranger.gui.displayable.Displayable(ranger.shared.EnvironmentAware, ranger.shared.FileManagerAware, ranger.gui.curses_shortcuts.CursesShortcuts)
Widget

 
class Widget(ranger.gui.displayable.Displayable)
    The Widget class defines no methods and only exists for
classification of widgets.
 
 
Method resolution order:
Widget
ranger.gui.displayable.Displayable
ranger.shared.EnvironmentAware
ranger.shared.FileManagerAware
ranger.shared.Awareness
ranger.gui.curses_shortcuts.CursesShortcuts
ranger.shared.settings.SettingsAware
__builtin__.object

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.
__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!
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 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!
poke(self)
Called before drawing, even if invisible
press(self, key)
Called when a key is pressed and self.focused is True.
Override this!
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, *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

Data and other attributes inherited from ranger.shared.settings.SettingsAware:
settings = <ranger.ext.openstruct.OpenStruct object at 0xe2f090>