ranger.__init__: cleaned up - ranger - mirror of ranger

diff options

author	hut <hut@lavabit.com>	2010-10-02 06:12:56 +0200
committer	hut <hut@lavabit.com>	2010-10-02 06:12:56 +0200
commit	a36bfd7b546d62e61a8d35185e8f2b74519a096c (patch)
tree	c03ec8048ee50dd60b9a96a2bd6684480790af74 /test/all_tests.py
parent	a457053815d72ef5d7ccfedbfda02101665bdec6 (diff)
download	ranger-a36bfd7b546d62e61a8d35185e8f2b74519a096c.tar.gz

ranger.__init__: cleaned up

Diffstat (limited to 'test/all_tests.py')

0 files changed, 0 insertions, 0 deletions

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html><head><title>Python: module ranger.gui.displayable</title> </head><body bgcolor="#f0f0f8"> <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> <tr bgcolor="#7799ee"> <td valign=bottom>    <big><big><a href="ranger.html">ranger</a>.<a href="ranger.gui.html">gui</a>.displayable</big></big></td ><td align=right valign=bottom ><a href=".">index</a> <a href="file:/home/hut/ranger/ranger/gui/displayable.py">/home/hut/ranger/ranger/gui/displayable.py</a></td></tr></table> <tt># Copyright (C) 2009, 2010  Roman Zimbelmann <romanz@lavabit.com> # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program.  If not, see <<a href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>>.</tt> <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> <tr bgcolor="#aa55cc"> <td colspan=3 valign=bottom>  <big>Modules</big></td></tr> <tr><td bgcolor="#aa55cc"><tt>      </tt></td><td> </td> <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="_curses.html">_curses</a> </td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table> <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> <tr bgcolor="#ee77aa"> <td colspan=3 valign=bottom>  <big>Classes</big></td></tr> <tr><td bgcolor="#ee77aa"><tt>      </tt></td><td> </td> <td width="100%"><dl> <dt><a href="ranger.gui.curses_shortcuts.html#CursesShortcuts">ranger.gui.curses_shortcuts.CursesShortcuts</a>(<a href="ranger.shared.settings.html#SettingsAware">ranger.shared.settings.SettingsAware</a>) </dt><dd> <dl> <dt><a href="ranger.gui.displayable.html#Displayable">Displayable</a>(<a href="ranger.shared.html#EnvironmentAware">ranger.shared.EnvironmentAware</a>, <a href="ranger.shared.html#FileManagerAware">ranger.shared.FileManagerAware</a>, <a href="ranger.gui.curses_shortcuts.html#CursesShortcuts">ranger.gui.curses_shortcuts.CursesShortcuts</a>) </dt><dd> <dl> <dt><a href="ranger.gui.displayable.html#DisplayableContainer">DisplayableContainer</a> </dt></dl> </dd> </dl> </dd> <dt><a href="ranger.shared.html#EnvironmentAware">ranger.shared.EnvironmentAware</a>(<a href="ranger.shared.html#Awareness">ranger.shared.Awareness</a>) </dt><dd> <dl> <dt><a href="ranger.gui.displayable.html#Displayable">Displayable</a>(<a href="ranger.shared.html#EnvironmentAware">ranger.shared.EnvironmentAware</a>, <a href="ranger.shared.html#FileManagerAware">ranger.shared.FileManagerAware</a>, <a href="ranger.gui.curses_shortcuts.html#CursesShortcuts">ranger.gui.curses_shortcuts.CursesShortcuts</a>) </dt><dd> <dl> <dt><a href="ranger.gui.displayable.html#DisplayableContainer">DisplayableContainer</a> </dt></dl> </dd> </dl> </dd> <dt><a href="ranger.shared.html#FileManagerAware">ranger.shared.FileManagerAware</a>(<a href="ranger.shared.html#Awareness">ranger.shared.Awareness</a>) </dt><dd> <dl> <dt><a href="ranger.gui.displayable.html#Displayable">Displayable</a>(<a href="ranger.shared.html#EnvironmentAware">ranger.shared.EnvironmentAware</a>, <a href="ranger.shared.html#FileManagerAware">ranger.shared.FileManagerAware</a>, <a href="ranger.gui.curses_shortcuts.html#CursesShortcuts">ranger.gui.curses_shortcuts.CursesShortcuts</a>) </dt><dd> <dl> <dt><a href="ranger.gui.displayable.html#DisplayableContainer">DisplayableContainer</a> </dt></dl> </dd> </dl> </dd> </dl> <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> <tr bgcolor="#ffc8d8"> <td colspan=3 valign=bottom>  <a name="Displayable">class Displayable</a>(<a href="ranger.shared.html#EnvironmentAware">ranger.shared.EnvironmentAware</a>, <a href="ranger.shared.html#FileManagerAware">ranger.shared.FileManagerAware</a>, <a href="ranger.gui.curses_shortcuts.html#CursesShortcuts">ranger.gui.curses_shortcuts.CursesShortcuts</a>)</td></tr> <tr bgcolor="#ffc8d8"><td rowspan=2><tt>   </tt></td> <td colspan=2><tt>Displayables are objects which are displayed on the screen.   This is just the abstract class, defining basic operations such as resizing, printing, changing colors. Subclasses of displayable can extend these methods:   <a href="#Displayable-draw">draw</a>() -- draw the object. Is only called if visible. <a href="#Displayable-poke">poke</a>() -- is called just before <a href="#Displayable-draw">draw</a>(), even if not visible. <a href="#Displayable-finalize">finalize</a>() -- called after all objects finished drawing. <a href="#Displayable-click">click</a>(event) -- called with a MouseEvent. This is called on all         visible objects under the mouse, until one returns True. <a href="#Displayable-press">press</a>(key) -- called after a key press on focused objects. <a href="#Displayable-destroy">destroy</a>() -- called before destroying the displayable object   Additionally, there are these methods:   <a href="#Displayable-__contains__">__contains__</a>(item) -- is the item (y, x) inside the widget?   These attributes are set:   Modifiable:         focused -- Focused objects receive <a href="#Displayable-press">press</a>() calls.         visible -- Visible objects receive <a href="#Displayable-draw">draw</a>() and <a href="#Displayable-finalize">finalize</a>() calls         need_redraw -- Should the widget be redrawn? This variable may                 be set at various places in the script and should eventually be                 handled (and unset) in the <a href="#Displayable-draw">draw</a>() method.   Read-Only: (i.e. reccomended not to change manually)         win -- the own curses window object         parent -- the parent (<a href="#DisplayableContainer">DisplayableContainer</a>) object or None         x, y, wid, hei -- absolute coordinates and boundaries         settings, fm, env -- inherited shared variables  </tt></td></tr> <tr><td> </td> <td width="100%"><dl><dt>Method resolution order:</dt> <dd><a href="ranger.gui.displayable.html#Displayable">Displayable</a></dd> <dd><a href="ranger.shared.html#EnvironmentAware">ranger.shared.EnvironmentAware</a></dd> <dd><a href="ranger.shared.html#FileManagerAware">ranger.shared.FileManagerAware</a></dd> <dd><a href="ranger.shared.html#Awareness">ranger.shared.Awareness</a></dd> <dd><a href="ranger.gui.curses_shortcuts.html#CursesShortcuts">ranger.gui.curses_shortcuts.CursesShortcuts</a></dd> <dd><a href="ranger.shared.settings.html#SettingsAware">ranger.shared.settings.SettingsAware</a></dd> <dd><a href="__builtin__.html#object">__builtin__.object</a></dd> </dl> <hr> Methods defined here: <dl><dt><a name="Displayable-__bool__">__bool__</a> = <a href="#Displayable-__nonzero__">__nonzero__</a>(self)</dt></dl> <dl><dt><a name="Displayable-__contains__">__contains__</a>(self, item)</dt><dd><tt>Is item inside the boundaries? item can be an iterable like [y, x] or an object with x and y methods.</tt></dd></dl> <dl><dt><a name="Displayable-__init__">__init__</a>(self, win, env=None, fm=None, settings=None)</dt></dl> <dl><dt><a name="Displayable-__nonzero__">__nonzero__</a>(self)</dt><dd><tt>Always True</tt></dd></dl> <dl><dt><a name="Displayable-__str__">__str__</a>(self)</dt></dl> <dl><dt><a name="Displayable-click">click</a>(self, event)</dt><dd><tt>Called when a mouse key is pressed and self.focused is True. Override this!</tt></dd></dl> <dl><dt><a name="Displayable-contains_point">contains_point</a>(self, y, x)</dt><dd><tt>Test whether the point (with absolute coordinates) lies within the boundaries of this object.</tt></dd></dl> <dl><dt><a name="Displayable-destroy">destroy</a>(self)</dt><dd><tt>Called when the object is destroyed. Override this!</tt></dd></dl> <dl><dt><a name="Displayable-draw">draw</a>(self)</dt><dd><tt>Draw the object. Called on every main iteration if visible. Containers should call <a href="#Displayable-draw">draw</a>() on their contained objects here. Override this!</tt></dd></dl> <dl><dt><a name="Displayable-finalize">finalize</a>(self)</dt><dd><tt>Called after every displayable is done drawing. Override this!</tt></dd></dl> <dl><dt><a name="Displayable-poke">poke</a>(self)</dt><dd><tt>Called before drawing, even if invisible</tt></dd></dl> <dl><dt><a name="Displayable-press">press</a>(self, key)</dt><dd><tt>Called when a key is pressed and self.focused is True. Override this!</tt></dd></dl> <dl><dt><a name="Displayable-resize">resize</a>(self, y, x, hei=None, wid=None)</dt><dd><tt>Resize the widget</tt></dd></dl> <hr> Data and other attributes inherited from <a href="ranger.shared.html#EnvironmentAware">ranger.shared.EnvironmentAware</a>: <dl><dt>env = None</dl> <hr> Data and other attributes inherited from <a href="ranger.shared.html#FileManagerAware">ranger.shared.FileManagerAware</a>: <dl><dt>fm = None</dl> <hr> Data descriptors inherited from <a href="ranger.shared.html#Awareness">ranger.shared.Awareness</a>: <dl><dt>__dict__</dt> <dd><tt>dictionary for instance variables (if defined)</tt></dd> </dl> <dl><dt>__weakref__</dt> <dd><tt>list of weak references to the object (if defined)</tt></dd> </dl> <hr> Methods inherited from <a href="ranger.gui.curses_shortcuts.html#CursesShortcuts">ranger.gui.curses_shortcuts.CursesShortcuts</a>: <dl><dt><a name="Displayable-addnstr">addnstr</a>(self, *args)</dt></dl> <dl><dt><a name="Displayable-addstr">addstr</a>(self, *args)</dt></dl> <dl><dt><a name="Displayable-color">color</a>(self, *keys)</dt><dd><tt>Change the colors from now on.</tt></dd></dl> <dl><dt><a name="Displayable-color_at">color_at</a>(self, y, x, wid, *keys)</dt><dd><tt>Change the colors at the specified position</tt></dd></dl> <dl><dt><a name="Displayable-color_reset">color_reset</a>(self)</dt><dd><tt>Change the colors to the default colors</tt></dd></dl> <hr> Data and other attributes inherited from <a href="ranger.shared.settings.html#SettingsAware">ranger.shared.settings.SettingsAware</a>: <dl><dt>settings = {}</dl> </td></tr></table> <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> <tr bgcolor="#ffc8d8"> <td colspan=3 valign=bottom>  <a name="DisplayableContainer">class DisplayableContainer</a>(<a href="ranger.gui.displayable.html#Displayable">Displayable</a>)</td></tr> <tr bgcolor="#ffc8d8"><td rowspan=2><tt>   </tt></td> <td colspan=2><tt>DisplayableContainers are Displayables which contain other Displayables.   This is also an abstract class. The methods draw, poke, finalize, click, press and destroy are extended here and will recursively call the function on all contained objects.   New methods:   <a href="#DisplayableContainer-add_child">add_child</a>(object) -- add the object to the container. <a href="#DisplayableContainer-remove_child">remove_child</a>(object) -- remove the object from the container.   New attributes:   container -- a list with all contained objects (rw)  </tt></td></tr> <tr><td> </td> <td width="100%"><dl><dt>Method resolution order:</dt> <dd><a href="ranger.gui.displayable.html#DisplayableContainer">DisplayableContainer</a></dd> <dd><a href="ranger.gui.displayable.html#Displayable">Displayable</a></dd> <dd><a href="ranger.shared.html#EnvironmentAware">ranger.shared.EnvironmentAware</a></dd> <dd><a href="ranger.shared.html#FileManagerAware">ranger.shared.FileManagerAware</a></dd> <dd><a href="ranger.shared.html#Awareness">ranger.shared.Awareness</a></dd> <dd><a href="ranger.gui.curses_shortcuts.html#CursesShortcuts">ranger.gui.curses_shortcuts.CursesShortcuts</a></dd> <dd><a href="ranger.shared.settings.html#SettingsAware">ranger.shared.settings.SettingsAware</a></dd> <dd><a href="__builtin__.html#object">__builtin__.object</a></dd> </dl> <hr> Methods defined here: <dl><dt><a name="DisplayableContainer-__init__">__init__</a>(self, win, env=None, fm=None, settings=None)</dt></dl> <dl><dt><a name="DisplayableContainer-add_child">add_child</a>(self, obj)</dt><dd><tt>Add the objects to the container.</tt></dd></dl> <dl><dt><a name="DisplayableContainer-click">click</a>(self, event)</dt><dd><tt>Recursively called on objects in container</tt></dd></dl> <dl><dt><a name="DisplayableContainer-destroy">destroy</a>(self)</dt><dd><tt>Recursively called on objects in container</tt></dd></dl> <dl><dt><a name="DisplayableContainer-draw">draw</a>(self)</dt><dd><tt>Recursively called on visible objects in container</tt></dd></dl> <dl><dt><a name="DisplayableContainer-finalize">finalize</a>(self)</dt><dd><tt>Recursively called on visible objects in container</tt></dd></dl> <dl><dt><a name="DisplayableContainer-poke">poke</a>(self)</dt><dd><tt>Recursively called on objects in container</tt></dd></dl> <dl><dt><a name="DisplayableContainer-press">press</a>(self, key)</dt><dd><tt>Recursively called on objects in container</tt></dd></dl> <dl><dt><a name="DisplayableContainer-remove_child">remove_child</a>(self, obj)</dt><dd><tt>Remove the object from the container.</tt></dd></dl> <hr> Methods inherited from <a href="ranger.gui.displayable.html#Displayable">Displayable</a>: <dl><dt><a name="DisplayableContainer-__bool__">__bool__</a> = __nonzero__(self)</dt><dd><tt>Always True</tt></dd></dl> <dl><dt><a name="DisplayableContainer-__contains__">__contains__</a>(self, item)</dt><dd><tt>Is item inside the boundaries? item can be an iterable like [y, x] or an object with x and y methods.</tt></dd></dl> <dl><dt><a name="DisplayableContainer-__nonzero__">__nonzero__</a>(self)</dt><dd><tt>Always True</tt></dd></dl> <dl><dt><a name="DisplayableContainer-__str__">__str__</a>(self)</dt></dl> <dl><dt><a name="DisplayableContainer-contains_point">contains_point</a>(self, y, x)</dt><dd><tt>Test whether the point (with absolute coordinates) lies within the boundaries of this object.</tt></dd></dl> <dl><dt><a name="DisplayableContainer-resize">resize</a>(self, y, x, hei=None, wid=None)</dt><dd><tt>Resize the widget</tt></dd></dl> <hr> Data and other attributes inherited from <a href="ranger.shared.html#EnvironmentAware">ranger.shared.EnvironmentAware</a>: <dl><dt>env = None</dl> <hr> Data and other attributes inherited from <a href="ranger.shared.html#FileManagerAware">ranger.shared.FileManagerAware</a>: <dl><dt>fm = None</dl> <hr> Data descriptors inherited from <a href="ranger.shared.html#Awareness">ranger.shared.Awareness</a>: <dl><dt>__dict__</dt> <dd><tt>dictionary for instance variables (if defined)</tt></dd> </dl> <dl><dt>__weakref__</dt> <dd><tt>list of weak references to the object (if defined)</tt></dd> </dl> <hr> Methods inherited from <a href="ranger.gui.curses_shortcuts.html#CursesShortcuts">ranger.gui.curses_shortcuts.CursesShortcuts</a>: <dl><dt><a name="DisplayableContainer-addnstr">addnstr</a>(self, *args)</dt></dl> <dl><dt><a name="DisplayableContainer-addstr">addstr</a>(self, *args)</dt></dl> <dl><dt><a name="DisplayableContainer-color">color</a>(self, *keys)</dt><dd><tt>Change the colors from now on.</tt></dd></dl> <dl><dt><a name="DisplayableContainer-color_at">color_at</a>(self, y, x, wid, *keys)</dt><dd><tt>Change the colors at the specified position</tt></dd></dl> <dl><dt><a name="DisplayableContainer-color_reset">color_reset</a>(self)</dt><dd><tt>Change the colors to the default colors</tt></dd></dl> <hr> Data and other attributes inherited from <a href="ranger.shared.settings.html#SettingsAware">ranger.shared.settings.SettingsAware</a>: <dl><dt>settings = {}</dl> </td></tr></table></td></tr></table> </body></html>


context:
space:
mode: