ranger - mirror of ranger - a simple, vim-like file manager

	Commit message (Expand)	Author	Age	Files	Lines
*	incremented version number and updated pydoc html files v1.0.3	hut	2010-02-16	1	-4/+4
*	updated pydoc documentation	hut	2010-01-13	1	-1/+13
*	updated pydoc documentation	hut	2010-01-02	1	-0/+55

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html><head><title>Python: module ranger.gui.defaultui</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>.defaultui</big></big></td ><td align=right valign=bottom ><a href=".">index</a> <a href="file:/home/hut/ranger/ranger/gui/defaultui.py">/home/hut/ranger/ranger/gui/defaultui.py</a></td></tr></table> <tt># 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.</tt> <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.ui.html#UI">ranger.gui.ui.UI</a>(<a href="ranger.gui.displayable.html#DisplayableContainer">ranger.gui.displayable.DisplayableContainer</a>) </dt><dd> <dl> <dt><a href="ranger.gui.defaultui.html#DefaultUI">DefaultUI</a> </dt></dl> </dd> </dl> <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> <tr bgcolor="#ffc8d8"> <td colspan=3 valign=bottom>  <a name="DefaultUI">class DefaultUI</a>(<a href="ranger.gui.ui.html#UI">ranger.gui.ui.UI</a>)</td></tr> <tr><td bgcolor="#ffc8d8"><tt>   </tt></td><td> </td> <td width="100%"><dl><dt>Method resolution order:</dt> <dd><a href="ranger.gui.defaultui.html#DefaultUI">DefaultUI</a></dd> <dd><a href="ranger.gui.ui.html#UI">ranger.gui.ui.UI</a></dd> <dd><a href="ranger.gui.displayable.html#DisplayableContainer">ranger.gui.displayable.DisplayableContainer</a></dd> <dd><a href="ranger.gui.displayable.html#Displayable">ranger.gui.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="DefaultUI-close_console">close_console</a>(self)</dt></dl> <dl><dt><a name="DefaultUI-close_embedded_pager">close_embedded_pager</a>(self)</dt></dl> <dl><dt><a name="DefaultUI-close_pager">close_pager</a>(self)</dt></dl> <dl><dt><a name="DefaultUI-close_taskview">close_taskview</a>(self)</dt></dl> <dl><dt><a name="DefaultUI-hint">hint</a>(self, text=None)</dt></dl> <dl><dt><a name="DefaultUI-notify">notify</a>(self, *a, **k)</dt></dl> <dl><dt><a name="DefaultUI-open_console">open_console</a>(self, mode, string='')</dt></dl> <dl><dt><a name="DefaultUI-open_embedded_pager">open_embedded_pager</a>(self)</dt></dl> <dl><dt><a name="DefaultUI-open_pager">open_pager</a>(self)</dt></dl> <dl><dt><a name="DefaultUI-open_taskview">open_taskview</a>(self)</dt></dl> <dl><dt><a name="DefaultUI-redraw_main_column">redraw_main_column</a>(self)</dt></dl> <dl><dt><a name="DefaultUI-scroll">scroll</a>(self, relative)</dt></dl> <dl><dt><a name="DefaultUI-setup">setup</a>(self)</dt><dd><tt>Build up the <a href="ranger.gui.ui.html#UI">UI</a> by initializing widgets.</tt></dd></dl> <dl><dt><a name="DefaultUI-throbber">throbber</a>(self, string='.', remove=False)</dt></dl> <dl><dt><a name="DefaultUI-update_size">update_size</a>(self)</dt><dd><tt>resize all widgets</tt></dd></dl> <hr> Methods inherited from <a href="ranger.gui.ui.html#UI">ranger.gui.ui.UI</a>: <dl><dt><a name="DefaultUI-__init__">__init__</a>(self, commandlist=None, env=None, fm=None)</dt></dl> <dl><dt><a name="DefaultUI-destroy">destroy</a>(self)</dt><dd><tt>Destroy all widgets and turn off curses</tt></dd></dl> <dl><dt><a name="DefaultUI-draw">draw</a>(self)</dt><dd><tt>Erase the window, then draw all objects in the container</tt></dd></dl> <dl><dt><a name="DefaultUI-finalize">finalize</a>(self)</dt><dd><tt>Finalize every object in container and refresh the window</tt></dd></dl> <dl><dt><a name="DefaultUI-get_next_key">get_next_key</a>(self)</dt><dd><tt>Waits for key input and returns the pressed key</tt></dd></dl> <dl><dt><a name="DefaultUI-handle_key">handle_key</a>(self, key)</dt><dd><tt>Handles key input</tt></dd></dl> <dl><dt><a name="DefaultUI-handle_mouse">handle_mouse</a>(self)</dt><dd><tt>Handles mouse input</tt></dd></dl> <dl><dt><a name="DefaultUI-initialize">initialize</a>(self)</dt><dd><tt>initialize curses, then call setup (at the first time) and resize.</tt></dd></dl> <dl><dt><a name="DefaultUI-redraw">redraw</a>(self)</dt><dd><tt>Redraw all widgets</tt></dd></dl> <dl><dt><a name="DefaultUI-redraw_window">redraw_window</a>(self)</dt><dd><tt>Redraw the window. This only calls self.win.redrawwin().</tt></dd></dl> <dl><dt><a name="DefaultUI-set_load_mode">set_load_mode</a>(self, boolean)</dt></dl> <dl><dt><a name="DefaultUI-suspend">suspend</a>(self)</dt><dd><tt>Turn off curses</tt></dd></dl> <hr> Data and other attributes inherited from <a href="ranger.gui.ui.html#UI">ranger.gui.ui.UI</a>: <dl><dt>is_set_up = False</dl> <dl><dt>load_mode = False</dl> <dl><dt>mousemask = 268435455</dl> <hr> Methods inherited from <a href="ranger.gui.displayable.html#DisplayableContainer">ranger.gui.displayable.DisplayableContainer</a>: <dl><dt><a name="DefaultUI-add_child">add_child</a>(self, obj)</dt><dd><tt>Add the objects to the container.</tt></dd></dl> <dl><dt><a name="DefaultUI-click">click</a>(self, event)</dt><dd><tt>Recursively called on objects in container</tt></dd></dl> <dl><dt><a name="DefaultUI-poke">poke</a>(self)</dt><dd><tt>Recursively called on objects in container</tt></dd></dl> <dl><dt><a name="DefaultUI-press">press</a>(self, key)</dt><dd><tt>Recursively called on objects in container</tt></dd></dl> <dl><dt><a name="DefaultUI-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">ranger.gui.displayable.Displayable</a>: <dl><dt><a name="DefaultUI-__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="DefaultUI-__nonzero__">__nonzero__</a>(self)</dt><dd><tt>Always True</tt></dd></dl> <dl><dt><a name="DefaultUI-__str__">__str__</a>(self)</dt></dl> <dl><dt><a name="DefaultUI-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="DefaultUI-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="DefaultUI-addnstr">addnstr</a>(self, *args)</dt></dl> <dl><dt><a name="DefaultUI-addstr">addstr</a>(self, *args)</dt></dl> <dl><dt><a name="DefaultUI-color">color</a>(self, *keys)</dt><dd><tt>Change the colors from now on.</tt></dd></dl> <dl><dt><a name="DefaultUI-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="DefaultUI-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 = <ranger.ext.openstruct.OpenStruct object at 0xe2f090></dl> </td></tr></table></td></tr></table> <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> <tr bgcolor="#55aa55"> <td colspan=3 valign=bottom>  <big>Data</big></td></tr> <tr><td bgcolor="#55aa55"><tt>      </tt></td><td> </td> <td width="100%">RATIO = (3, 3, 12, 9)</td></tr></table> </body></html>