diff options
Diffstat (limited to 'doc/pydoc/ranger.gui.widgets.titlebar.html')
| -rw-r--r-- | doc/pydoc/ranger.gui.widgets.titlebar.html | 233 |
1 files changed, 23 insertions, 210 deletions
diff --git a/doc/pydoc/ranger.gui.widgets.titlebar.html b/doc/pydoc/ranger.gui.widgets.titlebar.html index c7052477..fc12df2a 100644 --- a/doc/pydoc/ranger.gui.widgets.titlebar.html +++ b/doc/pydoc/ranger.gui.widgets.titlebar.html @@ -9,8 +9,9 @@ <font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="ranger.html"><font color="#ffffff">ranger</font></a>.<a href="ranger.gui.html"><font color="#ffffff">gui</font></a>.<a href="ranger.gui.widgets.html"><font color="#ffffff">widgets</font></a>.titlebar</strong></big></big></font></td ><td align=right valign=bottom ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/hut/work/ranger/ranger/gui/widgets/titlebar.py">/home/hut/work/ranger/ranger/gui/widgets/titlebar.py</a></font></td></tr></table> - <p><tt>The <a href="#TitleBar">TitleBar</a> widget displays the current path and some other useful<br> -information.</tt></p> + <p><tt>The titlebar is the widget at the top, giving you broad orientation.<br> + <br> +It displays the current path among other things.</tt></p> <p> <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> <tr bgcolor="#ee77aa"> @@ -19,19 +20,6 @@ information.</tt></p> <tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> <td width="100%"><dl> -<dt><font face="helvetica, arial"><a href="builtins.html#list">builtins.list</a>(<a href="builtins.html#object">builtins.object</a>) -</font></dt><dd> -<dl> -<dt><font face="helvetica, arial"><a href="ranger.gui.widgets.titlebar.html#BarSide">BarSide</a> -</font></dt></dl> -</dd> -<dt><font face="helvetica, arial"><a href="builtins.html#object">builtins.object</a> -</font></dt><dd> -<dl> -<dt><font face="helvetica, arial"><a href="ranger.gui.widgets.titlebar.html#Bar">Bar</a> -</font></dt><dt><font face="helvetica, arial"><a href="ranger.gui.widgets.titlebar.html#ColoredString">ColoredString</a> -</font></dt></dl> -</dd> <dt><font face="helvetica, arial"><a href="ranger.gui.widgets.html#Widget">ranger.gui.widgets.Widget</a>(<a href="ranger.gui.displayable.html#Displayable">ranger.gui.displayable.Displayable</a>) </font></dt><dd> <dl> @@ -43,181 +31,6 @@ information.</tt></p> <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> <tr bgcolor="#ffc8d8"> <td colspan=3 valign=bottom> <br> -<font color="#000000" face="helvetica, arial"><a name="Bar">class <strong>Bar</strong></a>(<a href="builtins.html#object">builtins.object</a>)</font></td></tr> - -<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> -<td width="100%">Methods defined here:<br> -<dl><dt><a name="Bar-__init__"><strong>__init__</strong></a>(self)</dt></dl> - -<dl><dt><a name="Bar-add"><strong>add</strong></a>(self, *a, **kw)</dt></dl> - -<dl><dt><a name="Bar-addright"><strong>addright</strong></a>(self, *a, **kw)</dt></dl> - -<dl><dt><a name="Bar-combine"><strong>combine</strong></a>(self)</dt></dl> - -<dl><dt><a name="Bar-fill_gap"><strong>fill_gap</strong></a>(self, char, wid, gapwidth<font color="#909090">=False</font>)</dt></dl> - -<dl><dt><a name="Bar-fixedsize"><strong>fixedsize</strong></a>(self)</dt></dl> - -<dl><dt><a name="Bar-shrink_by_cutting"><strong>shrink_by_cutting</strong></a>(self, wid)</dt></dl> - -<dl><dt><a name="Bar-shrink_by_removing"><strong>shrink_by_removing</strong></a>(self, wid)</dt></dl> - -<dl><dt><a name="Bar-sumsize"><strong>sumsize</strong></a>(self)</dt></dl> - -<hr> -Data descriptors defined here:<br> -<dl><dt><strong>__dict__</strong></dt> -<dd><tt>dictionary for instance variables (if defined)</tt></dd> -</dl> -<dl><dt><strong>__weakref__</strong></dt> -<dd><tt>list of weak references to the object (if defined)</tt></dd> -</dl> -<hr> -Data and other attributes defined here:<br> -<dl><dt><strong>gap</strong> = None</dl> - -<dl><dt><strong>left</strong> = None</dl> - -<dl><dt><strong>right</strong> = None</dl> - -</td></tr></table> <p> -<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> -<tr bgcolor="#ffc8d8"> -<td colspan=3 valign=bottom> <br> -<font color="#000000" face="helvetica, arial"><a name="BarSide">class <strong>BarSide</strong></a>(<a href="builtins.html#list">builtins.list</a>)</font></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.widgets.titlebar.html#BarSide">BarSide</a></dd> -<dd><a href="builtins.html#list">builtins.list</a></dd> -<dd><a href="builtins.html#object">builtins.object</a></dd> -</dl> -<hr> -Methods defined here:<br> -<dl><dt><a name="BarSide-add"><strong>add</strong></a>(self, string, *lst, **kw)</dt></dl> - -<dl><dt><a name="BarSide-fixedsize"><strong>fixedsize</strong></a>(self)</dt></dl> - -<dl><dt><a name="BarSide-nonfixed_items"><strong>nonfixed_items</strong></a>(self)</dt></dl> - -<dl><dt><a name="BarSide-sumsize"><strong>sumsize</strong></a>(self)</dt></dl> - -<hr> -Data descriptors defined here:<br> -<dl><dt><strong>__dict__</strong></dt> -<dd><tt>dictionary for instance variables (if defined)</tt></dd> -</dl> -<dl><dt><strong>__weakref__</strong></dt> -<dd><tt>list of weak references to the object (if defined)</tt></dd> -</dl> -<hr> -Methods inherited from <a href="builtins.html#list">builtins.list</a>:<br> -<dl><dt><a name="BarSide-__add__"><strong>__add__</strong></a>(...)</dt><dd><tt>x.<a href="#BarSide-__add__">__add__</a>(y) <==> x+y</tt></dd></dl> - -<dl><dt><a name="BarSide-__contains__"><strong>__contains__</strong></a>(...)</dt><dd><tt>x.<a href="#BarSide-__contains__">__contains__</a>(y) <==> y in x</tt></dd></dl> - -<dl><dt><a name="BarSide-__delitem__"><strong>__delitem__</strong></a>(...)</dt><dd><tt>x.<a href="#BarSide-__delitem__">__delitem__</a>(y) <==> del x[y]</tt></dd></dl> - -<dl><dt><a name="BarSide-__eq__"><strong>__eq__</strong></a>(...)</dt><dd><tt>x.<a href="#BarSide-__eq__">__eq__</a>(y) <==> x==y</tt></dd></dl> - -<dl><dt><a name="BarSide-__ge__"><strong>__ge__</strong></a>(...)</dt><dd><tt>x.<a href="#BarSide-__ge__">__ge__</a>(y) <==> x>=y</tt></dd></dl> - -<dl><dt><a name="BarSide-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#BarSide-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> - -<dl><dt><a name="BarSide-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#BarSide-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> - -<dl><dt><a name="BarSide-__gt__"><strong>__gt__</strong></a>(...)</dt><dd><tt>x.<a href="#BarSide-__gt__">__gt__</a>(y) <==> x>y</tt></dd></dl> - -<dl><dt><a name="BarSide-__iadd__"><strong>__iadd__</strong></a>(...)</dt><dd><tt>x.<a href="#BarSide-__iadd__">__iadd__</a>(y) <==> x+=y</tt></dd></dl> - -<dl><dt><a name="BarSide-__imul__"><strong>__imul__</strong></a>(...)</dt><dd><tt>x.<a href="#BarSide-__imul__">__imul__</a>(y) <==> x*=y</tt></dd></dl> - -<dl><dt><a name="BarSide-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#BarSide-__init__">__init__</a>(...) initializes x; see x.__class__.__doc__ for signature</tt></dd></dl> - -<dl><dt><a name="BarSide-__iter__"><strong>__iter__</strong></a>(...)</dt><dd><tt>x.<a href="#BarSide-__iter__">__iter__</a>() <==> iter(x)</tt></dd></dl> - -<dl><dt><a name="BarSide-__le__"><strong>__le__</strong></a>(...)</dt><dd><tt>x.<a href="#BarSide-__le__">__le__</a>(y) <==> x<=y</tt></dd></dl> - -<dl><dt><a name="BarSide-__len__"><strong>__len__</strong></a>(...)</dt><dd><tt>x.<a href="#BarSide-__len__">__len__</a>() <==> len(x)</tt></dd></dl> - -<dl><dt><a name="BarSide-__lt__"><strong>__lt__</strong></a>(...)</dt><dd><tt>x.<a href="#BarSide-__lt__">__lt__</a>(y) <==> x<y</tt></dd></dl> - -<dl><dt><a name="BarSide-__mul__"><strong>__mul__</strong></a>(...)</dt><dd><tt>x.<a href="#BarSide-__mul__">__mul__</a>(n) <==> x*n</tt></dd></dl> - -<dl><dt><a name="BarSide-__ne__"><strong>__ne__</strong></a>(...)</dt><dd><tt>x.<a href="#BarSide-__ne__">__ne__</a>(y) <==> x!=y</tt></dd></dl> - -<dl><dt><a name="BarSide-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#BarSide-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> - -<dl><dt><a name="BarSide-__reversed__"><strong>__reversed__</strong></a>(...)</dt><dd><tt>L.<a href="#BarSide-__reversed__">__reversed__</a>() -- return a reverse iterator over the <a href="builtins.html#list">list</a></tt></dd></dl> - -<dl><dt><a name="BarSide-__rmul__"><strong>__rmul__</strong></a>(...)</dt><dd><tt>x.<a href="#BarSide-__rmul__">__rmul__</a>(n) <==> n*x</tt></dd></dl> - -<dl><dt><a name="BarSide-__setitem__"><strong>__setitem__</strong></a>(...)</dt><dd><tt>x.<a href="#BarSide-__setitem__">__setitem__</a>(i, y) <==> x[i]=y</tt></dd></dl> - -<dl><dt><a name="BarSide-__sizeof__"><strong>__sizeof__</strong></a>(...)</dt><dd><tt>L.<a href="#BarSide-__sizeof__">__sizeof__</a>() -- size of L in memory, in bytes</tt></dd></dl> - -<dl><dt><a name="BarSide-append"><strong>append</strong></a>(...)</dt><dd><tt>L.<a href="#BarSide-append">append</a>(<a href="builtins.html#object">object</a>) -- append <a href="builtins.html#object">object</a> to end</tt></dd></dl> - -<dl><dt><a name="BarSide-count"><strong>count</strong></a>(...)</dt><dd><tt>L.<a href="#BarSide-count">count</a>(value) -> integer -- return number of occurrences of value</tt></dd></dl> - -<dl><dt><a name="BarSide-extend"><strong>extend</strong></a>(...)</dt><dd><tt>L.<a href="#BarSide-extend">extend</a>(iterable) -- extend <a href="builtins.html#list">list</a> by appending elements from the iterable</tt></dd></dl> - -<dl><dt><a name="BarSide-index"><strong>index</strong></a>(...)</dt><dd><tt>L.<a href="#BarSide-index">index</a>(value, [start, [stop]]) -> integer -- return first index of value.<br> -Raises ValueError if the value is not present.</tt></dd></dl> - -<dl><dt><a name="BarSide-insert"><strong>insert</strong></a>(...)</dt><dd><tt>L.<a href="#BarSide-insert">insert</a>(index, <a href="builtins.html#object">object</a>) -- insert <a href="builtins.html#object">object</a> before index</tt></dd></dl> - -<dl><dt><a name="BarSide-pop"><strong>pop</strong></a>(...)</dt><dd><tt>L.<a href="#BarSide-pop">pop</a>([index]) -> item -- remove and return item at index (default last).<br> -Raises IndexError if <a href="builtins.html#list">list</a> is empty or index is out of range.</tt></dd></dl> - -<dl><dt><a name="BarSide-remove"><strong>remove</strong></a>(...)</dt><dd><tt>L.<a href="#BarSide-remove">remove</a>(value) -- remove first occurrence of value.<br> -Raises ValueError if the value is not present.</tt></dd></dl> - -<dl><dt><a name="BarSide-reverse"><strong>reverse</strong></a>(...)</dt><dd><tt>L.<a href="#BarSide-reverse">reverse</a>() -- reverse *IN PLACE*</tt></dd></dl> - -<dl><dt><a name="BarSide-sort"><strong>sort</strong></a>(...)</dt><dd><tt>L.<a href="#BarSide-sort">sort</a>(key=None, reverse=False) -- stable sort *IN PLACE*</tt></dd></dl> - -<hr> -Data and other attributes inherited from <a href="builtins.html#list">builtins.list</a>:<br> -<dl><dt><strong>__hash__</strong> = None</dl> - -<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object at 0x7f327d9523a0><dd><tt>T.<a href="#BarSide-__new__">__new__</a>(S, ...) -> a new <a href="builtins.html#object">object</a> with type S, a subtype of T</tt></dl> - -</td></tr></table> <p> -<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> -<tr bgcolor="#ffc8d8"> -<td colspan=3 valign=bottom> <br> -<font color="#000000" face="helvetica, arial"><a name="ColoredString">class <strong>ColoredString</strong></a>(<a href="builtins.html#object">builtins.object</a>)</font></td></tr> - -<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> -<td width="100%">Methods defined here:<br> -<dl><dt><a name="ColoredString-__init__"><strong>__init__</strong></a>(self, string, *lst)</dt></dl> - -<dl><dt><a name="ColoredString-__len__"><strong>__len__</strong></a>(self)</dt></dl> - -<dl><dt><a name="ColoredString-__str__"><strong>__str__</strong></a>(self)</dt></dl> - -<dl><dt><a name="ColoredString-cut_off"><strong>cut_off</strong></a>(self, n)</dt></dl> - -<dl><dt><a name="ColoredString-cut_off_to"><strong>cut_off_to</strong></a>(self, n)</dt></dl> - -<hr> -Data descriptors defined here:<br> -<dl><dt><strong>__dict__</strong></dt> -<dd><tt>dictionary for instance variables (if defined)</tt></dd> -</dl> -<dl><dt><strong>__weakref__</strong></dt> -<dd><tt>list of weak references to the object (if defined)</tt></dd> -</dl> -<hr> -Data and other attributes defined here:<br> -<dl><dt><strong>fixed</strong> = False</dl> - -</td></tr></table> <p> -<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> -<tr bgcolor="#ffc8d8"> -<td colspan=3 valign=bottom> <br> <font color="#000000" face="helvetica, arial"><a name="TitleBar">class <strong>TitleBar</strong></a>(<a href="ranger.gui.widgets.html#Widget">ranger.gui.widgets.Widget</a>)</font></td></tr> <tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> @@ -228,6 +41,7 @@ Data and other attributes defined here:<br> <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> @@ -250,24 +64,21 @@ Data and other attributes defined here:<br> <hr> Methods inherited from <a href="ranger.gui.displayable.html#Displayable">ranger.gui.displayable.Displayable</a>:<br> <dl><dt><a name="TitleBar-__contains__"><strong>__contains__</strong></a>(self, item)</dt><dd><tt>Is item inside the boundaries?<br> -item can be an iterable like [y, x] or an <a href="builtins.html#object">object</a> with x and y methods.</tt></dd></dl> +item can be an iterable like [y, x] or an object with x and y methods.</tt></dd></dl> <dl><dt><a name="TitleBar-__init__"><strong>__init__</strong></a>(self, win, env<font color="#909090">=None</font>, fm<font color="#909090">=None</font>, settings<font color="#909090">=None</font>)</dt></dl> <dl><dt><a name="TitleBar-__nonzero__"><strong>__nonzero__</strong></a>(self)</dt><dd><tt>Always True</tt></dd></dl> +<dl><dt><a name="TitleBar-__str__"><strong>__str__</strong></a>(self)</dt></dl> + <dl><dt><a name="TitleBar-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="TitleBar-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="TitleBar-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="TitleBar-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="TitleBar-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="TitleBar-contains_point"><strong>contains_point</strong></a>(self, y, x)</dt><dd><tt>Test if the point lies within the boundaries of this <a href="builtins.html#object">object</a></tt></dd></dl> - -<dl><dt><a name="TitleBar-destroy"><strong>destroy</strong></a>(self)</dt><dd><tt>Called when the <a href="builtins.html#object">object</a> is destroyed.<br> +<dl><dt><a name="TitleBar-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="TitleBar-finalize"><strong>finalize</strong></a>(self)</dt><dd><tt>Called after every displayable is done drawing.<br> @@ -281,16 +92,6 @@ Override this!</tt></dd></dl> <dl><dt><a name="TitleBar-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> @@ -307,8 +108,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="TitleBar-addnstr"><strong>addnstr</strong></a>(self, *args)</dt></dl> + +<dl><dt><a name="TitleBar-addstr"><strong>addstr</strong></a>(self, *args)</dt></dl> + +<dl><dt><a name="TitleBar-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="TitleBar-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="TitleBar-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><p> <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |