diff options
author | hut <hut@lavabit.com> | 2010-01-02 00:10:49 +0100 |
---|---|---|
committer | hut <hut@lavabit.com> | 2010-01-02 00:10:49 +0100 |
commit | 4c13e1f2d85483e026d79ab05da9f1e8e4b45293 (patch) | |
tree | eaf055bbc6134fd42014fbff00c208d57768b072 /doc/pydoc/ranger.gui.widgets.html | |
parent | 2ca2e862e616eba862ac80f5ee0003d1aa984a32 (diff) | |
download | ranger-4c13e1f2d85483e026d79ab05da9f1e8e4b45293.tar.gz |
updated pydoc documentation
Diffstat (limited to 'doc/pydoc/ranger.gui.widgets.html')
-rw-r--r-- | doc/pydoc/ranger.gui.widgets.html | 56 |
1 files changed, 29 insertions, 27 deletions
diff --git a/doc/pydoc/ranger.gui.widgets.html b/doc/pydoc/ranger.gui.widgets.html index 7c93bf98..38ff3224 100644 --- a/doc/pydoc/ranger.gui.widgets.html +++ b/doc/pydoc/ranger.gui.widgets.html @@ -17,13 +17,14 @@ <font color="#ffffff" face="helvetica, arial"><big><strong>Package Contents</strong></big></font></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="ranger.gui.widgets.console.html">console</a><br> -<a href="ranger.gui.widgets.filelist.html">filelist</a><br> -</td><td width="25%" valign=top><a href="ranger.gui.widgets.filelistcontainer.html">filelistcontainer</a><br> -<a href="ranger.gui.widgets.notify.html">notify</a><br> -</td><td width="25%" valign=top><a href="ranger.gui.widgets.process_manager.html">process_manager</a><br> +<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="ranger.gui.widgets.browsercolumn.html">browsercolumn</a><br> +<a href="ranger.gui.widgets.browserview.html">browserview</a><br> +</td><td width="25%" valign=top><a href="ranger.gui.widgets.console.html">console</a><br> +<a href="ranger.gui.widgets.console_mode.html">console_mode</a><br> +</td><td width="25%" valign=top><a href="ranger.gui.widgets.pager.html">pager</a><br> <a href="ranger.gui.widgets.statusbar.html">statusbar</a><br> -</td><td width="25%" valign=top><a href="ranger.gui.widgets.titlebar.html">titlebar</a><br> +</td><td width="25%" valign=top><a href="ranger.gui.widgets.taskview.html">taskview</a><br> +<a href="ranger.gui.widgets.titlebar.html">titlebar</a><br> </td></tr></table></td></tr></table><p> <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> <tr bgcolor="#ee77aa"> @@ -32,7 +33,7 @@ <tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> <td width="100%"><dl> -<dt><font face="helvetica, arial"><a href="ranger.gui.displayable.html#Displayable">ranger.gui.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.shared.settings.html#SettingsAware">ranger.shared.settings.SettingsAware</a>) +<dt><font face="helvetica, arial"><a href="ranger.gui.displayable.html#Displayable">ranger.gui.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>) </font></dt><dd> <dl> <dt><font face="helvetica, arial"><a href="ranger.gui.widgets.html#Widget">Widget</a> @@ -55,6 +56,7 @@ classification of widgets.<br> </tt></td></tr> <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="builtins.html#object">builtins.object</a></dd> </dl> @@ -67,22 +69,20 @@ item can be an iterable like [y, x] or&n <dl><dt><a name="Widget-__nonzero__"><strong>__nonzero__</strong></a>(self)</dt><dd><tt>Always True</tt></dd></dl> +<dl><dt><a name="Widget-__str__"><strong>__str__</strong></a>(self)</dt></dl> + <dl><dt><a name="Widget-click"><strong>click</strong></a>(self, event)</dt><dd><tt>Called when a mouse key is pressed and self.<strong>focused</strong> is True.<br> Override this!</tt></dd></dl> -<dl><dt><a name="Widget-color"><strong>color</strong></a>(self, keylist<font color="#909090">=None</font>, *keys)</dt><dd><tt>Change the colors from now on.</tt></dd></dl> - -<dl><dt><a name="Widget-color_at"><strong>color_at</strong></a>(self, y, x, wid, keylist<font color="#909090">=None</font>, *keys)</dt><dd><tt>Change the colors at the specified position</tt></dd></dl> - -<dl><dt><a name="Widget-color_reset"><strong>color_reset</strong></a>(self)</dt><dd><tt>Change the colors to the default colors</tt></dd></dl> - -<dl><dt><a name="Widget-contains_point"><strong>contains_point</strong></a>(self, y, x)</dt><dd><tt>Test if the point lies within the boundaries of this object</tt></dd></dl> +<dl><dt><a name="Widget-contains_point"><strong>contains_point</strong></a>(self, y, x)</dt><dd><tt>Test whether the point (with absolute coordinates) lies<br> +within the boundaries of this object.</tt></dd></dl> <dl><dt><a name="Widget-destroy"><strong>destroy</strong></a>(self)</dt><dd><tt>Called when the object is destroyed.<br> Override this!</tt></dd></dl> -<dl><dt><a name="Widget-draw"><strong>draw</strong></a>(self)</dt><dd><tt>Draw displayable. Called on every main iteration if the object<br> -is visible. Override this!</tt></dd></dl> +<dl><dt><a name="Widget-draw"><strong>draw</strong></a>(self)</dt><dd><tt>Draw the object. Called on every main iteration if visible.<br> +Containers should call <a href="#Widget-draw">draw</a>() on their contained objects here.<br> +Override this!</tt></dd></dl> <dl><dt><a name="Widget-finalize"><strong>finalize</strong></a>(self)</dt><dd><tt>Called after every displayable is done drawing.<br> Override this!</tt></dd></dl> @@ -95,16 +95,6 @@ Override this!</tt></dd></dl> <dl><dt><a name="Widget-resize"><strong>resize</strong></a>(self, y, x, hei<font color="#909090">=None</font>, wid<font color="#909090">=None</font>)</dt><dd><tt>Resize the widget</tt></dd></dl> <hr> -Data and other attributes inherited from <a href="ranger.gui.displayable.html#Displayable">ranger.gui.displayable.Displayable</a>:<br> -<dl><dt><strong>colorscheme</strong> = None</dl> - -<dl><dt><strong>focused</strong> = False</dl> - -<dl><dt><strong>visible</strong> = True</dl> - -<dl><dt><strong>win</strong> = None</dl> - -<hr> Data and other attributes inherited from <a href="ranger.shared.html#EnvironmentAware">ranger.shared.EnvironmentAware</a>:<br> <dl><dt><strong>env</strong> = None</dl> @@ -121,8 +111,20 @@ Data descriptors inherited from <a href="ranger.shared.html#Awareness">ranger.sh <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>:<br> +<dl><dt><a name="Widget-addnstr"><strong>addnstr</strong></a>(self, *args)</dt></dl> + +<dl><dt><a name="Widget-addstr"><strong>addstr</strong></a>(self, *args)</dt></dl> + +<dl><dt><a name="Widget-color"><strong>color</strong></a>(self, keylist<font color="#909090">=None</font>, *keys)</dt><dd><tt>Change the colors from now on.</tt></dd></dl> + +<dl><dt><a name="Widget-color_at"><strong>color_at</strong></a>(self, y, x, wid, keylist<font color="#909090">=None</font>, *keys)</dt><dd><tt>Change the colors at the specified position</tt></dd></dl> + +<dl><dt><a name="Widget-color_reset"><strong>color_reset</strong></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>:<br> -<dl><dt><strong>settings</strong> = <ranger.ext.openstruct.OpenStruct object at 0x154e450></dl> +<dl><dt><strong>settings</strong> = <ranger.ext.openstruct.OpenStruct object at 0x7f20a718ad90></dl> </td></tr></table></td></tr></table> </body></html> \ No newline at end of file |