diff options
Diffstat (limited to 'doc/ranger.gui.widgets.filelist.html')
| -rw-r--r-- | doc/ranger.gui.widgets.filelist.html | 135 |
1 files changed, 135 insertions, 0 deletions
diff --git a/doc/ranger.gui.widgets.filelist.html b/doc/ranger.gui.widgets.filelist.html new file mode 100644 index 00000000..bfc9ae2e --- /dev/null +++ b/doc/ranger.gui.widgets.filelist.html @@ -0,0 +1,135 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module ranger.gui.widgets.filelist</title> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<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>.filelist</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/filelist.py">/home/hut/work/ranger/ranger/gui/widgets/filelist.py</a></font></td></tr></table> + <p><tt>The <a href="#FileList">FileList</a> widget displays the contents of a directory or file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ee77aa"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<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> +<dt><font face="helvetica, arial"><a href="ranger.gui.widgets.filelist.html#FileList">FileList</a> +</font></dt></dl> +</dd> +</dl> + <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="FileList">class <strong>FileList</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> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="ranger.gui.widgets.filelist.html#FileList">FileList</a></dd> +<dd><a href="ranger.gui.widgets.html#Widget">ranger.gui.widgets.Widget</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.shared.settings.html#SettingsAware">ranger.shared.settings.SettingsAware</a></dd> +<dd><a href="builtins.html#object">builtins.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="FileList-__init__"><strong>__init__</strong></a>(self, win, level)</dt></dl> + +<dl><dt><a name="FileList-click"><strong>click</strong></a>(self, event)</dt><dd><tt>Handle a MouseEvent</tt></dd></dl> + +<dl><dt><a name="FileList-draw"><strong>draw</strong></a>(self)</dt><dd><tt>Call either <a href="#FileList-draw_file">draw_file</a>() or <a href="#FileList-draw_directory">draw_directory</a>()</tt></dd></dl> + +<dl><dt><a name="FileList-draw_directory"><strong>draw_directory</strong></a>(self)</dt><dd><tt>Draw the contents of a directory</tt></dd></dl> + +<dl><dt><a name="FileList-draw_file"><strong>draw_file</strong></a>(self)</dt><dd><tt>Draw a preview of the file, if the settings allow it</tt></dd></dl> + +<dl><dt><a name="FileList-finalize"><strong>finalize</strong></a>(self)</dt></dl> + +<dl><dt><a name="FileList-get_scroll_begin"><strong>get_scroll_begin</strong></a>(self)</dt><dd><tt>Determines scroll_begin (the position of the first displayed file)</tt></dd></dl> + +<dl><dt><a name="FileList-has_preview"><strong>has_preview</strong></a>(self)</dt></dl> + +<dl><dt><a name="FileList-poke"><strong>poke</strong></a>(self)</dt></dl> + +<dl><dt><a name="FileList-scroll"><strong>scroll</strong></a>(self, relative)</dt><dd><tt>scroll by n lines</tt></dd></dl> + +<dl><dt><a name="FileList-set_scroll_begin"><strong>set_scroll_begin</strong></a>(self)</dt><dd><tt>Updates the scroll_begin value</tt></dd></dl> + +<hr> +Data and other attributes defined here:<br> +<dl><dt><strong>display_infostring</strong> = False</dl> + +<dl><dt><strong>main_display</strong> = False</dl> + +<dl><dt><strong>postpone_drawing</strong> = False</dl> + +<dl><dt><strong>scroll_begin</strong> = 0</dl> + +<dl><dt><strong>target</strong> = None</dl> + +<hr> +Methods inherited from <a href="ranger.gui.displayable.html#Displayable">ranger.gui.displayable.Displayable</a>:<br> +<dl><dt><a name="FileList-__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 object with x and y methods.</tt></dd></dl> + +<dl><dt><a name="FileList-__nonzero__"><strong>__nonzero__</strong></a>(self)</dt><dd><tt>Always True</tt></dd></dl> + +<dl><dt><a name="FileList-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="FileList-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="FileList-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="FileList-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="FileList-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="FileList-press"><strong>press</strong></a>(self, key)</dt><dd><tt>Called when a key is pressed and self.<strong>focused</strong> is True.<br> +Override this!</tt></dd></dl> + +<dl><dt><a name="FileList-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> + +<hr> +Data and other attributes inherited from <a href="ranger.shared.html#FileManagerAware">ranger.shared.FileManagerAware</a>:<br> +<dl><dt><strong>fm</strong> = None</dl> + +<hr> +Data descriptors inherited from <a href="ranger.shared.html#Awareness">ranger.shared.Awareness</a>:<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 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> + +</td></tr></table></td></tr></table> +</body></html> \ No newline at end of file |