diff options
| author | hut <hut@lavabit.com> | 2009-12-25 21:55:04 +0100 |
|---|---|---|
| committer | hut <hut@lavabit.com> | 2009-12-25 21:55:04 +0100 |
| commit | f07bb12fc5c59430e995a64956b36331ce3629b9 (patch) | |
| tree | 4bd3be3c2c7fa6fb6fa6006c3d33cd4a05cbc664 | |
| parent | 4e01caf19cfbc798862e6b8b2dbd77328c8f99a2 (diff) | |
| download | ranger-f07bb12fc5c59430e995a64956b36331ce3629b9.tar.gz | |
updated pydoc pages
65 files changed, 10505 insertions, 0 deletions
diff --git a/doc/all_tests.html b/doc/all_tests.html new file mode 100644 index 00000000..5d206fa8 --- /dev/null +++ b/doc/all_tests.html @@ -0,0 +1,14 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module all_tests</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>all_tests</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/all_tests.py">/home/hut/work/ranger/all_tests.py</a></font></td></tr></table> + <p><tt>Run all the tests inside the test/ directory as a test suite.</tt></p> + +</body></html> \ No newline at end of file diff --git a/doc/curses.ascii.html b/doc/curses.ascii.html new file mode 100644 index 00000000..1c361b0a --- /dev/null +++ b/doc/curses.ascii.html @@ -0,0 +1,83 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module curses.ascii</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="curses.html"><font color="#ffffff">curses</font></a>.ascii</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/lib/python3.1/curses/ascii.py">/usr/lib/python3.1/curses/ascii.py</a><br><a href="http://docs.python.org/library/curses.ascii">Module Docs</a></font></td></tr></table> + <p><tt>Constants and membership tests for ASCII characters</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#eeaa77"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> + +<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt><a name="-alt"><strong>alt</strong></a>(c)</dt></dl> + <dl><dt><a name="-ascii"><strong>ascii</strong></a>(c)</dt></dl> + <dl><dt><a name="-ctrl"><strong>ctrl</strong></a>(c)</dt></dl> + <dl><dt><a name="-isalnum"><strong>isalnum</strong></a>(c)</dt></dl> + <dl><dt><a name="-isalpha"><strong>isalpha</strong></a>(c)</dt></dl> + <dl><dt><a name="-isascii"><strong>isascii</strong></a>(c)</dt></dl> + <dl><dt><a name="-isblank"><strong>isblank</strong></a>(c)</dt></dl> + <dl><dt><a name="-iscntrl"><strong>iscntrl</strong></a>(c)</dt></dl> + <dl><dt><a name="-isctrl"><strong>isctrl</strong></a>(c)</dt></dl> + <dl><dt><a name="-isdigit"><strong>isdigit</strong></a>(c)</dt></dl> + <dl><dt><a name="-isgraph"><strong>isgraph</strong></a>(c)</dt></dl> + <dl><dt><a name="-islower"><strong>islower</strong></a>(c)</dt></dl> + <dl><dt><a name="-ismeta"><strong>ismeta</strong></a>(c)</dt></dl> + <dl><dt><a name="-isprint"><strong>isprint</strong></a>(c)</dt></dl> + <dl><dt><a name="-ispunct"><strong>ispunct</strong></a>(c)</dt></dl> + <dl><dt><a name="-isspace"><strong>isspace</strong></a>(c)</dt></dl> + <dl><dt><a name="-isupper"><strong>isupper</strong></a>(c)</dt></dl> + <dl><dt><a name="-isxdigit"><strong>isxdigit</strong></a>(c)</dt></dl> + <dl><dt><a name="-unctrl"><strong>unctrl</strong></a>(c)</dt></dl> +</td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#55aa55"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> + +<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> +<td width="100%"><strong>ACK</strong> = 6<br> +<strong>BEL</strong> = 7<br> +<strong>BS</strong> = 8<br> +<strong>CAN</strong> = 24<br> +<strong>CR</strong> = 13<br> +<strong>DC1</strong> = 17<br> +<strong>DC2</strong> = 18<br> +<strong>DC3</strong> = 19<br> +<strong>DC4</strong> = 20<br> +<strong>DEL</strong> = 127<br> +<strong>DLE</strong> = 16<br> +<strong>EM</strong> = 25<br> +<strong>ENQ</strong> = 5<br> +<strong>EOT</strong> = 4<br> +<strong>ESC</strong> = 27<br> +<strong>ETB</strong> = 23<br> +<strong>ETX</strong> = 3<br> +<strong>FF</strong> = 12<br> +<strong>FS</strong> = 28<br> +<strong>GS</strong> = 29<br> +<strong>HT</strong> = 9<br> +<strong>LF</strong> = 10<br> +<strong>NAK</strong> = 21<br> +<strong>NL</strong> = 10<br> +<strong>NUL</strong> = 0<br> +<strong>RS</strong> = 30<br> +<strong>SI</strong> = 15<br> +<strong>SO</strong> = 14<br> +<strong>SOH</strong> = 1<br> +<strong>SP</strong> = 32<br> +<strong>STX</strong> = 2<br> +<strong>SUB</strong> = 26<br> +<strong>SYN</strong> = 22<br> +<strong>TAB</strong> = 9<br> +<strong>US</strong> = 31<br> +<strong>VT</strong> = 11<br> +<strong>controlnames</strong> = ['NUL', 'SOH', 'STX', 'ETX', 'EOT', 'ENQ', 'ACK', 'BEL', 'BS', 'HT', 'LF', 'VT', 'FF', 'CR', 'SO', 'SI', 'DLE', 'DC1', 'DC2', 'DC3', ...]</td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/curses.html b/doc/curses.html new file mode 100644 index 00000000..04bbb48c --- /dev/null +++ b/doc/curses.html @@ -0,0 +1,331 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: package curses</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>curses</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/lib/python3.1/curses/__init__.py">/usr/lib/python3.1/curses/__init__.py</a><br><a href="http://docs.python.org/library/curses">Module Docs</a></font></td></tr></table> + <p><tt>curses<br> + <br> +The main package for curses support for Python. Normally used by importing<br> +the package, and perhaps a particular module inside it.<br> + <br> + import curses<br> + from curses import textpad<br> + curses.initwin()<br> + ...</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<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="curses.ascii.html">ascii</a><br> +<a href="curses.has_key.html">has_key</a><br> +</td><td width="25%" valign=top><a href="curses.panel.html">panel</a><br> +<a href="curses.textpad.html">textpad</a><br> +</td><td width="25%" valign=top><a href="curses.wrapper.html">wrapper</a><br> +</td><td width="25%" valign=top></td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#eeaa77"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> + +<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt><a name="-baudrate"><strong>baudrate</strong></a>(...)</dt></dl> + <dl><dt><a name="-beep"><strong>beep</strong></a>(...)</dt></dl> + <dl><dt><a name="-can_change_color"><strong>can_change_color</strong></a>(...)</dt></dl> + <dl><dt><a name="-cbreak"><strong>cbreak</strong></a>(...)</dt></dl> + <dl><dt><a name="-color_content"><strong>color_content</strong></a>(...)</dt></dl> + <dl><dt><a name="-color_pair"><strong>color_pair</strong></a>(...)</dt></dl> + <dl><dt><a name="-curs_set"><strong>curs_set</strong></a>(...)</dt></dl> + <dl><dt><a name="-def_prog_mode"><strong>def_prog_mode</strong></a>(...)</dt></dl> + <dl><dt><a name="-def_shell_mode"><strong>def_shell_mode</strong></a>(...)</dt></dl> + <dl><dt><a name="-delay_output"><strong>delay_output</strong></a>(...)</dt></dl> + <dl><dt><a name="-doupdate"><strong>doupdate</strong></a>(...)</dt></dl> + <dl><dt><a name="-echo"><strong>echo</strong></a>(...)</dt></dl> + <dl><dt><a name="-endwin"><strong>endwin</strong></a>(...)</dt></dl> + <dl><dt><a name="-erasechar"><strong>erasechar</strong></a>(...)</dt></dl> + <dl><dt><a name="-filter"><strong>filter</strong></a>(...)</dt></dl> + <dl><dt><a name="-flash"><strong>flash</strong></a>(...)</dt></dl> + <dl><dt><a name="-flushinp"><strong>flushinp</strong></a>(...)</dt></dl> + <dl><dt><a name="-getmouse"><strong>getmouse</strong></a>(...)</dt></dl> + <dl><dt><a name="-getsyx"><strong>getsyx</strong></a>(...)</dt></dl> + <dl><dt><a name="-getwin"><strong>getwin</strong></a>(...)</dt></dl> + <dl><dt><a name="-halfdelay"><strong>halfdelay</strong></a>(...)</dt></dl> + <dl><dt><a name="-has_colors"><strong>has_colors</strong></a>(...)</dt></dl> + <dl><dt><a name="-has_ic"><strong>has_ic</strong></a>(...)</dt></dl> + <dl><dt><a name="-has_il"><strong>has_il</strong></a>(...)</dt></dl> + <dl><dt><a name="-has_key"><strong>has_key</strong></a>(...)</dt></dl> + <dl><dt><a name="-init_color"><strong>init_color</strong></a>(...)</dt></dl> + <dl><dt><a name="-init_pair"><strong>init_pair</strong></a>(...)</dt></dl> + <dl><dt><a name="-initscr"><strong>initscr</strong></a>()</dt></dl> + <dl><dt><a name="-intrflush"><strong>intrflush</strong></a>(...)</dt></dl> + <dl><dt><a name="-is_term_resized"><strong>is_term_resized</strong></a>(...)</dt></dl> + <dl><dt><a name="-isendwin"><strong>isendwin</strong></a>(...)</dt></dl> + <dl><dt><a name="-keyname"><strong>keyname</strong></a>(...)</dt></dl> + <dl><dt><a name="-killchar"><strong>killchar</strong></a>(...)</dt></dl> + <dl><dt><a name="-longname"><strong>longname</strong></a>(...)</dt></dl> + <dl><dt><a name="-meta"><strong>meta</strong></a>(...)</dt></dl> + <dl><dt><a name="-mouseinterval"><strong>mouseinterval</strong></a>(...)</dt></dl> + <dl><dt><a name="-mousemask"><strong>mousemask</strong></a>(...)</dt></dl> + <dl><dt><a name="-napms"><strong>napms</strong></a>(...)</dt></dl> + <dl><dt><a name="-newpad"><strong>newpad</strong></a>(...)</dt></dl> + <dl><dt><a name="-newwin"><strong>newwin</strong></a>(...)</dt></dl> + <dl><dt><a name="-nl"><strong>nl</strong></a>(...)</dt></dl> + <dl><dt><a name="-nocbreak"><strong>nocbreak</strong></a>(...)</dt></dl> + <dl><dt><a name="-noecho"><strong>noecho</strong></a>(...)</dt></dl> + <dl><dt><a name="-nonl"><strong>nonl</strong></a>(...)</dt></dl> + <dl><dt><a name="-noqiflush"><strong>noqiflush</strong></a>(...)</dt></dl> + <dl><dt><a name="-noraw"><strong>noraw</strong></a>(...)</dt></dl> + <dl><dt><a name="-pair_content"><strong>pair_content</strong></a>(...)</dt></dl> + <dl><dt><a name="-pair_number"><strong>pair_number</strong></a>(...)</dt></dl> + <dl><dt><a name="-putp"><strong>putp</strong></a>(...)</dt></dl> + <dl><dt><a name="-qiflush"><strong>qiflush</strong></a>(...)</dt></dl> + <dl><dt><a name="-raw"><strong>raw</strong></a>(...)</dt></dl> + <dl><dt><a name="-reset_prog_mode"><strong>reset_prog_mode</strong></a>(...)</dt></dl> + <dl><dt><a name="-reset_shell_mode"><strong>reset_shell_mode</strong></a>(...)</dt></dl> + <dl><dt><a name="-resetty"><strong>resetty</strong></a>(...)</dt></dl> + <dl><dt><a name="-resize_term"><strong>resize_term</strong></a>(...)</dt></dl> + <dl><dt><a name="-resizeterm"><strong>resizeterm</strong></a>(...)</dt></dl> + <dl><dt><a name="-savetty"><strong>savetty</strong></a>(...)</dt></dl> + <dl><dt><a name="-setsyx"><strong>setsyx</strong></a>(...)</dt></dl> + <dl><dt><a name="-setupterm"><strong>setupterm</strong></a>(...)</dt></dl> + <dl><dt><a name="-start_color"><strong>start_color</strong></a>()</dt></dl> + <dl><dt><a name="-termattrs"><strong>termattrs</strong></a>(...)</dt></dl> + <dl><dt><a name="-termname"><strong>termname</strong></a>(...)</dt></dl> + <dl><dt><a name="-tigetflag"><strong>tigetflag</strong></a>(...)</dt></dl> + <dl><dt><a name="-tigetnum"><strong>tigetnum</strong></a>(...)</dt></dl> + <dl><dt><a name="-tigetstr"><strong>tigetstr</strong></a>(...)</dt></dl> + <dl><dt><a name="-tparm"><strong>tparm</strong></a>(...)</dt></dl> + <dl><dt><a name="-typeahead"><strong>typeahead</strong></a>(...)</dt></dl> + <dl><dt><a name="-unctrl"><strong>unctrl</strong></a>(...)</dt></dl> + <dl><dt><a name="-ungetch"><strong>ungetch</strong></a>(...)</dt></dl> + <dl><dt><a name="-ungetmouse"><strong>ungetmouse</strong></a>(...)</dt></dl> + <dl><dt><a name="-use_default_colors"><strong>use_default_colors</strong></a>(...)</dt></dl> + <dl><dt><a name="-use_env"><strong>use_env</strong></a>(...)</dt></dl> +</td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#55aa55"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> + +<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> +<td width="100%"><strong>ALL_MOUSE_EVENTS</strong> = 134217727<br> +<strong>A_ALTCHARSET</strong> = 4194304<br> +<strong>A_ATTRIBUTES</strong> = 4294967040<br> +<strong>A_BLINK</strong> = 524288<br> +<strong>A_BOLD</strong> = 2097152<br> +<strong>A_CHARTEXT</strong> = 255<br> +<strong>A_COLOR</strong> = 65280<br> +<strong>A_DIM</strong> = 1048576<br> +<strong>A_HORIZONTAL</strong> = 33554432<br> +<strong>A_INVIS</strong> = 8388608<br> +<strong>A_LEFT</strong> = 67108864<br> +<strong>A_LOW</strong> = 134217728<br> +<strong>A_NORMAL</strong> = 0<br> +<strong>A_PROTECT</strong> = 16777216<br> +<strong>A_REVERSE</strong> = 262144<br> +<strong>A_RIGHT</strong> = 268435456<br> +<strong>A_STANDOUT</strong> = 65536<br> +<strong>A_TOP</strong> = 536870912<br> +<strong>A_UNDERLINE</strong> = 131072<br> +<strong>A_VERTICAL</strong> = 1073741824<br> +<strong>BUTTON1_CLICKED</strong> = 4<br> +<strong>BUTTON1_DOUBLE_CLICKED</strong> = 8<br> +<strong>BUTTON1_PRESSED</strong> = 2<br> +<strong>BUTTON1_RELEASED</strong> = 1<br> +<strong>BUTTON1_TRIPLE_CLICKED</strong> = 16<br> +<strong>BUTTON2_CLICKED</strong> = 256<br> +<strong>BUTTON2_DOUBLE_CLICKED</strong> = 512<br> +<strong>BUTTON2_PRESSED</strong> = 128<br> +<strong>BUTTON2_RELEASED</strong> = 64<br> +<strong>BUTTON2_TRIPLE_CLICKED</strong> = 1024<br> +<strong>BUTTON3_CLICKED</strong> = 16384<br> +<strong>BUTTON3_DOUBLE_CLICKED</strong> = 32768<br> +<strong>BUTTON3_PRESSED</strong> = 8192<br> +<strong>BUTTON3_RELEASED</strong> = 4096<br> +<strong>BUTTON3_TRIPLE_CLICKED</strong> = 65536<br> +<strong>BUTTON4_CLICKED</strong> = 1048576<br> +<strong>BUTTON4_DOUBLE_CLICKED</strong> = 2097152<br> +<strong>BUTTON4_PRESSED</strong> = 524288<br> +<strong>BUTTON4_RELEASED</strong> = 262144<br> +<strong>BUTTON4_TRIPLE_CLICKED</strong> = 4194304<br> +<strong>BUTTON_ALT</strong> = 67108864<br> +<strong>BUTTON_CTRL</strong> = 16777216<br> +<strong>BUTTON_SHIFT</strong> = 33554432<br> +<strong>COLOR_BLACK</strong> = 0<br> +<strong>COLOR_BLUE</strong> = 4<br> +<strong>COLOR_CYAN</strong> = 6<br> +<strong>COLOR_GREEN</strong> = 2<br> +<strong>COLOR_MAGENTA</strong> = 5<br> +<strong>COLOR_RED</strong> = 1<br> +<strong>COLOR_WHITE</strong> = 7<br> +<strong>COLOR_YELLOW</strong> = 3<br> +<strong>ERR</strong> = -1<br> +<strong>KEY_A1</strong> = 348<br> +<strong>KEY_A3</strong> = 349<br> +<strong>KEY_B2</strong> = 350<br> +<strong>KEY_BACKSPACE</strong> = 263<br> +<strong>KEY_BEG</strong> = 354<br> +<strong>KEY_BREAK</strong> = 257<br> +<strong>KEY_BTAB</strong> = 353<br> +<strong>KEY_C1</strong> = 351<br> +<strong>KEY_C3</strong> = 352<br> +<strong>KEY_CANCEL</strong> = 355<br> +<strong>KEY_CATAB</strong> = 342<br> +<strong>KEY_CLEAR</strong> = 333<br> +<strong>KEY_CLOSE</strong> = 356<br> +<strong>KEY_COMMAND</strong> = 357<br> +<strong>KEY_COPY</strong> = 358<br> +<strong>KEY_CREATE</strong> = 359<br> +<strong>KEY_CTAB</strong> = 341<br> +<strong>KEY_DC</strong> = 330<br> +<strong>KEY_DL</strong> = 328<br> +<strong>KEY_DOWN</strong> = 258<br> +<strong>KEY_EIC</strong> = 332<br> +<strong>KEY_END</strong> = 360<br> +<strong>KEY_ENTER</strong> = 343<br> +<strong>KEY_EOL</strong> = 335<br> +<strong>KEY_EOS</strong> = 334<br> +<strong>KEY_EXIT</strong> = 361<br> +<strong>KEY_F0</strong> = 264<br> +<strong>KEY_F1</strong> = 265<br> +<strong>KEY_F10</strong> = 274<br> +<strong>KEY_F11</strong> = 275<br> +<strong>KEY_F12</strong> = 276<br> +<strong>KEY_F13</strong> = 277<br> +<strong>KEY_F14</strong> = 278<br> +<strong>KEY_F15</strong> = 279<br> +<strong>KEY_F16</strong> = 280<br> +<strong>KEY_F17</strong> = 281<br> +<strong>KEY_F18</strong> = 282<br> +<strong>KEY_F19</strong> = 283<br> +<strong>KEY_F2</strong> = 266<br> +<strong>KEY_F20</strong> = 284<br> +<strong>KEY_F21</strong> = 285<br> +<strong>KEY_F22</strong> = 286<br> +<strong>KEY_F23</strong> = 287<br> +<strong>KEY_F24</strong> = 288<br> +<strong>KEY_F25</strong> = 289<br> +<strong>KEY_F26</strong> = 290<br> +<strong>KEY_F27</strong> = 291<br> +<strong>KEY_F28</strong> = 292<br> +<strong>KEY_F29</strong> = 293<br> +<strong>KEY_F3</strong> = 267<br> +<strong>KEY_F30</strong> = 294<br> +<strong>KEY_F31</strong> = 295<br> +<strong>KEY_F32</strong> = 296<br> +<strong>KEY_F33</strong> = 297<br> +<strong>KEY_F34</strong> = 298<br> +<strong>KEY_F35</strong> = 299<br> +<strong>KEY_F36</strong> = 300<br> +<strong>KEY_F37</strong> = 301<br> +<strong>KEY_F38</strong> = 302<br> +<strong>KEY_F39</strong> = 303<br> +<strong>KEY_F4</strong> = 268<br> +<strong>KEY_F40</strong> = 304<br> +<strong>KEY_F41</strong> = 305<br> +<strong>KEY_F42</strong> = 306<br> +<strong>KEY_F43</strong> = 307<br> +<strong>KEY_F44</strong> = 308<br> +<strong>KEY_F45</strong> = 309<br> +<strong>KEY_F46</strong> = 310<br> +<strong>KEY_F47</strong> = 311<br> +<strong>KEY_F48</strong> = 312<br> +<strong>KEY_F49</strong> = 313<br> +<strong>KEY_F5</strong> = 269<br> +<strong>KEY_F50</strong> = 314<br> +<strong>KEY_F51</strong> = 315<br> +<strong>KEY_F52</strong> = 316<br> +<strong>KEY_F53</strong> = 317<br> +<strong>KEY_F54</strong> = 318<br> +<strong>KEY_F55</strong> = 319<br> +<strong>KEY_F56</strong> = 320<br> +<strong>KEY_F57</strong> = 321<br> +<strong>KEY_F58</strong> = 322<br> +<strong>KEY_F59</strong> = 323<br> +<strong>KEY_F6</strong> = 270<br> +<strong>KEY_F60</strong> = 324<br> +<strong>KEY_F61</strong> = 325<br> +<strong>KEY_F62</strong> = 326<br> +<strong>KEY_F63</strong> = 327<br> +<strong>KEY_F7</strong> = 271<br> +<strong>KEY_F8</strong> = 272<br> +<strong>KEY_F9</strong> = 273<br> +<strong>KEY_FIND</strong> = 362<br> +<strong>KEY_HELP</strong> = 363<br> +<strong>KEY_HOME</strong> = 262<br> +<strong>KEY_IC</strong> = 331<br> +<strong>KEY_IL</strong> = 329<br> +<strong>KEY_LEFT</strong> = 260<br> +<strong>KEY_LL</strong> = 347<br> +<strong>KEY_MARK</strong> = 364<br> +<strong>KEY_MAX</strong> = 511<br> +<strong>KEY_MESSAGE</strong> = 365<br> +<strong>KEY_MIN</strong> = 257<br> +<strong>KEY_MOUSE</strong> = 409<br> +<strong>KEY_MOVE</strong> = 366<br> +<strong>KEY_NEXT</strong> = 367<br> +<strong>KEY_NPAGE</strong> = 338<br> +<strong>KEY_OPEN</strong> = 368<br> +<strong>KEY_OPTIONS</strong> = 369<br> +<strong>KEY_PPAGE</strong> = 339<br> +<strong>KEY_PREVIOUS</strong> = 370<br> +<strong>KEY_PRINT</strong> = 346<br> +<strong>KEY_REDO</strong> = 371<br> +<strong>KEY_REFERENCE</strong> = 372<br> +<strong>KEY_REFRESH</strong> = 373<br> +<strong>KEY_REPLACE</strong> = 374<br> +<strong>KEY_RESET</strong> = 345<br> +<strong>KEY_RESIZE</strong> = 410<br> +<strong>KEY_RESTART</strong> = 375<br> +<strong>KEY_RESUME</strong> = 376<br> +<strong>KEY_RIGHT</strong> = 261<br> +<strong>KEY_SAVE</strong> = 377<br> +<strong>KEY_SBEG</strong> = 378<br> +<strong>KEY_SCANCEL</strong> = 379<br> +<strong>KEY_SCOMMAND</strong> = 380<br> +<strong>KEY_SCOPY</strong> = 381<br> +<strong>KEY_SCREATE</strong> = 382<br> +<strong>KEY_SDC</strong> = 383<br> +<strong>KEY_SDL</strong> = 384<br> +<strong>KEY_SELECT</strong> = 385<br> +<strong>KEY_SEND</strong> = 386<br> +<strong>KEY_SEOL</strong> = 387<br> +<strong>KEY_SEXIT</strong> = 388<br> +<strong>KEY_SF</strong> = 336<br> +<strong>KEY_SFIND</strong> = 389<br> +<strong>KEY_SHELP</strong> = 390<br> +<strong>KEY_SHOME</strong> = 391<br> +<strong>KEY_SIC</strong> = 392<br> +<strong>KEY_SLEFT</strong> = 393<br> +<strong>KEY_SMESSAGE</strong> = 394<br> +<strong>KEY_SMOVE</strong> = 395<br> +<strong>KEY_SNEXT</strong> = 396<br> +<strong>KEY_SOPTIONS</strong> = 397<br> +<strong>KEY_SPREVIOUS</strong> = 398<br> +<strong>KEY_SPRINT</strong> = 399<br> +<strong>KEY_SR</strong> = 337<br> +<strong>KEY_SREDO</strong> = 400<br> +<strong>KEY_SREPLACE</strong> = 401<br> +<strong>KEY_SRESET</strong> = 344<br> +<strong>KEY_SRIGHT</strong> = 402<br> +<strong>KEY_SRSUME</strong> = 403<br> +<strong>KEY_SSAVE</strong> = 404<br> +<strong>KEY_SSUSPEND</strong> = 405<br> +<strong>KEY_STAB</strong> = 340<br> +<strong>KEY_SUNDO</strong> = 406<br> +<strong>KEY_SUSPEND</strong> = 407<br> +<strong>KEY_UNDO</strong> = 408<br> +<strong>KEY_UP</strong> = 259<br> +<strong>OK</strong> = 0<br> +<strong>REPORT_MOUSE_POSITION</strong> = 134217728<br> +<strong>__revision__</strong> = '$Id: __init__.py 61083 2008-02-26 08:18:30Z christian.heimes $'<br> +<strong>version</strong> = b'2.2'</td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/make_doc.html b/doc/make_doc.html new file mode 100644 index 00000000..fb04ba47 --- /dev/null +++ b/doc/make_doc.html @@ -0,0 +1,26 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module make_doc</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>make_doc</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/make_doc.py">/home/hut/work/ranger/make_doc.py</a></font></td></tr></table> + <p><tt>Generate pydoc documentation and move it to the doc directory.<br> +THIS WILL DELETE ALL EXISTING HTML FILES IN THAT DIRECTORY, so don't<br> +store important content there.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</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="os.html">os</a><br> +</td><td width="25%" valign=top><a href="pydoc.html">pydoc</a><br> +</td><td width="25%" valign=top><a href="sys.html">sys</a><br> +</td><td width="25%" valign=top></td></tr></table></td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/os.html b/doc/os.html new file mode 100644 index 00000000..fc746061 --- /dev/null +++ b/doc/os.html @@ -0,0 +1,908 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module os</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>os</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/lib/python3.1/os.py">/usr/lib/python3.1/os.py</a><br><a href="http://docs.python.org/library/os">Module Docs</a></font></td></tr></table> + <p><tt>OS routines for Mac, NT, or Posix depending on what system we're on.<br> + <br> +This exports:<br> + - all functions from posix, nt, os2, or ce, e.g. unlink, stat, etc.<br> + - os.path is either posixpath or ntpath<br> + - os.name is either 'posix', 'nt', 'os2' or 'ce'.<br> + - os.curdir is a string representing the current directory ('.' or ':')<br> + - os.pardir is a string representing the parent directory ('..' or '::')<br> + - os.sep is the (or a most common) pathname separator ('/' or ':' or '\\')<br> + - os.extsep is the extension separator (always '.')<br> + - os.altsep is the alternate pathname separator (None or '/')<br> + - os.pathsep is the component separator used in $PATH etc<br> + - os.linesep is the line separator in text files ('\r' or '\n' or '\r\n')<br> + - os.defpath is the default search path for executables<br> + - os.devnull is the file path of the null device ('/dev/null', etc.)<br> + <br> +Programs that import and use 'os' stand a better chance of being<br> +portable between different platforms. Of course, they must then<br> +only use functions that are defined by all platforms (e.g., unlink<br> +and opendir), and leave all pathname manipulation to os.path<br> +(e.g., split and join).</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</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="copyreg.html">copyreg</a><br> +</td><td width="25%" valign=top><a href="errno.html">errno</a><br> +</td><td width="25%" valign=top><a href="posixpath.html">posixpath</a><br> +</td><td width="25%" valign=top><a href="sys.html">sys</a><br> +</td></tr></table></td></tr></table><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="builtins.html#EnvironmentError">builtins.EnvironmentError</a>(<a href="builtins.html#Exception">builtins.Exception</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="builtins.html#OSError">builtins.OSError</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="posix.html#stat_result">posix.stat_result</a> +</font></dt><dt><font face="helvetica, arial"><a href="posix.html#statvfs_result">posix.statvfs_result</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"><strong>error</strong> = <a name="error">class OSError</a>(<a href="builtins.html#EnvironmentError">EnvironmentError</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>OS system call failed.<br> </tt></td></tr> +<tr><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="builtins.html#OSError">OSError</a></dd> +<dd><a href="builtins.html#EnvironmentError">EnvironmentError</a></dd> +<dd><a href="builtins.html#Exception">Exception</a></dd> +<dd><a href="builtins.html#BaseException">BaseException</a></dd> +<dd><a href="builtins.html#object">object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="OSError-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#error-__init__">__init__</a>(...) initializes x; see x.__class__.__doc__ for signature</tt></dd></dl> + +<hr> +Data and other attributes defined here:<br> +<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object at 0x7f327d94afc0><dd><tt>T.<a href="#error-__new__">__new__</a>(S, ...) -> a new <a href="builtins.html#object">object</a> with type S, a subtype of T</tt></dl> + +<hr> +Methods inherited from <a href="builtins.html#EnvironmentError">EnvironmentError</a>:<br> +<dl><dt><a name="OSError-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> + +<dl><dt><a name="OSError-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#error-__str__">__str__</a>() <==> str(x)</tt></dd></dl> + +<hr> +Data descriptors inherited from <a href="builtins.html#EnvironmentError">EnvironmentError</a>:<br> +<dl><dt><strong>errno</strong></dt> +<dd><tt>exception errno</tt></dd> +</dl> +<dl><dt><strong>filename</strong></dt> +<dd><tt>exception filename</tt></dd> +</dl> +<dl><dt><strong>strerror</strong></dt> +<dd><tt>exception strerror</tt></dd> +</dl> +<hr> +Methods inherited from <a href="builtins.html#BaseException">BaseException</a>:<br> +<dl><dt><a name="OSError-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#error-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> + +<dl><dt><a name="OSError-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#error-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> + +<dl><dt><a name="OSError-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#error-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> + +<dl><dt><a name="OSError-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#error-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> + +<dl><dt><a name="OSError-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> + +<dl><dt><a name="OSError-with_traceback"><strong>with_traceback</strong></a>(...)</dt><dd><tt>Exception.<a href="#error-with_traceback">with_traceback</a>(tb) --<br> +set self.<strong>__traceback__</strong> to tb and return self.</tt></dd></dl> + +<hr> +Data descriptors inherited from <a href="builtins.html#BaseException">BaseException</a>:<br> +<dl><dt><strong>__cause__</strong></dt> +<dd><tt>exception cause</tt></dd> +</dl> +<dl><dt><strong>__context__</strong></dt> +<dd><tt>exception context</tt></dd> +</dl> +<dl><dt><strong>__dict__</strong></dt> +</dl> +<dl><dt><strong>__traceback__</strong></dt> +</dl> +<dl><dt><strong>args</strong></dt> +</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="stat_result">class <strong>stat_result</strong></a>(<a href="builtins.html#object">builtins.object</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt><a href="#stat_result">stat_result</a>: Result from stat or lstat.<br> + <br> +This <a href="builtins.html#object">object</a> may be accessed either as a tuple of<br> + (mode, ino, dev, nlink, uid, gid, size, atime, mtime, ctime)<br> +or via the attributes st_mode, st_ino, st_dev, st_nlink, st_uid, and so on.<br> + <br> +Posix/windows: If your platform supports st_blksize, st_blocks, st_rdev,<br> +or st_flags, they are available as attributes only.<br> + <br> +See os.stat for more information.<br> </tt></td></tr> +<tr><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="stat_result-__add__"><strong>__add__</strong></a>(...)</dt><dd><tt>x.<a href="#stat_result-__add__">__add__</a>(y) <==> x+y</tt></dd></dl> + +<dl><dt><a name="stat_result-__contains__"><strong>__contains__</strong></a>(...)</dt><dd><tt>x.<a href="#stat_result-__contains__">__contains__</a>(y) <==> y in x</tt></dd></dl> + +<dl><dt><a name="stat_result-__eq__"><strong>__eq__</strong></a>(...)</dt><dd><tt>x.<a href="#stat_result-__eq__">__eq__</a>(y) <==> x==y</tt></dd></dl> + +<dl><dt><a name="stat_result-__ge__"><strong>__ge__</strong></a>(...)</dt><dd><tt>x.<a href="#stat_result-__ge__">__ge__</a>(y) <==> x>=y</tt></dd></dl> + +<dl><dt><a name="stat_result-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#stat_result-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> + +<dl><dt><a name="stat_result-__gt__"><strong>__gt__</strong></a>(...)</dt><dd><tt>x.<a href="#stat_result-__gt__">__gt__</a>(y) <==> x>y</tt></dd></dl> + +<dl><dt><a name="stat_result-__hash__"><strong>__hash__</strong></a>(...)</dt><dd><tt>x.<a href="#stat_result-__hash__">__hash__</a>() <==> hash(x)</tt></dd></dl> + +<dl><dt><a name="stat_result-__le__"><strong>__le__</strong></a>(...)</dt><dd><tt>x.<a href="#stat_result-__le__">__le__</a>(y) <==> x<=y</tt></dd></dl> + +<dl><dt><a name="stat_result-__len__"><strong>__len__</strong></a>(...)</dt><dd><tt>x.<a href="#stat_result-__len__">__len__</a>() <==> len(x)</tt></dd></dl> + +<dl><dt><a name="stat_result-__lt__"><strong>__lt__</strong></a>(...)</dt><dd><tt>x.<a href="#stat_result-__lt__">__lt__</a>(y) <==> x<y</tt></dd></dl> + +<dl><dt><a name="stat_result-__mul__"><strong>__mul__</strong></a>(...)</dt><dd><tt>x.<a href="#stat_result-__mul__">__mul__</a>(n) <==> x*n</tt></dd></dl> + +<dl><dt><a name="stat_result-__ne__"><strong>__ne__</strong></a>(...)</dt><dd><tt>x.<a href="#stat_result-__ne__">__ne__</a>(y) <==> x!=y</tt></dd></dl> + +<dl><dt><a name="stat_result-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> + +<dl><dt><a name="stat_result-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#stat_result-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> + +<dl><dt><a name="stat_result-__rmul__"><strong>__rmul__</strong></a>(...)</dt><dd><tt>x.<a href="#stat_result-__rmul__">__rmul__</a>(n) <==> n*x</tt></dd></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>st_atime</strong></dt> +<dd><tt>time of last access</tt></dd> +</dl> +<dl><dt><strong>st_blksize</strong></dt> +<dd><tt>blocksize for filesystem I/O</tt></dd> +</dl> +<dl><dt><strong>st_blocks</strong></dt> +<dd><tt>number of blocks allocated</tt></dd> +</dl> +<dl><dt><strong>st_ctime</strong></dt> +<dd><tt>time of last change</tt></dd> +</dl> +<dl><dt><strong>st_dev</strong></dt> +<dd><tt>device</tt></dd> +</dl> +<dl><dt><strong>st_gid</strong></dt> +<dd><tt>group ID of owner</tt></dd> +</dl> +<dl><dt><strong>st_ino</strong></dt> +<dd><tt>inode</tt></dd> +</dl> +<dl><dt><strong>st_mode</strong></dt> +<dd><tt>protection bits</tt></dd> +</dl> +<dl><dt><strong>st_mtime</strong></dt> +<dd><tt>time of last modification</tt></dd> +</dl> +<dl><dt><strong>st_nlink</strong></dt> +<dd><tt>number of hard links</tt></dd> +</dl> +<dl><dt><strong>st_rdev</strong></dt> +<dd><tt>device type (if inode device)</tt></dd> +</dl> +<dl><dt><strong>st_size</strong></dt> +<dd><tt>total size, in bytes</tt></dd> +</dl> +<dl><dt><strong>st_uid</strong></dt> +<dd><tt>user ID of owner</tt></dd> +</dl> +<hr> +Data and other attributes defined here:<br> +<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object at 0x7f327d99e840><dd><tt>T.<a href="#stat_result-__new__">__new__</a>(S, ...) -> a new <a href="builtins.html#object">object</a> with type S, a subtype of T</tt></dl> + +<dl><dt><strong>n_fields</strong> = 16</dl> + +<dl><dt><strong>n_sequence_fields</strong> = 10</dl> + +<dl><dt><strong>n_unnamed_fields</strong> = 3</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="statvfs_result">class <strong>statvfs_result</strong></a>(<a href="builtins.html#object">builtins.object</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt><a href="#statvfs_result">statvfs_result</a>: Result from statvfs or fstatvfs.<br> + <br> +This <a href="builtins.html#object">object</a> may be accessed either as a tuple of<br> + (bsize, frsize, blocks, bfree, bavail, files, ffree, favail, flag, namemax),<br> +or via the attributes f_bsize, f_frsize, f_blocks, f_bfree, and so on.<br> + <br> +See os.statvfs for more information.<br> </tt></td></tr> +<tr><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="statvfs_result-__add__"><strong>__add__</strong></a>(...)</dt><dd><tt>x.<a href="#statvfs_result-__add__">__add__</a>(y) <==> x+y</tt></dd></dl> + +<dl><dt><a name="statvfs_result-__contains__"><strong>__contains__</strong></a>(...)</dt><dd><tt>x.<a href="#statvfs_result-__contains__">__contains__</a>(y) <==> y in x</tt></dd></dl> + +<dl><dt><a name="statvfs_result-__eq__"><strong>__eq__</strong></a>(...)</dt><dd><tt>x.<a href="#statvfs_result-__eq__">__eq__</a>(y) <==> x==y</tt></dd></dl> + +<dl><dt><a name="statvfs_result-__ge__"><strong>__ge__</strong></a>(...)</dt><dd><tt>x.<a href="#statvfs_result-__ge__">__ge__</a>(y) <==> x>=y</tt></dd></dl> + +<dl><dt><a name="statvfs_result-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#statvfs_result-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> + +<dl><dt><a name="statvfs_result-__gt__"><strong>__gt__</strong></a>(...)</dt><dd><tt>x.<a href="#statvfs_result-__gt__">__gt__</a>(y) <==> x>y</tt></dd></dl> + +<dl><dt><a name="statvfs_result-__hash__"><strong>__hash__</strong></a>(...)</dt><dd><tt>x.<a href="#statvfs_result-__hash__">__hash__</a>() <==> hash(x)</tt></dd></dl> + +<dl><dt><a name="statvfs_result-__le__"><strong>__le__</strong></a>(...)</dt><dd><tt>x.<a href="#statvfs_result-__le__">__le__</a>(y) <==> x<=y</tt></dd></dl> + +<dl><dt><a name="statvfs_result-__len__"><strong>__len__</strong></a>(...)</dt><dd><tt>x.<a href="#statvfs_result-__len__">__len__</a>() <==> len(x)</tt></dd></dl> + +<dl><dt><a name="statvfs_result-__lt__"><strong>__lt__</strong></a>(...)</dt><dd><tt>x.<a href="#statvfs_result-__lt__">__lt__</a>(y) <==> x<y</tt></dd></dl> + +<dl><dt><a name="statvfs_result-__mul__"><strong>__mul__</strong></a>(...)</dt><dd><tt>x.<a href="#statvfs_result-__mul__">__mul__</a>(n) <==> x*n</tt></dd></dl> + +<dl><dt><a name="statvfs_result-__ne__"><strong>__ne__</strong></a>(...)</dt><dd><tt>x.<a href="#statvfs_result-__ne__">__ne__</a>(y) <==> x!=y</tt></dd></dl> + +<dl><dt><a name="statvfs_result-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> + +<dl><dt><a name="statvfs_result-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#statvfs_result-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> + +<dl><dt><a name="statvfs_result-__rmul__"><strong>__rmul__</strong></a>(...)</dt><dd><tt>x.<a href="#statvfs_result-__rmul__">__rmul__</a>(n) <==> n*x</tt></dd></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>f_bavail</strong></dt> +</dl> +<dl><dt><strong>f_bfree</strong></dt> +</dl> +<dl><dt><strong>f_blocks</strong></dt> +</dl> +<dl><dt><strong>f_bsize</strong></dt> +</dl> +<dl><dt><strong>f_favail</strong></dt> +</dl> +<dl><dt><strong>f_ffree</strong></dt> +</dl> +<dl><dt><strong>f_files</strong></dt> +</dl> +<dl><dt><strong>f_flag</strong></dt> +</dl> +<dl><dt><strong>f_frsize</strong></dt> +</dl> +<dl><dt><strong>f_namemax</strong></dt> +</dl> +<hr> +Data and other attributes defined here:<br> +<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object at 0x7f327d99e9e0><dd><tt>T.<a href="#statvfs_result-__new__">__new__</a>(S, ...) -> a new <a href="builtins.html#object">object</a> with type S, a subtype of T</tt></dl> + +<dl><dt><strong>n_fields</strong> = 10</dl> + +<dl><dt><strong>n_sequence_fields</strong> = 10</dl> + +<dl><dt><strong>n_unnamed_fields</strong> = 0</dl> + +</td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#eeaa77"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> + +<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt><a name="-WCOREDUMP"><strong>WCOREDUMP</strong></a>(...)</dt><dd><tt><a href="#-WCOREDUMP">WCOREDUMP</a>(status) -> bool<br> + <br> +Return True if the process returning 'status' was dumped to a core file.</tt></dd></dl> + <dl><dt><a name="-WEXITSTATUS"><strong>WEXITSTATUS</strong></a>(...)</dt><dd><tt><a href="#-WEXITSTATUS">WEXITSTATUS</a>(status) -> integer<br> + <br> +Return the process return code from 'status'.</tt></dd></dl> + <dl><dt><a name="-WIFCONTINUED"><strong>WIFCONTINUED</strong></a>(...)</dt><dd><tt><a href="#-WIFCONTINUED">WIFCONTINUED</a>(status) -> bool<br> + <br> +Return True if the process returning 'status' was continued from a<br> +job control stop.</tt></dd></dl> + <dl><dt><a name="-WIFEXITED"><strong>WIFEXITED</strong></a>(...)</dt><dd><tt><a href="#-WIFEXITED">WIFEXITED</a>(status) -> bool<br> + <br> +Return true if the process returning 'status' exited using the exit()<br> +system call.</tt></dd></dl> + <dl><dt><a name="-WIFSIGNALED"><strong>WIFSIGNALED</strong></a>(...)</dt><dd><tt><a href="#-WIFSIGNALED">WIFSIGNALED</a>(status) -> bool<br> + <br> +Return True if the process returning 'status' was terminated by a signal.</tt></dd></dl> + <dl><dt><a name="-WIFSTOPPED"><strong>WIFSTOPPED</strong></a>(...)</dt><dd><tt><a href="#-WIFSTOPPED">WIFSTOPPED</a>(status) -> bool<br> + <br> +Return True if the process returning 'status' was stopped.</tt></dd></dl> + <dl><dt><a name="-WSTOPSIG"><strong>WSTOPSIG</strong></a>(...)</dt><dd><tt><a href="#-WSTOPSIG">WSTOPSIG</a>(status) -> integer<br> + <br> +Return the signal that stopped the process that provided<br> +the 'status' value.</tt></dd></dl> + <dl><dt><a name="-WTERMSIG"><strong>WTERMSIG</strong></a>(...)</dt><dd><tt><a href="#-WTERMSIG">WTERMSIG</a>(status) -> integer<br> + <br> +Return the signal that terminated the process that provided the 'status'<br> +value.</tt></dd></dl> + <dl><dt><a name="-abort"><strong>abort</strong></a>(...)</dt><dd><tt><a href="#-abort">abort</a>() -> does not return!<br> + <br> +Abort the interpreter immediately. This 'dumps core' or otherwise fails<br> +in the hardest way possible on the hosting operating system.</tt></dd></dl> + <dl><dt><a name="-access"><strong>access</strong></a>(...)</dt><dd><tt><a href="#-access">access</a>(path, mode) -> True if granted, False otherwise<br> + <br> +Use the real uid/gid to test for access to a path. Note that most<br> +operations will use the effective uid/gid, therefore this routine can<br> +be used in a suid/sgid environment to test if the invoking user has the<br> +specified access to the path. The mode argument can be F_OK to test<br> +existence, or the inclusive-OR of R_OK, W_OK, and X_OK.</tt></dd></dl> + <dl><dt><a name="-chdir"><strong>chdir</strong></a>(...)</dt><dd><tt><a href="#-chdir">chdir</a>(path)<br> + <br> +Change the current working directory to the specified path.</tt></dd></dl> + <dl><dt><a name="-chmod"><strong>chmod</strong></a>(...)</dt><dd><tt><a href="#-chmod">chmod</a>(path, mode)<br> + <br> +Change the access permissions of a file.</tt></dd></dl> + <dl><dt><a name="-chown"><strong>chown</strong></a>(...)</dt><dd><tt><a href="#-chown">chown</a>(path, uid, gid)<br> + <br> +Change the owner and group id of path to the numeric uid and gid.</tt></dd></dl> + <dl><dt><a name="-chroot"><strong>chroot</strong></a>(...)</dt><dd><tt><a href="#-chroot">chroot</a>(path)<br> + <br> +Change root directory to path.</tt></dd></dl> + <dl><dt><a name="-close"><strong>close</strong></a>(...)</dt><dd><tt><a href="#-close">close</a>(fd)<br> + <br> +Close a file descriptor (for low level IO).</tt></dd></dl> + <dl><dt><a name="-closerange"><strong>closerange</strong></a>(...)</dt><dd><tt><a href="#-closerange">closerange</a>(fd_low, fd_high)<br> + <br> +Closes all file descriptors in [fd_low, fd_high), ignoring errors.</tt></dd></dl> + <dl><dt><a name="-confstr"><strong>confstr</strong></a>(...)</dt><dd><tt><a href="#-confstr">confstr</a>(name) -> string<br> + <br> +Return a string-valued system configuration variable.</tt></dd></dl> + <dl><dt><a name="-ctermid"><strong>ctermid</strong></a>(...)</dt><dd><tt><a href="#-ctermid">ctermid</a>() -> string<br> + <br> +Return the name of the controlling terminal for this process.</tt></dd></dl> + <dl><dt><a name="-device_encoding"><strong>device_encoding</strong></a>(...)</dt><dd><tt><a href="#-device_encoding">device_encoding</a>(fd) -> str<br> + <br> +Return a string describing the encoding of the device<br> +if the output is a terminal; else return None.</tt></dd></dl> + <dl><dt><a name="-dup"><strong>dup</strong></a>(...)</dt><dd><tt><a href="#-dup">dup</a>(fd) -> fd2<br> + <br> +Return a duplicate of a file descriptor.</tt></dd></dl> + <dl><dt><a name="-dup2"><strong>dup2</strong></a>(...)</dt><dd><tt><a href="#-dup2">dup2</a>(old_fd, new_fd)<br> + <br> +Duplicate file descriptor.</tt></dd></dl> + <dl><dt><a name="-execl"><strong>execl</strong></a>(file, *args)</dt><dd><tt><a href="#-execl">execl</a>(file, *args)<br> + <br> +Execute the executable file with argument list args, replacing the<br> +current process.</tt></dd></dl> + <dl><dt><a name="-execle"><strong>execle</strong></a>(file, *args)</dt><dd><tt><a href="#-execle">execle</a>(file, *args, env)<br> + <br> +Execute the executable file with argument list args and<br> +environment env, replacing the current process.</tt></dd></dl> + <dl><dt><a name="-execlp"><strong>execlp</strong></a>(file, *args)</dt><dd><tt><a href="#-execlp">execlp</a>(file, *args)<br> + <br> +Execute the executable file (which is searched for along $PATH)<br> +with argument list args, replacing the current process.</tt></dd></dl> + <dl><dt><a name="-execlpe"><strong>execlpe</strong></a>(file, *args)</dt><dd><tt><a href="#-execlpe">execlpe</a>(file, *args, env)<br> + <br> +Execute the executable file (which is searched for along $PATH)<br> +with argument list args and environment env, replacing the current<br> +process.</tt></dd></dl> + <dl><dt><a name="-execv"><strong>execv</strong></a>(...)</dt><dd><tt><a href="#-execv">execv</a>(path, args)<br> + <br> +Execute an executable path with arguments, replacing current process.<br> + <br> + path: path of executable file<br> + args: tuple or list of strings</tt></dd></dl> + <dl><dt><a name="-execve"><strong>execve</strong></a>(...)</dt><dd><tt><a href="#-execve">execve</a>(path, args, env)<br> + <br> +Execute a path with arguments and environment, replacing current process.<br> + <br> + path: path of executable file<br> + args: tuple or list of arguments<br> + env: dictionary of strings mapping to strings</tt></dd></dl> + <dl><dt><a name="-execvp"><strong>execvp</strong></a>(file, args)</dt><dd><tt>execp(file, args)<br> + <br> +Execute the executable file (which is searched for along $PATH)<br> +with argument list args, replacing the current process.<br> +args may be a list or tuple of strings.</tt></dd></dl> + <dl><dt><a name="-execvpe"><strong>execvpe</strong></a>(file, args, env)</dt><dd><tt><a href="#-execvpe">execvpe</a>(file, args, env)<br> + <br> +Execute the executable file (which is searched for along $PATH)<br> +with argument list args and environment env , replacing the<br> +current process.<br> +args may be a list or tuple of strings.</tt></dd></dl> + <dl><dt><a name="-fchdir"><strong>fchdir</strong></a>(...)</dt><dd><tt><a href="#-fchdir">fchdir</a>(fildes)<br> + <br> +Change to the directory of the given file descriptor. fildes must be<br> +opened on a directory, not a file.</tt></dd></dl> + <dl><dt><a name="-fchmod"><strong>fchmod</strong></a>(...)</dt><dd><tt><a href="#-fchmod">fchmod</a>(fd, mode)<br> + <br> +Change the access permissions of the file given by file<br> +descriptor fd.</tt></dd></dl> + <dl><dt><a name="-fchown"><strong>fchown</strong></a>(...)</dt><dd><tt><a href="#-fchown">fchown</a>(fd, uid, gid)<br> + <br> +Change the owner and group id of the file given by file descriptor<br> +fd to the numeric uid and gid.</tt></dd></dl> + <dl><dt><a name="-fdatasync"><strong>fdatasync</strong></a>(...)</dt><dd><tt><a href="#-fdatasync">fdatasync</a>(fildes)<br> + <br> +force write of file with filedescriptor to disk.<br> + does not force update of metadata.</tt></dd></dl> + <dl><dt><a name="-fork"><strong>fork</strong></a>(...)</dt><dd><tt><a href="#-fork">fork</a>() -> pid<br> + <br> +Fork a child process.<br> +Return 0 to child process and PID of child to parent process.</tt></dd></dl> + <dl><dt><a name="-forkpty"><strong>forkpty</strong></a>(...)</dt><dd><tt><a href="#-forkpty">forkpty</a>() -> (pid, master_fd)<br> + <br> +Fork a new process with a new pseudo-terminal as controlling tty.<br> + <br> +Like <a href="#-fork">fork</a>(), return 0 as pid to child process, and PID of child to parent.<br> +To both, return fd of newly opened pseudo-terminal.</tt></dd></dl> + <dl><dt><a name="-fpathconf"><strong>fpathconf</strong></a>(...)</dt><dd><tt><a href="#-fpathconf">fpathconf</a>(fd, name) -> integer<br> + <br> +Return the configuration limit name for the file descriptor fd.<br> +If there is no limit, return -1.</tt></dd></dl> + <dl><dt><a name="-fstat"><strong>fstat</strong></a>(...)</dt><dd><tt><a href="#-fstat">fstat</a>(fd) -> stat result<br> + <br> +Like <a href="#-stat">stat</a>(), but for an open file descriptor.</tt></dd></dl> + <dl><dt><a name="-fstatvfs"><strong>fstatvfs</strong></a>(...)</dt><dd><tt><a href="#-fstatvfs">fstatvfs</a>(fd) -> statvfs result<br> + <br> +Perform an fstatvfs system call on the given fd.</tt></dd></dl> + <dl><dt><a name="-fsync"><strong>fsync</strong></a>(...)</dt><dd><tt><a href="#-fsync">fsync</a>(fildes)<br> + <br> +force write of file with filedescriptor to disk.</tt></dd></dl> + <dl><dt><a name="-ftruncate"><strong>ftruncate</strong></a>(...)</dt><dd><tt><a href="#-ftruncate">ftruncate</a>(fd, length)<br> + <br> +Truncate a file to a specified length.</tt></dd></dl> + <dl><dt><a name="-getcwd"><strong>getcwd</strong></a>(...)</dt><dd><tt><a href="#-getcwd">getcwd</a>() -> path<br> + <br> +Return a unicode string representing the current working directory.</tt></dd></dl> + <dl><dt><a name="-getcwdb"><strong>getcwdb</strong></a>(...)</dt><dd><tt><a href="#-getcwdb">getcwdb</a>() -> path<br> + <br> +Return a bytes string representing the current working directory.</tt></dd></dl> + <dl><dt><a name="-getegid"><strong>getegid</strong></a>(...)</dt><dd><tt><a href="#-getegid">getegid</a>() -> egid<br> + <br> +Return the current process's effective group id.</tt></dd></dl> + <dl><dt><a name="-getenv"><strong>getenv</strong></a>(key, default<font color="#909090">=None</font>)</dt><dd><tt>Get an environment variable, return None if it doesn't exist.<br> +The optional second argument can specify an alternate default.</tt></dd></dl> + <dl><dt><a name="-geteuid"><strong>geteuid</strong></a>(...)</dt><dd><tt><a href="#-geteuid">geteuid</a>() -> euid<br> + <br> +Return the current process's effective user id.</tt></dd></dl> + <dl><dt><a name="-getgid"><strong>getgid</strong></a>(...)</dt><dd><tt><a href="#-getgid">getgid</a>() -> gid<br> + <br> +Return the current process's group id.</tt></dd></dl> + <dl><dt><a name="-getgroups"><strong>getgroups</strong></a>(...)</dt><dd><tt><a href="#-getgroups">getgroups</a>() -> list of group IDs<br> + <br> +Return list of supplemental group IDs for the process.</tt></dd></dl> + <dl><dt><a name="-getloadavg"><strong>getloadavg</strong></a>(...)</dt><dd><tt><a href="#-getloadavg">getloadavg</a>() -> (float, float, float)<br> + <br> +Return the number of processes in the system run queue averaged over<br> +the last 1, 5, and 15 minutes or raises OSError if the load average<br> +was unobtainable</tt></dd></dl> + <dl><dt><a name="-getlogin"><strong>getlogin</strong></a>(...)</dt><dd><tt><a href="#-getlogin">getlogin</a>() -> string<br> + <br> +Return the actual login name.</tt></dd></dl> + <dl><dt><a name="-getpgid"><strong>getpgid</strong></a>(...)</dt><dd><tt><a href="#-getpgid">getpgid</a>(pid) -> pgid<br> + <br> +Call the system call <a href="#-getpgid">getpgid</a>().</tt></dd></dl> + <dl><dt><a name="-getpgrp"><strong>getpgrp</strong></a>(...)</dt><dd><tt><a href="#-getpgrp">getpgrp</a>() -> pgrp<br> + <br> +Return the current process group id.</tt></dd></dl> + <dl><dt><a name="-getpid"><strong>getpid</strong></a>(...)</dt><dd><tt><a href="#-getpid">getpid</a>() -> pid<br> + <br> +Return the current process id</tt></dd></dl> + <dl><dt><a name="-getppid"><strong>getppid</strong></a>(...)</dt><dd><tt><a href="#-getppid">getppid</a>() -> ppid<br> + <br> +Return the parent's process id.</tt></dd></dl> + <dl><dt><a name="-getsid"><strong>getsid</strong></a>(...)</dt><dd><tt><a href="#-getsid">getsid</a>(pid) -> sid<br> + <br> +Call the system call <a href="#-getsid">getsid</a>().</tt></dd></dl> + <dl><dt><a name="-getuid"><strong>getuid</strong></a>(...)</dt><dd><tt><a href="#-getuid">getuid</a>() -> uid<br> + <br> +Return the current process's user id.</tt></dd></dl> + <dl><dt><a name="-isatty"><strong>isatty</strong></a>(...)</dt><dd><tt><a href="#-isatty">isatty</a>(fd) -> bool<br> + <br> +Return True if the file descriptor 'fd' is an open file descriptor<br> +connected to the slave end of a terminal.</tt></dd></dl> + <dl><dt><a name="-kill"><strong>kill</strong></a>(...)</dt><dd><tt><a href="#-kill">kill</a>(pid, sig)<br> + <br> +Kill a process with a signal.</tt></dd></dl> + <dl><dt><a name="-killpg"><strong>killpg</strong></a>(...)</dt><dd><tt><a href="#-killpg">killpg</a>(pgid, sig)<br> + <br> +Kill a process group with a signal.</tt></dd></dl> + <dl><dt><a name="-lchown"><strong>lchown</strong></a>(...)</dt><dd><tt><a href="#-lchown">lchown</a>(path, uid, gid)<br> + <br> +Change the owner and group id of path to the numeric uid and gid.<br> +This function will not follow symbolic links.</tt></dd></dl> + <dl><dt><a name="-link"><strong>link</strong></a>(...)</dt><dd><tt><a href="#-link">link</a>(src, dst)<br> + <br> +Create a hard link to a file.</tt></dd></dl> + <dl><dt><a name="-listdir"><strong>listdir</strong></a>(...)</dt><dd><tt><a href="#-listdir">listdir</a>(path) -> list_of_strings<br> + <br> +Return a list containing the names of the entries in the directory.<br> + <br> + path: path of directory to list<br> + <br> +The list is in arbitrary order. It does not include the special<br> +entries '.' and '..' even if they are present in the directory.</tt></dd></dl> + <dl><dt><a name="-lseek"><strong>lseek</strong></a>(...)</dt><dd><tt><a href="#-lseek">lseek</a>(fd, pos, how) -> newpos<br> + <br> +Set the current position of a file descriptor.</tt></dd></dl> + <dl><dt><a name="-lstat"><strong>lstat</strong></a>(...)</dt><dd><tt><a href="#-lstat">lstat</a>(path) -> stat result<br> + <br> +Like <a href="#-stat">stat</a>(path), but do not follow symbolic links.</tt></dd></dl> + <dl><dt><a name="-major"><strong>major</strong></a>(...)</dt><dd><tt><a href="#-major">major</a>(device) -> major number<br> +Extracts a device major number from a raw device number.</tt></dd></dl> + <dl><dt><a name="-makedev"><strong>makedev</strong></a>(...)</dt><dd><tt><a href="#-makedev">makedev</a>(major, minor) -> device number<br> +Composes a raw device number from the major and minor device numbers.</tt></dd></dl> + <dl><dt><a name="-makedirs"><strong>makedirs</strong></a>(name, mode<font color="#909090">=511</font>)</dt><dd><tt><a href="#-makedirs">makedirs</a>(path [, mode=0o777])<br> + <br> +Super-mkdir; create a leaf directory and all intermediate ones.<br> +Works like mkdir, except that any intermediate path segment (not<br> +just the rightmost) will be created if it does not exist. This is<br> +recursive.</tt></dd></dl> + <dl><dt><a name="-minor"><strong>minor</strong></a>(...)</dt><dd><tt><a href="#-minor">minor</a>(device) -> minor number<br> +Extracts a device minor number from a raw device number.</tt></dd></dl> + <dl><dt><a name="-mkdir"><strong>mkdir</strong></a>(...)</dt><dd><tt><a href="#-mkdir">mkdir</a>(path [, mode=0777])<br> + <br> +Create a directory.</tt></dd></dl> + <dl><dt><a name="-mkfifo"><strong>mkfifo</strong></a>(...)</dt><dd><tt><a href="#-mkfifo">mkfifo</a>(filename [, mode=0666])<br> + <br> +Create a FIFO (a POSIX named pipe).</tt></dd></dl> + <dl><dt><a name="-mknod"><strong>mknod</strong></a>(...)</dt><dd><tt><a href="#-mknod">mknod</a>(filename [, mode=0600, device])<br> + <br> +Create a filesystem node (file, device special file or named pipe)<br> +named filename. mode specifies both the permissions to use and the<br> +type of node to be created, being combined (bitwise OR) with one of<br> +S_IFREG, S_IFCHR, S_IFBLK, and S_IFIFO. For S_IFCHR and S_IFBLK,<br> +device defines the newly created device special file (probably using<br> +os.<a href="#-makedev">makedev</a>()), otherwise it is ignored.</tt></dd></dl> + <dl><dt><a name="-nice"><strong>nice</strong></a>(...)</dt><dd><tt><a href="#-nice">nice</a>(inc) -> new_priority<br> + <br> +Decrease the priority of process by inc and return the new priority.</tt></dd></dl> + <dl><dt><a name="-open"><strong>open</strong></a>(...)</dt><dd><tt><a href="#-open">open</a>(filename, flag [, mode=0777]) -> fd<br> + <br> +Open a file (for low level IO).</tt></dd></dl> + <dl><dt><a name="-openpty"><strong>openpty</strong></a>(...)</dt><dd><tt><a href="#-openpty">openpty</a>() -> (master_fd, slave_fd)<br> + <br> +Open a pseudo-terminal, returning open fd's for both master and slave end.</tt></dd></dl> + <dl><dt><a name="-pathconf"><strong>pathconf</strong></a>(...)</dt><dd><tt><a href="#-pathconf">pathconf</a>(path, name) -> integer<br> + <br> +Return the configuration limit name for the file or directory path.<br> +If there is no limit, return -1.</tt></dd></dl> + <dl><dt><a name="-pipe"><strong>pipe</strong></a>(...)</dt><dd><tt><a href="#-pipe">pipe</a>() -> (read_end, write_end)<br> + <br> +Create a pipe.</tt></dd></dl> + <dl><dt><a name="-putenv"><strong>putenv</strong></a>(...)</dt><dd><tt><a href="#-putenv">putenv</a>(key, value)<br> + <br> +Change or add an environment variable.</tt></dd></dl> + <dl><dt><a name="-read"><strong>read</strong></a>(...)</dt><dd><tt><a href="#-read">read</a>(fd, buffersize) -> string<br> + <br> +Read a file descriptor.</tt></dd></dl> + <dl><dt><a name="-readlink"><strong>readlink</strong></a>(...)</dt><dd><tt><a href="#-readlink">readlink</a>(path) -> path<br> + <br> +Return a string representing the path to which the symbolic link points.</tt></dd></dl> + <dl><dt><a name="-remove"><strong>remove</strong></a>(...)</dt><dd><tt><a href="#-remove">remove</a>(path)<br> + <br> +Remove a file (same as <a href="#-unlink">unlink</a>(path)).</tt></dd></dl> + <dl><dt><a name="-removedirs"><strong>removedirs</strong></a>(name)</dt><dd><tt><a href="#-removedirs">removedirs</a>(path)<br> + <br> +Super-rmdir; remove a leaf directory and all empty intermediate<br> +ones. Works like rmdir except that, if the leaf directory is<br> +successfully removed, directories corresponding to rightmost path<br> +segments will be pruned away until either the whole path is<br> +consumed or an <a href="#error">error</a> occurs. Errors during this latter phase are<br> +ignored -- they generally mean that a directory was not empty.</tt></dd></dl> + <dl><dt><a name="-rename"><strong>rename</strong></a>(...)</dt><dd><tt><a href="#-rename">rename</a>(old, new)<br> + <br> +Rename a file or directory.</tt></dd></dl> + <dl><dt><a name="-renames"><strong>renames</strong></a>(old, new)</dt><dd><tt><a href="#-renames">renames</a>(old, new)<br> + <br> +Super-rename; create directories as necessary and delete any left<br> +empty. Works like rename, except creation of any intermediate<br> +directories needed to make the new pathname good is attempted<br> +first. After the rename, directories corresponding to rightmost<br> +path segments of the old name will be pruned way until either the<br> +whole path is consumed or a nonempty directory is found.<br> + <br> +Note: this function can fail with the new directory structure made<br> +if you lack permissions needed to unlink the leaf directory or<br> +file.</tt></dd></dl> + <dl><dt><a name="-rmdir"><strong>rmdir</strong></a>(...)</dt><dd><tt><a href="#-rmdir">rmdir</a>(path)<br> + <br> +Remove a directory.</tt></dd></dl> + <dl><dt><a name="-setegid"><strong>setegid</strong></a>(...)</dt><dd><tt><a href="#-setegid">setegid</a>(gid)<br> + <br> +Set the current process's effective group id.</tt></dd></dl> + <dl><dt><a name="-seteuid"><strong>seteuid</strong></a>(...)</dt><dd><tt><a href="#-seteuid">seteuid</a>(uid)<br> + <br> +Set the current process's effective user id.</tt></dd></dl> + <dl><dt><a name="-setgid"><strong>setgid</strong></a>(...)</dt><dd><tt><a href="#-setgid">setgid</a>(gid)<br> + <br> +Set the current process's group id.</tt></dd></dl> + <dl><dt><a name="-setgroups"><strong>setgroups</strong></a>(...)</dt><dd><tt><a href="#-setgroups">setgroups</a>(list)<br> + <br> +Set the groups of the current process to list.</tt></dd></dl> + <dl><dt><a name="-setpgid"><strong>setpgid</strong></a>(...)</dt><dd><tt><a href="#-setpgid">setpgid</a>(pid, pgrp)<br> + <br> +Call the system call <a href="#-setpgid">setpgid</a>().</tt></dd></dl> + <dl><dt><a name="-setpgrp"><strong>setpgrp</strong></a>(...)</dt><dd><tt><a href="#-setpgrp">setpgrp</a>()<br> + <br> +Make this process a session leader.</tt></dd></dl> + <dl><dt><a name="-setregid"><strong>setregid</strong></a>(...)</dt><dd><tt><a href="#-setregid">setregid</a>(rgid, egid)<br> + <br> +Set the current process's real and effective group ids.</tt></dd></dl> + <dl><dt><a name="-setreuid"><strong>setreuid</strong></a>(...)</dt><dd><tt><a href="#-setreuid">setreuid</a>(ruid, euid)<br> + <br> +Set the current process's real and effective user ids.</tt></dd></dl> + <dl><dt><a name="-setsid"><strong>setsid</strong></a>(...)</dt><dd><tt><a href="#-setsid">setsid</a>()<br> + <br> +Call the system call <a href="#-setsid">setsid</a>().</tt></dd></dl> + <dl><dt><a name="-setuid"><strong>setuid</strong></a>(...)</dt><dd><tt><a href="#-setuid">setuid</a>(uid)<br> + <br> +Set the current process's user id.</tt></dd></dl> + <dl><dt><a name="-spawnl"><strong>spawnl</strong></a>(mode, file, *args)</dt><dd><tt><a href="#-spawnl">spawnl</a>(mode, file, *args) -> integer<br> + <br> +Execute file with arguments from args in a subprocess.<br> +If mode == P_NOWAIT return the pid of the process.<br> +If mode == P_WAIT return the process's exit code if it exits normally;<br> +otherwise return -SIG, where SIG is the signal that killed it.</tt></dd></dl> + <dl><dt><a name="-spawnle"><strong>spawnle</strong></a>(mode, file, *args)</dt><dd><tt><a href="#-spawnle">spawnle</a>(mode, file, *args, env) -> integer<br> + <br> +Execute file with arguments from args in a subprocess with the<br> +supplied environment.<br> +If mode == P_NOWAIT return the pid of the process.<br> +If mode == P_WAIT return the process's exit code if it exits normally;<br> +otherwise return -SIG, where SIG is the signal that killed it.</tt></dd></dl> + <dl><dt><a name="-spawnlp"><strong>spawnlp</strong></a>(mode, file, *args)</dt><dd><tt><a href="#-spawnlp">spawnlp</a>(mode, file, *args) -> integer<br> + <br> +Execute file (which is looked for along $PATH) with arguments from<br> +args in a subprocess with the supplied environment.<br> +If mode == P_NOWAIT return the pid of the process.<br> +If mode == P_WAIT return the process's exit code if it exits normally;<br> +otherwise return -SIG, where SIG is the signal that killed it.</tt></dd></dl> + <dl><dt><a name="-spawnlpe"><strong>spawnlpe</strong></a>(mode, file, *args)</dt><dd><tt><a href="#-spawnlpe">spawnlpe</a>(mode, file, *args, env) -> integer<br> + <br> +Execute file (which is looked for along $PATH) with arguments from<br> +args in a subprocess with the supplied environment.<br> +If mode == P_NOWAIT return the pid of the process.<br> +If mode == P_WAIT return the process's exit code if it exits normally;<br> +otherwise return -SIG, where SIG is the signal that killed it.</tt></dd></dl> + <dl><dt><a name="-spawnv"><strong>spawnv</strong></a>(mode, file, args)</dt><dd><tt><a href="#-spawnv">spawnv</a>(mode, file, args) -> integer<br> + <br> +Execute file with arguments from args in a subprocess.<br> +If mode == P_NOWAIT return the pid of the process.<br> +If mode == P_WAIT return the process's exit code if it exits normally;<br> +otherwise return -SIG, where SIG is the signal that killed it.</tt></dd></dl> + <dl><dt><a name="-spawnve"><strong>spawnve</strong></a>(mode, file, args, env)</dt><dd><tt><a href="#-spawnve">spawnve</a>(mode, file, args, env) -> integer<br> + <br> +Execute file with arguments from args in a subprocess with the<br> +specified environment.<br> +If mode == P_NOWAIT return the pid of the process.<br> +If mode == P_WAIT return the process's exit code if it exits normally;<br> +otherwise return -SIG, where SIG is the signal that killed it.</tt></dd></dl> + <dl><dt><a name="-spawnvp"><strong>spawnvp</strong></a>(mode, file, args)</dt><dd><tt><a href="#-spawnvp">spawnvp</a>(mode, file, args) -> integer<br> + <br> +Execute file (which is looked for along $PATH) with arguments from<br> +args in a subprocess.<br> +If mode == P_NOWAIT return the pid of the process.<br> +If mode == P_WAIT return the process's exit code if it exits normally;<br> +otherwise return -SIG, where SIG is the signal that killed it.</tt></dd></dl> + <dl><dt><a name="-spawnvpe"><strong>spawnvpe</strong></a>(mode, file, args, env)</dt><dd><tt><a href="#-spawnvpe">spawnvpe</a>(mode, file, args, env) -> integer<br> + <br> +Execute file (which is looked for along $PATH) with arguments from<br> +args in a subprocess with the supplied environment.<br> +If mode == P_NOWAIT return the pid of the process.<br> +If mode == P_WAIT return the process's exit code if it exits normally;<br> +otherwise return -SIG, where SIG is the signal that killed it.</tt></dd></dl> + <dl><dt><a name="-stat"><strong>stat</strong></a>(...)</dt><dd><tt><a href="#-stat">stat</a>(path) -> stat result<br> + <br> +Perform a stat system call on the given path.</tt></dd></dl> + <dl><dt><a name="-stat_float_times"><strong>stat_float_times</strong></a>(...)</dt><dd><tt><a href="#-stat_float_times">stat_float_times</a>([newval]) -> oldval<br> + <br> +Determine whether os.[lf]stat represents time stamps as float objects.<br> +If newval is True, future calls to <a href="#-stat">stat</a>() return floats, if it is False,<br> +future calls return ints. <br> +If newval is omitted, return the current setting.</tt></dd></dl> + <dl><dt><a name="-statvfs"><strong>statvfs</strong></a>(...)</dt><dd><tt><a href="#-statvfs">statvfs</a>(path) -> statvfs result<br> + <br> +Perform a statvfs system call on the given path.</tt></dd></dl> + <dl><dt><a name="-strerror"><strong>strerror</strong></a>(...)</dt><dd><tt><a href="#-strerror">strerror</a>(code) -> string<br> + <br> +Translate an <a href="#error">error</a> code to a message string.</tt></dd></dl> + <dl><dt><a name="-symlink"><strong>symlink</strong></a>(...)</dt><dd><tt><a href="#-symlink">symlink</a>(src, dst)<br> + <br> +Create a symbolic link pointing to src named dst.</tt></dd></dl> + <dl><dt><a name="-sysconf"><strong>sysconf</strong></a>(...)</dt><dd><tt><a href="#-sysconf">sysconf</a>(name) -> integer<br> + <br> +Return an integer-valued system configuration variable.</tt></dd></dl> + <dl><dt><a name="-system"><strong>system</strong></a>(...)</dt><dd><tt><a href="#-system">system</a>(command) -> exit_status<br> + <br> +Execute the command (a string) in a subshell.</tt></dd></dl> + <dl><dt><a name="-tcgetpgrp"><strong>tcgetpgrp</strong></a>(...)</dt><dd><tt><a href="#-tcgetpgrp">tcgetpgrp</a>(fd) -> pgid<br> + <br> +Return the process group associated with the terminal given by a fd.</tt></dd></dl> + <dl><dt><a name="-tcsetpgrp"><strong>tcsetpgrp</strong></a>(...)</dt><dd><tt><a href="#-tcsetpgrp">tcsetpgrp</a>(fd, pgid)<br> + <br> +Set the process group associated with the terminal given by a fd.</tt></dd></dl> + <dl><dt><a name="-times"><strong>times</strong></a>(...)</dt><dd><tt><a href="#-times">times</a>() -> (utime, stime, cutime, cstime, elapsed_time)<br> + <br> +Return a tuple of floating point numbers indicating process times.</tt></dd></dl> + <dl><dt><a name="-ttyname"><strong>ttyname</strong></a>(...)</dt><dd><tt><a href="#-ttyname">ttyname</a>(fd) -> string<br> + <br> +Return the name of the terminal device connected to 'fd'.</tt></dd></dl> + <dl><dt><a name="-umask"><strong>umask</strong></a>(...)</dt><dd><tt><a href="#-umask">umask</a>(new_mask) -> old_mask<br> + <br> +Set the current numeric umask and return the previous umask.</tt></dd></dl> + <dl><dt><a name="-uname"><strong>uname</strong></a>(...)</dt><dd><tt><a href="#-uname">uname</a>() -> (sysname, nodename, release, version, machine)<br> + <br> +Return a tuple identifying the current operating system.</tt></dd></dl> + <dl><dt><a name="-unlink"><strong>unlink</strong></a>(...)</dt><dd><tt><a href="#-unlink">unlink</a>(path)<br> + <br> +Remove a file (same as <a href="#-remove">remove</a>(path)).</tt></dd></dl> + <dl><dt><a name="-unsetenv"><strong>unsetenv</strong></a>(...)</dt><dd><tt><a href="#-unsetenv">unsetenv</a>(key)<br> + <br> +Delete an environment variable.</tt></dd></dl> + <dl><dt><a name="-utime"><strong>utime</strong></a>(...)</dt><dd><tt><a href="#-utime">utime</a>(path, (atime, mtime))<br> +<a href="#-utime">utime</a>(path, None)<br> + <br> +Set the access and modified time of the file to the given values. If the<br> +second form is used, set the access and modified times to the current time.</tt></dd></dl> + <dl><dt><a name="-wait"><strong>wait</strong></a>(...)</dt><dd><tt><a href="#-wait">wait</a>() -> (pid, status)<br> + <br> +Wait for completion of a child process.</tt></dd></dl> + <dl><dt><a name="-wait3"><strong>wait3</strong></a>(...)</dt><dd><tt><a href="#-wait3">wait3</a>(options) -> (pid, status, rusage)<br> + <br> +Wait for completion of a child process.</tt></dd></dl> + <dl><dt><a name="-wait4"><strong>wait4</strong></a>(...)</dt><dd><tt><a href="#-wait4">wait4</a>(pid, options) -> (pid, status, rusage)<br> + <br> +Wait for completion of a given child process.</tt></dd></dl> + <dl><dt><a name="-waitpid"><strong>waitpid</strong></a>(...)</dt><dd><tt><a href="#-waitpid">waitpid</a>(pid, options) -> (pid, status)<br> + <br> +Wait for completion of a given child process.</tt></dd></dl> + <dl><dt><a name="-walk"><strong>walk</strong></a>(top, topdown<font color="#909090">=True</font>, onerror<font color="#909090">=None</font>, followlinks<font color="#909090">=False</font>)</dt><dd><tt>Directory tree generator.<br> + <br> +For each directory in the directory tree rooted at top (including top<br> +itself, but excluding '.' and '..'), yields a 3-tuple<br> + <br> + dirpath, dirnames, filenames<br> + <br> +dirpath is a string, the path to the directory. dirnames is a list of<br> +the names of the subdirectories in dirpath (excluding '.' and '..').<br> +filenames is a list of the names of the non-directory files in dirpath.<br> +Note that the names in the lists are just names, with no path components.<br> +To get a full path (which begins with top) to a file or directory in<br> +dirpath, do os.path.join(dirpath, name).<br> + <br> +If optional arg 'topdown' is true or not specified, the triple for a<br> +directory is generated before the triples for any of its subdirectories<br> +(directories are generated top down). If topdown is false, the triple<br> +for a directory is generated after the triples for all of its<br> +subdirectories (directories are generated bottom up).<br> + <br> +When topdown is true, the caller can modify the dirnames list in-place<br> +(e.g., via del or slice assignment), and walk will only recurse into the<br> +subdirectories whose names remain in dirnames; this can be used to prune<br> +the search, or to impose a specific order of visiting. Modifying<br> +dirnames when topdown is false is ineffective, since the directories in<br> +dirnames have already been generated by the time dirnames itself is<br> +generated.<br> + <br> +By default errors from the os.<a href="#-listdir">listdir</a>() call are ignored. If<br> +optional arg 'onerror' is specified, it should be a function; it<br> +will be called with one argument, an os.<a href="#error">error</a> instance. It can<br> +report the <a href="#error">error</a> to continue with the walk, or raise the exception<br> +to abort the walk. Note that the filename is available as the<br> +filename attribute of the exception <a href="builtins.html#object">object</a>.<br> + <br> +By default, os.walk does not follow symbolic links to subdirectories on<br> +systems that support them. In order to get this functionality, set the<br> +optional argument 'followlinks' to true.<br> + <br> +Caution: if you pass a relative pathname for top, don't change the<br> +current working directory between resumptions of walk. walk never<br> +changes the current directory, and assumes that the client doesn't<br> +either.<br> + <br> +Example:<br> + <br> +import os<br> +from os.path import join, getsize<br> +for root, dirs, files in os.<a href="#-walk">walk</a>('python/Lib/email'):<br> + print(root, "consumes", end="")<br> + print(sum([getsize(join(root, name)) for name in files]), end="")<br> + print("bytes in", len(files), "non-directory files")<br> + if 'CVS' in dirs:<br> + dirs.<a href="#-remove">remove</a>('CVS') # don't visit CVS directories</tt></dd></dl> + <dl><dt><a name="-write"><strong>write</strong></a>(...)</dt><dd><tt><a href="#-write">write</a>(fd, string) -> byteswritten<br> + <br> +Write a string to a file descriptor.</tt></dd></dl> +</td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#55aa55"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> + +<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> +<td width="100%"><strong>EX_CANTCREAT</strong> = 73<br> +<strong>EX_CONFIG</strong> = 78<br> +<strong>EX_DATAERR</strong> = 65<br> +<strong>EX_IOERR</strong> = 74<br> +<strong>EX_NOHOST</strong> = 68<br> +<strong>EX_NOINPUT</strong> = 66<br> +<strong>EX_NOPERM</strong> = 77<br> +<strong>EX_NOUSER</strong> = 67<br> +<strong>EX_OK</strong> = 0<br> +<strong>EX_OSERR</strong> = 71<br> +<strong>EX_OSFILE</strong> = 72<br> +<strong>EX_PROTOCOL</strong> = 76<br> +<strong>EX_SOFTWARE</strong> = 70<br> +<strong>EX_TEMPFAIL</strong> = 75<br> +<strong>EX_UNAVAILABLE</strong> = 69<br> +<strong>EX_USAGE</strong> = 64<br> +<strong>F_OK</strong> = 0<br> +<strong>NGROUPS_MAX</strong> = 65536<br> +<strong>O_APPEND</strong> = 1024<br> +<strong>O_ASYNC</strong> = 8192<br> +<strong>O_CREAT</strong> = 64<br> +<strong>O_DIRECT</strong> = 16384<br> +<strong>O_DIRECTORY</strong> = 65536<br> +<strong>O_DSYNC</strong> = 4096<br> +<strong>O_EXCL</strong> = 128<br> +<strong>O_LARGEFILE</strong> = 0<br> +<strong>O_NDELAY</strong> = 2048<br> +<strong>O_NOATIME</strong> = 262144<br> +<strong>O_NOCTTY</strong> = 256<br> +<strong>O_NOFOLLOW</strong> = 131072<br> +<strong>O_NONBLOCK</strong> = 2048<br> +<strong>O_RDONLY</strong> = 0<br> +<strong>O_RDWR</strong> = 2<br> +<strong>O_RSYNC</strong> = 4096<br> +<strong>O_SYNC</strong> = 4096<br> +<strong>O_TRUNC</strong> = 512<br> +<strong>O_WRONLY</strong> = 1<br> +<strong>R_OK</strong> = 4<br> +<strong>SEEK_CUR</strong> = 1<br> +<strong>SEEK_END</strong> = 2<br> +<strong>SEEK_SET</strong> = 0<br> +<strong>TMP_MAX</strong> = 238328<br> +<strong>WCONTINUED</strong> = 8<br> +<strong>WNOHANG</strong> = 1<br> +<strong>WUNTRACED</strong> = 2<br> +<strong>W_OK</strong> = 2<br> +<strong>X_OK</strong> = 1<br> +<strong>__all__</strong> = ['altsep', 'curdir', 'pardir', 'sep', 'pathsep', 'linesep', 'defpath', 'name', 'path', 'devnull', 'SEEK_SET', 'SEEK_CUR', 'SEEK_END', 'EX_CANTCREAT', 'EX_CONFIG', 'EX_DATAERR', 'EX_IOERR', 'EX_NOHOST', 'EX_NOINPUT', 'EX_NOPERM', ...]<br> +<strong>altsep</strong> = None<br> +<strong>confstr_names</strong> = {'CS_LFS64_CFLAGS': 1004, 'CS_LFS64_LDFLAGS': 1005, 'CS_LFS64_LIBS': 1006, 'CS_LFS64_LINTFLAGS': 1007, 'CS_LFS_CFLAGS': 1000, 'CS_LFS_LDFLAGS': 1001, 'CS_LFS_LIBS': 1002, 'CS_LFS_LINTFLAGS': 1003, 'CS_PATH': 0, 'CS_XBS5_ILP32_OFF32_CFLAGS': 1100, ...}<br> +<strong>curdir</strong> = '.'<br> +<strong>defpath</strong> = ':/bin:/usr/bin'<br> +<strong>devnull</strong> = '/dev/null'<br> +<strong>environ</strong> = <os._Environ object at 0x7f327c987e50><br> +<strong>linesep</strong> = '<font color="#c040c0">\n</font>'<br> +<strong>name</strong> = 'posix'<br> +<strong>pardir</strong> = '..'<br> +<strong>pathconf_names</strong> = {'PC_ASYNC_IO': 10, 'PC_CHOWN_RESTRICTED': 6, 'PC_FILESIZEBITS': 13, 'PC_LINK_MAX': 0, 'PC_MAX_CANON': 1, 'PC_MAX_INPUT': 2, 'PC_NAME_MAX': 3, 'PC_NO_TRUNC': 7, 'PC_PATH_MAX': 4, 'PC_PIPE_BUF': 5, ...}<br> +<strong>pathsep</strong> = ':'<br> +<strong>sep</strong> = '/'<br> +<strong>sysconf_names</strong> = {'SC_2_CHAR_TERM': 95, 'SC_2_C_BIND': 47, 'SC_2_C_DEV': 48, 'SC_2_C_VERSION': 96, 'SC_2_FORT_DEV': 49, 'SC_2_FORT_RUN': 50, 'SC_2_LOCALEDEF': 52, 'SC_2_SW_DEV': 51, 'SC_2_UPE': 97, 'SC_2_VERSION': 46, ...}</td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/os.path.html b/doc/os.path.html new file mode 100644 index 00000000..a5b893f5 --- /dev/null +++ b/doc/os.path.html @@ -0,0 +1,95 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module posixpath</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>posixpath</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/lib/python3.1/posixpath.py">/usr/lib/python3.1/posixpath.py</a><br><a href="http://docs.python.org/library/posixpath">Module Docs</a></font></td></tr></table> + <p><tt>Common operations on Posix pathnames.<br> + <br> +Instead of importing this module directly, import os and refer to<br> +this module as os.path. The "os.path" name is an alias for this<br> +module on Posix systems; on other systems (e.g. Mac, Windows),<br> +os.path provides the same operations in a manner specific to that<br> +platform, and is an alias to another module (e.g. macpath, ntpath).<br> + <br> +Some of this can actually be useful on non-Posix systems too, e.g.<br> +for manipulation of the pathname component of URLs.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</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="genericpath.html">genericpath</a><br> +</td><td width="25%" valign=top><a href="os.html">os</a><br> +</td><td width="25%" valign=top><a href="stat.html">stat</a><br> +</td><td width="25%" valign=top><a href="sys.html">sys</a><br> +</td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#eeaa77"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> + +<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt><a name="-abspath"><strong>abspath</strong></a>(path)</dt><dd><tt>Return an absolute path.</tt></dd></dl> + <dl><dt><a name="-basename"><strong>basename</strong></a>(p)</dt><dd><tt>Returns the final component of a pathname</tt></dd></dl> + <dl><dt><a name="-commonprefix"><strong>commonprefix</strong></a>(m)</dt><dd><tt>Given a list of pathnames, returns the longest common leading component</tt></dd></dl> + <dl><dt><a name="-dirname"><strong>dirname</strong></a>(p)</dt><dd><tt>Returns the directory component of a pathname</tt></dd></dl> + <dl><dt><a name="-exists"><strong>exists</strong></a>(path)</dt><dd><tt>Test whether a path exists. Returns False for broken symbolic links</tt></dd></dl> + <dl><dt><a name="-expanduser"><strong>expanduser</strong></a>(path)</dt><dd><tt>Expand ~ and ~user constructions. If user or $HOME is unknown,<br> +do nothing.</tt></dd></dl> + <dl><dt><a name="-expandvars"><strong>expandvars</strong></a>(path)</dt><dd><tt>Expand shell variables of form $var and ${var}. Unknown variables<br> +are left unchanged.</tt></dd></dl> + <dl><dt><a name="-getatime"><strong>getatime</strong></a>(filename)</dt><dd><tt>Return the last access time of a file, reported by os.stat().</tt></dd></dl> + <dl><dt><a name="-getctime"><strong>getctime</strong></a>(filename)</dt><dd><tt>Return the metadata change time of a file, reported by os.stat().</tt></dd></dl> + <dl><dt><a name="-getmtime"><strong>getmtime</strong></a>(filename)</dt><dd><tt>Return the last modification time of a file, reported by os.stat().</tt></dd></dl> + <dl><dt><a name="-getsize"><strong>getsize</strong></a>(filename)</dt><dd><tt>Return the size of a file, reported by os.stat().</tt></dd></dl> + <dl><dt><a name="-isabs"><strong>isabs</strong></a>(s)</dt><dd><tt>Test whether a path is absolute</tt></dd></dl> + <dl><dt><a name="-isdir"><strong>isdir</strong></a>(s)</dt><dd><tt>Return true if the pathname refers to an existing directory.</tt></dd></dl> + <dl><dt><a name="-isfile"><strong>isfile</strong></a>(path)</dt><dd><tt>Test whether a path is a regular file</tt></dd></dl> + <dl><dt><a name="-islink"><strong>islink</strong></a>(path)</dt><dd><tt>Test whether a path is a symbolic link</tt></dd></dl> + <dl><dt><a name="-ismount"><strong>ismount</strong></a>(path)</dt><dd><tt>Test whether a path is a mount point</tt></dd></dl> + <dl><dt><a name="-join"><strong>join</strong></a>(a, *p)</dt><dd><tt>Join two or more pathname components, inserting '/' as needed.<br> +If any component is an absolute path, all previous path components<br> +will be discarded.</tt></dd></dl> + <dl><dt><a name="-lexists"><strong>lexists</strong></a>(path)</dt><dd><tt>Test whether a path exists. Returns True for broken symbolic links</tt></dd></dl> + <dl><dt><a name="-normcase"><strong>normcase</strong></a>(s)</dt><dd><tt>Normalize case of pathname. Has no effect under Posix</tt></dd></dl> + <dl><dt><a name="-normpath"><strong>normpath</strong></a>(path)</dt><dd><tt>Normalize path, eliminating double slashes, etc.</tt></dd></dl> + <dl><dt><a name="-realpath"><strong>realpath</strong></a>(filename)</dt><dd><tt>Return the canonical path of the specified filename, eliminating any<br> +symbolic links encountered in the path.</tt></dd></dl> + <dl><dt><a name="-relpath"><strong>relpath</strong></a>(path, start<font color="#909090">=None</font>)</dt><dd><tt>Return a relative version of a path</tt></dd></dl> + <dl><dt><a name="-samefile"><strong>samefile</strong></a>(f1, f2)</dt><dd><tt>Test whether two pathnames reference the same actual file</tt></dd></dl> + <dl><dt><a name="-sameopenfile"><strong>sameopenfile</strong></a>(fp1, fp2)</dt><dd><tt>Test whether two open file objects reference the same file</tt></dd></dl> + <dl><dt><a name="-samestat"><strong>samestat</strong></a>(s1, s2)</dt><dd><tt>Test whether two stat buffers reference the same file</tt></dd></dl> + <dl><dt><a name="-split"><strong>split</strong></a>(p)</dt><dd><tt>Split a pathname. Returns tuple "(head, tail)" where "tail" is<br> +everything after the final slash. Either part may be empty.</tt></dd></dl> + <dl><dt><a name="-splitdrive"><strong>splitdrive</strong></a>(p)</dt><dd><tt>Split a pathname into drive and path. On Posix, drive is always<br> +empty.</tt></dd></dl> + <dl><dt><a name="-splitext"><strong>splitext</strong></a>(p)</dt><dd><tt>Split the extension from a pathname.<br> + <br> +Extension is everything from the last dot to the end, ignoring<br> +leading dots. Returns "(root, ext)"; ext may be empty.</tt></dd></dl> +</td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#55aa55"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> + +<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> +<td width="100%"><strong>__all__</strong> = ['normcase', 'isabs', 'join', 'splitdrive', 'split', 'splitext', 'basename', 'dirname', 'commonprefix', 'getsize', 'getmtime', 'getatime', 'getctime', 'islink', 'exists', 'lexists', 'isdir', 'isfile', 'ismount', 'expanduser', ...]<br> +<strong>altsep</strong> = None<br> +<strong>curdir</strong> = '.'<br> +<strong>defpath</strong> = ':/bin:/usr/bin'<br> +<strong>devnull</strong> = '/dev/null'<br> +<strong>extsep</strong> = '.'<br> +<strong>pardir</strong> = '..'<br> +<strong>pathsep</strong> = ':'<br> +<strong>sep</strong> = '/'<br> +<strong>supports_unicode_filenames</strong> = False</td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/ranger.actions.html b/doc/ranger.actions.html new file mode 100644 index 00000000..4d700dc7 --- /dev/null +++ b/doc/ranger.actions.html @@ -0,0 +1,155 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module ranger.actions</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>.actions</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/actions.py">/home/hut/work/ranger/ranger/actions.py</a></font></td></tr></table> + <p></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</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.fsobject.html">ranger.fsobject</a><br> +</td><td width="25%" valign=top><a href="os.html">os</a><br> +</td><td width="25%" valign=top><a href="shutil.html">shutil</a><br> +</td><td width="25%" valign=top></td></tr></table></td></tr></table><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.shared.html#EnvironmentAware">ranger.shared.EnvironmentAware</a>(<a href="ranger.shared.html#Awareness">ranger.shared.Awareness</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="ranger.actions.html#Actions">Actions</a>(<a href="ranger.shared.html#EnvironmentAware">ranger.shared.EnvironmentAware</a>, <a href="ranger.shared.settings.html#SettingsAware">ranger.shared.settings.SettingsAware</a>) +</font></dt></dl> +</dd> +<dt><font face="helvetica, arial"><a href="ranger.shared.settings.html#SettingsAware">ranger.shared.settings.SettingsAware</a>(<a href="builtins.html#object">builtins.object</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="ranger.actions.html#Actions">Actions</a>(<a href="ranger.shared.html#EnvironmentAware">ranger.shared.EnvironmentAware</a>, <a href="ranger.shared.settings.html#SettingsAware">ranger.shared.settings.SettingsAware</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="Actions">class <strong>Actions</strong></a>(<a href="ranger.shared.html#EnvironmentAware">ranger.shared.EnvironmentAware</a>, <a href="ranger.shared.settings.html#SettingsAware">ranger.shared.settings.SettingsAware</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.actions.html#Actions">Actions</a></dd> +<dd><a href="ranger.shared.html#EnvironmentAware">ranger.shared.EnvironmentAware</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="Actions-cd"><strong>cd</strong></a> = <a href="#Actions-enter_dir">enter_dir</a>(self, path)</dt></dl> + +<dl><dt><a name="Actions-copy"><strong>copy</strong></a>(self)</dt><dd><tt>Copy the selected items</tt></dd></dl> + +<dl><dt><a name="Actions-cut"><strong>cut</strong></a>(self)</dt></dl> + +<dl><dt><a name="Actions-delete"><strong>delete</strong></a>(self)</dt></dl> + +<dl><dt><a name="Actions-edit_file"><strong>edit_file</strong></a>(self)</dt><dd><tt>Calls execute_file with the current file and app='editor'</tt></dd></dl> + +<dl><dt><a name="Actions-enter_bookmark"><strong>enter_bookmark</strong></a>(self, key)</dt><dd><tt>Enter the bookmark with the name <key></tt></dd></dl> + +<dl><dt><a name="Actions-enter_dir"><strong>enter_dir</strong></a>(self, path)</dt><dd><tt>Enter the directory at the given path</tt></dd></dl> + +<dl><dt><a name="Actions-execute_file"><strong>execute_file</strong></a>(self, files, app<font color="#909090">=''</font>, flags<font color="#909090">=''</font>, mode<font color="#909090">=0</font>)</dt><dd><tt>Execute a file.<br> +app is the name of a method in Applications, without the "app_"<br> +flags is a string consisting of applications.ALLOWED_FLAGS<br> +mode is a positive integer.<br> +Both flags and mode specify how the program is run.</tt></dd></dl> + +<dl><dt><a name="Actions-exit"><strong>exit</strong></a>(self)</dt><dd><tt>Exit the program</tt></dd></dl> + +<dl><dt><a name="Actions-force_load_preview"><strong>force_load_preview</strong></a>(self)</dt></dl> + +<dl><dt><a name="Actions-handle_mouse"><strong>handle_mouse</strong></a>(self)</dt><dd><tt>Handle mouse-buttons if one was pressed</tt></dd></dl> + +<dl><dt><a name="Actions-history_go"><strong>history_go</strong></a>(self, relative)</dt><dd><tt>Move back and forth in the history</tt></dd></dl> + +<dl><dt><a name="Actions-interrupt"><strong>interrupt</strong></a>(self)</dt><dd><tt>Waits a short time.<br> +If CTRL+C is pressed while waiting, the program will be exited.</tt></dd></dl> + +<dl><dt><a name="Actions-mark"><strong>mark</strong></a>(self, all<font color="#909090">=False</font>, toggle<font color="#909090">=False</font>, val<font color="#909090">=None</font>, movedown<font color="#909090">=None</font>)</dt><dd><tt>A wrapper for the directory.mark_xyz functions.<br> + <br> +Arguments:<br> +all - change all files of the current directory at once?<br> +toggle - toggle the marked-status?<br> +val - mark or unmark?</tt></dd></dl> + +<dl><dt><a name="Actions-mkdir"><strong>mkdir</strong></a>(self, name)</dt></dl> + +<dl><dt><a name="Actions-move_left"><strong>move_left</strong></a>(self, n<font color="#909090">=1</font>)</dt><dd><tt>Enter the parent directory</tt></dd></dl> + +<dl><dt><a name="Actions-move_pointer"><strong>move_pointer</strong></a>(self, relative<font color="#909090">=0</font>, absolute<font color="#909090">=None</font>)</dt><dd><tt>Move the pointer down by <relative> or to <absolute></tt></dd></dl> + +<dl><dt><a name="Actions-move_pointer_by_pages"><strong>move_pointer_by_pages</strong></a>(self, relative)</dt><dd><tt>Move the pointer down by <relative> pages</tt></dd></dl> + +<dl><dt><a name="Actions-move_pointer_by_percentage"><strong>move_pointer_by_percentage</strong></a>(self, relative<font color="#909090">=0</font>, absolute<font color="#909090">=None</font>)</dt><dd><tt>Move the pointer down by <relative>% or to <absolute>%</tt></dd></dl> + +<dl><dt><a name="Actions-move_right"><strong>move_right</strong></a>(self, mode<font color="#909090">=0</font>)</dt><dd><tt>Enter the current directory or execute the current file</tt></dd></dl> + +<dl><dt><a name="Actions-notify"><strong>notify</strong></a>(self, text, duration<font color="#909090">=4</font>, bad<font color="#909090">=False</font>)</dt></dl> + +<dl><dt><a name="Actions-open_console"><strong>open_console</strong></a>(self, mode<font color="#909090">=':'</font>, string<font color="#909090">=''</font>)</dt><dd><tt>Open the console if the current UI supports that</tt></dd></dl> + +<dl><dt><a name="Actions-paste"><strong>paste</strong></a>(self)</dt><dd><tt>Paste the selected items into the current directory</tt></dd></dl> + +<dl><dt><a name="Actions-redraw_window"><strong>redraw_window</strong></a>(self)</dt><dd><tt>Redraw the window</tt></dd></dl> + +<dl><dt><a name="Actions-reset"><strong>reset</strong></a>(self)</dt><dd><tt>Reset the filemanager, clearing the directory buffer</tt></dd></dl> + +<dl><dt><a name="Actions-resize"><strong>resize</strong></a>(self)</dt><dd><tt>Update the size of the UI</tt></dd></dl> + +<dl><dt><a name="Actions-scroll"><strong>scroll</strong></a>(self, relative)</dt><dd><tt>Scroll down by <relative> lines</tt></dd></dl> + +<dl><dt><a name="Actions-search_backward"><strong>search_backward</strong></a>(self)</dt><dd><tt>Search backward for the regexp in self.<strong>env</strong>.last_search</tt></dd></dl> + +<dl><dt><a name="Actions-search_forward"><strong>search_forward</strong></a>(self)</dt><dd><tt>Search forward for the regexp in self.<strong>env</strong>.last_search</tt></dd></dl> + +<dl><dt><a name="Actions-set_bookmark"><strong>set_bookmark</strong></a>(self, key)</dt><dd><tt>Set the bookmark with the name <key> to the current directory</tt></dd></dl> + +<dl><dt><a name="Actions-sort"><strong>sort</strong></a>(self, func<font color="#909090">=None</font>, reverse<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="Actions-spawn"><strong>spawn</strong></a>(self, command)</dt></dl> + +<dl><dt><a name="Actions-toggle_boolean_option"><strong>toggle_boolean_option</strong></a>(self, string)</dt><dd><tt>Toggle a boolean option named <string></tt></dd></dl> + +<dl><dt><a name="Actions-unset_bookmark"><strong>unset_bookmark</strong></a>(self, key)</dt><dd><tt>Delete the bookmark with the name <key></tt></dd></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 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 diff --git a/doc/ranger.applications.html b/doc/ranger.applications.html new file mode 100644 index 00000000..822ec412 --- /dev/null +++ b/doc/ranger.applications.html @@ -0,0 +1,77 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module ranger.applications</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>.applications</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/applications.py">/home/hut/work/ranger/ranger/applications.py</a></font></td></tr></table> + <p></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</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="os.html">os</a><br> +</td><td width="25%" valign=top><a href="sys.html">sys</a><br> +</td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><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="builtins.html#object">builtins.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="ranger.applications.html#Applications">Applications</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="Applications">class <strong>Applications</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="Applications-all"><strong>all</strong></a>(self)</dt><dd><tt>Returns a list with all application functions</tt></dd></dl> + +<dl><dt><a name="Applications-get"><strong>get</strong></a>(self, app)</dt><dd><tt>Looks for an application, returns app_default if it doesn't exist</tt></dd></dl> + +<dl><dt><a name="Applications-has"><strong>has</strong></a>(self, app)</dt><dd><tt>Returns whether an application is defined</tt></dd></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> +</td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#eeaa77"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> + +<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt><a name="-run"><strong>run</strong></a>(*args, **kw)</dt><dd><tt>Run files with the specified parameters</tt></dd></dl> + <dl><dt><a name="-spawn"><strong>spawn</strong></a>(command, fm<font color="#909090">=None</font>, suspend<font color="#909090">=True</font>, wait<font color="#909090">=True</font>)</dt></dl> +</td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#55aa55"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> + +<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> +<td width="100%"><strong>ALLOWED_FLAGS</strong> = 'sdpSDP'<br> +<strong>null</strong> = <_io.TextIOWrapper name='/dev/null' encoding='UTF-8'></td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/ranger.colorschemes.default.html b/doc/ranger.colorschemes.default.html new file mode 100644 index 00000000..815d3229 --- /dev/null +++ b/doc/ranger.colorschemes.default.html @@ -0,0 +1,91 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module ranger.colorschemes.default</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.colorschemes.html"><font color="#ffffff">colorschemes</font></a>.default</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/colorschemes/default.py">/home/hut/work/ranger/ranger/colorschemes/default.py</a></font></td></tr></table> + <p></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</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="curses.html">curses</a><br> +</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><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.colorscheme.html#ColorScheme">ranger.gui.colorscheme.ColorScheme</a>(<a href="builtins.html#object">builtins.object</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="ranger.colorschemes.default.html#Default">Default</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="Default">class <strong>Default</strong></a>(<a href="ranger.gui.colorscheme.html#ColorScheme">ranger.gui.colorscheme.ColorScheme</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.colorschemes.default.html#Default">Default</a></dd> +<dd><a href="ranger.gui.colorscheme.html#ColorScheme">ranger.gui.colorscheme.ColorScheme</a></dd> +<dd><a href="builtins.html#object">builtins.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="Default-use"><strong>use</strong></a>(self, context)</dt></dl> + +<hr> +Methods inherited from <a href="ranger.gui.colorscheme.html#ColorScheme">ranger.gui.colorscheme.ColorScheme</a>:<br> +<dl><dt><a name="Default-__init__"><strong>__init__</strong></a>(self)</dt></dl> + +<dl><dt><a name="Default-get"><strong>get</strong></a>(self, *keys)</dt><dd><tt>Determine the (fg, bg, attr) tuple or get it from cache</tt></dd></dl> + +<dl><dt><a name="Default-get_attr"><strong>get_attr</strong></a>(self, *keys)</dt><dd><tt>Returns the curses attr integer for the specified keys</tt></dd></dl> + +<hr> +Data descriptors inherited from <a href="ranger.gui.colorscheme.html#ColorScheme">ranger.gui.colorscheme.ColorScheme</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> +</td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#55aa55"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> + +<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> +<td width="100%"><strong>COLOR_PAIRS</strong> = {10: 0}<br> +<strong>black</strong> = 0<br> +<strong>blue</strong> = 4<br> +<strong>bold</strong> = 2097152<br> +<strong>cyan</strong> = 6<br> +<strong>default</strong> = -1<br> +<strong>default_colors</strong> = (-1, -1, 0)<br> +<strong>green</strong> = 2<br> +<strong>invisible</strong> = 8388608<br> +<strong>magenta</strong> = 5<br> +<strong>normal</strong> = 0<br> +<strong>red</strong> = 1<br> +<strong>reverse</strong> = 262144<br> +<strong>underline</strong> = 131072<br> +<strong>white</strong> = 7<br> +<strong>yellow</strong> = 3</td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/ranger.colorschemes.html b/doc/ranger.colorschemes.html new file mode 100644 index 00000000..362bcb80 --- /dev/null +++ b/doc/ranger.colorschemes.html @@ -0,0 +1,32 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: package ranger.colorschemes</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>.colorschemes</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/colorschemes/__init__.py">/home/hut/work/ranger/ranger/colorschemes/__init__.py</a></font></td></tr></table> + <p><tt>Colorschemes are required to be located here,<br> +or in the CONFDIR/colorschemes/ directory</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<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.colorschemes.default.html">default</a><br> +</td><td width="25%" valign=top><a href="ranger.colorschemes.jungle.html">jungle</a><br> +</td><td width="25%" valign=top><a href="ranger.colorschemes.snow.html">snow</a><br> +</td><td width="25%" valign=top></td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#55aa55"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> + +<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> +<td width="100%"><strong>__all__</strong> = ['jungle', 'default', 'snow']</td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/ranger.colorschemes.jungle.html b/doc/ranger.colorschemes.jungle.html new file mode 100644 index 00000000..1febea96 --- /dev/null +++ b/doc/ranger.colorschemes.jungle.html @@ -0,0 +1,91 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module ranger.colorschemes.jungle</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.colorschemes.html"><font color="#ffffff">colorschemes</font></a>.jungle</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/colorschemes/jungle.py">/home/hut/work/ranger/ranger/colorschemes/jungle.py</a></font></td></tr></table> + <p></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</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="curses.html">curses</a><br> +</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><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.colorscheme.html#ColorScheme">ranger.gui.colorscheme.ColorScheme</a>(<a href="builtins.html#object">builtins.object</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="ranger.colorschemes.jungle.html#Default">Default</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="Default">class <strong>Default</strong></a>(<a href="ranger.gui.colorscheme.html#ColorScheme">ranger.gui.colorscheme.ColorScheme</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.colorschemes.jungle.html#Default">Default</a></dd> +<dd><a href="ranger.gui.colorscheme.html#ColorScheme">ranger.gui.colorscheme.ColorScheme</a></dd> +<dd><a href="builtins.html#object">builtins.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="Default-use"><strong>use</strong></a>(self, context)</dt></dl> + +<hr> +Methods inherited from <a href="ranger.gui.colorscheme.html#ColorScheme">ranger.gui.colorscheme.ColorScheme</a>:<br> +<dl><dt><a name="Default-__init__"><strong>__init__</strong></a>(self)</dt></dl> + +<dl><dt><a name="Default-get"><strong>get</strong></a>(self, *keys)</dt><dd><tt>Determine the (fg, bg, attr) tuple or get it from cache</tt></dd></dl> + +<dl><dt><a name="Default-get_attr"><strong>get_attr</strong></a>(self, *keys)</dt><dd><tt>Returns the curses attr integer for the specified keys</tt></dd></dl> + +<hr> +Data descriptors inherited from <a href="ranger.gui.colorscheme.html#ColorScheme">ranger.gui.colorscheme.ColorScheme</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> +</td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#55aa55"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> + +<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> +<td width="100%"><strong>COLOR_PAIRS</strong> = {10: 0}<br> +<strong>black</strong> = 0<br> +<strong>blue</strong> = 4<br> +<strong>bold</strong> = 2097152<br> +<strong>cyan</strong> = 6<br> +<strong>default</strong> = -1<br> +<strong>default_colors</strong> = (-1, -1, 0)<br> +<strong>green</strong> = 2<br> +<strong>invisible</strong> = 8388608<br> +<strong>magenta</strong> = 5<br> +<strong>normal</strong> = 0<br> +<strong>red</strong> = 1<br> +<strong>reverse</strong> = 262144<br> +<strong>underline</strong> = 131072<br> +<strong>white</strong> = 7<br> +<strong>yellow</strong> = 3</td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/ranger.colorschemes.snow.html b/doc/ranger.colorschemes.snow.html new file mode 100644 index 00000000..58f42ffd --- /dev/null +++ b/doc/ranger.colorschemes.snow.html @@ -0,0 +1,91 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module ranger.colorschemes.snow</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.colorschemes.html"><font color="#ffffff">colorschemes</font></a>.snow</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/colorschemes/snow.py">/home/hut/work/ranger/ranger/colorschemes/snow.py</a></font></td></tr></table> + <p></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</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="curses.html">curses</a><br> +</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><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.colorscheme.html#ColorScheme">ranger.gui.colorscheme.ColorScheme</a>(<a href="builtins.html#object">builtins.object</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="ranger.colorschemes.snow.html#Snow">Snow</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="Snow">class <strong>Snow</strong></a>(<a href="ranger.gui.colorscheme.html#ColorScheme">ranger.gui.colorscheme.ColorScheme</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.colorschemes.snow.html#Snow">Snow</a></dd> +<dd><a href="ranger.gui.colorscheme.html#ColorScheme">ranger.gui.colorscheme.ColorScheme</a></dd> +<dd><a href="builtins.html#object">builtins.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="Snow-use"><strong>use</strong></a>(self, context)</dt></dl> + +<hr> +Methods inherited from <a href="ranger.gui.colorscheme.html#ColorScheme">ranger.gui.colorscheme.ColorScheme</a>:<br> +<dl><dt><a name="Snow-__init__"><strong>__init__</strong></a>(self)</dt></dl> + +<dl><dt><a name="Snow-get"><strong>get</strong></a>(self, *keys)</dt><dd><tt>Determine the (fg, bg, attr) tuple or get it from cache</tt></dd></dl> + +<dl><dt><a name="Snow-get_attr"><strong>get_attr</strong></a>(self, *keys)</dt><dd><tt>Returns the curses attr integer for the specified keys</tt></dd></dl> + +<hr> +Data descriptors inherited from <a href="ranger.gui.colorscheme.html#ColorScheme">ranger.gui.colorscheme.ColorScheme</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> +</td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#55aa55"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> + +<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> +<td width="100%"><strong>COLOR_PAIRS</strong> = {10: 0}<br> +<strong>black</strong> = 0<br> +<strong>blue</strong> = 4<br> +<strong>bold</strong> = 2097152<br> +<strong>cyan</strong> = 6<br> +<strong>default</strong> = -1<br> +<strong>default_colors</strong> = (-1, -1, 0)<br> +<strong>green</strong> = 2<br> +<strong>invisible</strong> = 8388608<br> +<strong>magenta</strong> = 5<br> +<strong>normal</strong> = 0<br> +<strong>red</strong> = 1<br> +<strong>reverse</strong> = 262144<br> +<strong>underline</strong> = 131072<br> +<strong>white</strong> = 7<br> +<strong>yellow</strong> = 3</td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/ranger.commands.html b/doc/ranger.commands.html new file mode 100644 index 00000000..d89a7ff3 --- /dev/null +++ b/doc/ranger.commands.html @@ -0,0 +1,430 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module ranger.commands</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>.commands</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/commands.py">/home/hut/work/ranger/ranger/commands.py</a></font></td></tr></table> + <p></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</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="os.html">os</a><br> +</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><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="builtins.html#object">builtins.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="ranger.commands.html#parse">parse</a> +</font></dt></dl> +</dd> +<dt><font face="helvetica, arial"><a href="ranger.shared.html#FileManagerAware">ranger.shared.FileManagerAware</a>(<a href="ranger.shared.html#Awareness">ranger.shared.Awareness</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="ranger.commands.html#Command">Command</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="ranger.commands.html#cd">cd</a> +</font></dt><dt><font face="helvetica, arial"><a href="ranger.commands.html#delete">delete</a> +</font></dt><dt><font face="helvetica, arial"><a href="ranger.commands.html#delete">delete</a> +</font></dt><dt><font face="helvetica, arial"><a href="ranger.commands.html#find">find</a> +</font></dt><dt><font face="helvetica, arial"><a href="ranger.commands.html#mkdir">mkdir</a> +</font></dt><dt><font face="helvetica, arial"><a href="ranger.commands.html#quit">quit</a> +</font></dt></dl> +</dd> +</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="Command">class <strong>Command</strong></a>(<a href="ranger.shared.html#FileManagerAware">ranger.shared.FileManagerAware</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>Abstract command class<br> </tt></td></tr> +<tr><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="ranger.commands.html#Command">Command</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="builtins.html#object">builtins.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="Command-__init__"><strong>__init__</strong></a>(self, line, mode)</dt></dl> + +<dl><dt><a name="Command-execute"><strong>execute</strong></a>(self)</dt></dl> + +<dl><dt><a name="Command-quick_open"><strong>quick_open</strong></a>(self)</dt></dl> + +<dl><dt><a name="Command-tab"><strong>tab</strong></a>(self)</dt></dl> + +<hr> +Data and other attributes defined here:<br> +<dl><dt><strong>line</strong> = ''</dl> + +<dl><dt><strong>mode</strong> = ':'</dl> + +<dl><dt><strong>name</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> +</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="cd">class <strong>cd</strong></a>(<a href="ranger.commands.html#Command">Command</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>The <a href="#cd">cd</a> command changes the directory. The command '<a href="#cd">cd</a> -' is<br> +equivalent to typing ``. In the quick console, the directory<br> +will be entered without the need to press enter, as soon as there<br> +is one unambiguous match.<br> </tt></td></tr> +<tr><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="ranger.commands.html#cd">cd</a></dd> +<dd><a href="ranger.commands.html#Command">Command</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="builtins.html#object">builtins.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="cd-execute"><strong>execute</strong></a>(self)</dt></dl> + +<dl><dt><a name="cd-quick_open"><strong>quick_open</strong></a>(self)</dt></dl> + +<dl><dt><a name="cd-tab"><strong>tab</strong></a>(self)</dt></dl> + +<hr> +Methods inherited from <a href="ranger.commands.html#Command">Command</a>:<br> +<dl><dt><a name="cd-__init__"><strong>__init__</strong></a>(self, line, mode)</dt></dl> + +<hr> +Data and other attributes inherited from <a href="ranger.commands.html#Command">Command</a>:<br> +<dl><dt><strong>line</strong> = ''</dl> + +<dl><dt><strong>mode</strong> = ':'</dl> + +<dl><dt><strong>name</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> +</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="delete">class <strong>delete</strong></a>(<a href="ranger.commands.html#Command">Command</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.commands.html#delete">delete</a></dd> +<dd><a href="ranger.commands.html#Command">Command</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="builtins.html#object">builtins.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="delete-execute"><strong>execute</strong></a>(self)</dt></dl> + +<hr> +Methods inherited from <a href="ranger.commands.html#Command">Command</a>:<br> +<dl><dt><a name="delete-__init__"><strong>__init__</strong></a>(self, line, mode)</dt></dl> + +<dl><dt><a name="delete-quick_open"><strong>quick_open</strong></a>(self)</dt></dl> + +<dl><dt><a name="delete-tab"><strong>tab</strong></a>(self)</dt></dl> + +<hr> +Data and other attributes inherited from <a href="ranger.commands.html#Command">Command</a>:<br> +<dl><dt><strong>line</strong> = ''</dl> + +<dl><dt><strong>mode</strong> = ':'</dl> + +<dl><dt><strong>name</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> +</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="find">class <strong>find</strong></a>(<a href="ranger.commands.html#Command">Command</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>The <a href="#find">find</a> command will attempt to <a href="#find">find</a> a partial, case insensitive<br> +match in the filenames of the current directory. In the quick command<br> +console, once there is one unambiguous match, the file will be run<br> +automatically.<br> </tt></td></tr> +<tr><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="ranger.commands.html#find">find</a></dd> +<dd><a href="ranger.commands.html#Command">Command</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="builtins.html#object">builtins.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="find-execute"><strong>execute</strong></a>(self)</dt></dl> + +<dl><dt><a name="find-quick_open"><strong>quick_open</strong></a>(self)</dt></dl> + +<hr> +Data and other attributes defined here:<br> +<dl><dt><strong>count</strong> = 0</dl> + +<hr> +Methods inherited from <a href="ranger.commands.html#Command">Command</a>:<br> +<dl><dt><a name="find-__init__"><strong>__init__</strong></a>(self, line, mode)</dt></dl> + +<dl><dt><a name="find-tab"><strong>tab</strong></a>(self)</dt></dl> + +<hr> +Data and other attributes inherited from <a href="ranger.commands.html#Command">Command</a>:<br> +<dl><dt><strong>line</strong> = ''</dl> + +<dl><dt><strong>mode</strong> = ':'</dl> + +<dl><dt><strong>name</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> +</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="mkdir">class <strong>mkdir</strong></a>(<a href="ranger.commands.html#Command">Command</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.commands.html#mkdir">mkdir</a></dd> +<dd><a href="ranger.commands.html#Command">Command</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="builtins.html#object">builtins.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="mkdir-execute"><strong>execute</strong></a>(self)</dt></dl> + +<hr> +Methods inherited from <a href="ranger.commands.html#Command">Command</a>:<br> +<dl><dt><a name="mkdir-__init__"><strong>__init__</strong></a>(self, line, mode)</dt></dl> + +<dl><dt><a name="mkdir-quick_open"><strong>quick_open</strong></a>(self)</dt></dl> + +<dl><dt><a name="mkdir-tab"><strong>tab</strong></a>(self)</dt></dl> + +<hr> +Data and other attributes inherited from <a href="ranger.commands.html#Command">Command</a>:<br> +<dl><dt><strong>line</strong> = ''</dl> + +<dl><dt><strong>mode</strong> = ':'</dl> + +<dl><dt><strong>name</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> +</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="parse">class <strong>parse</strong></a>(<a href="builtins.html#object">builtins.object</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>Parse commands and extract information<br> </tt></td></tr> +<tr><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="parse-__add__"><strong>__add__</strong></a>(self, newpart)</dt></dl> + +<dl><dt><a name="parse-__init__"><strong>__init__</strong></a>(self, line)</dt></dl> + +<dl><dt><a name="parse-chunk"><strong>chunk</strong></a>(self, n, otherwise<font color="#909090">=''</font>)</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> +</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="quit">class <strong>quit</strong></a>(<a href="ranger.commands.html#Command">Command</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>Quits the program.<br> </tt></td></tr> +<tr><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="ranger.commands.html#quit">quit</a></dd> +<dd><a href="ranger.commands.html#Command">Command</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="builtins.html#object">builtins.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="quit-execute"><strong>execute</strong></a>(self)</dt></dl> + +<hr> +Methods inherited from <a href="ranger.commands.html#Command">Command</a>:<br> +<dl><dt><a name="quit-__init__"><strong>__init__</strong></a>(self, line, mode)</dt></dl> + +<dl><dt><a name="quit-quick_open"><strong>quick_open</strong></a>(self)</dt></dl> + +<dl><dt><a name="quit-tab"><strong>tab</strong></a>(self)</dt></dl> + +<hr> +Data and other attributes inherited from <a href="ranger.commands.html#Command">Command</a>:<br> +<dl><dt><strong>line</strong> = ''</dl> + +<dl><dt><strong>mode</strong> = ':'</dl> + +<dl><dt><strong>name</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> +</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"><strong>var</strong> = <a name="var">class delete</a>(<a href="ranger.commands.html#Command">Command</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.commands.html#delete">delete</a></dd> +<dd><a href="ranger.commands.html#Command">Command</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="builtins.html#object">builtins.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="delete-execute"><strong>execute</strong></a>(self)</dt></dl> + +<hr> +Methods inherited from <a href="ranger.commands.html#Command">Command</a>:<br> +<dl><dt><a name="delete-__init__"><strong>__init__</strong></a>(self, line, mode)</dt></dl> + +<dl><dt><a name="delete-quick_open"><strong>quick_open</strong></a>(self)</dt></dl> + +<dl><dt><a name="delete-tab"><strong>tab</strong></a>(self)</dt></dl> + +<hr> +Data and other attributes inherited from <a href="ranger.commands.html#Command">Command</a>:<br> +<dl><dt><strong>line</strong> = ''</dl> + +<dl><dt><strong>mode</strong> = ':'</dl> + +<dl><dt><strong>name</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> +</td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#eeaa77"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> + +<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt><a name="-alias"><strong>alias</strong></a>(**kw)</dt></dl> +</td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#55aa55"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> + +<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> +<td width="100%"><strong>by_name</strong> = {'cd': <class 'ranger.commands.cd'>, 'delete': <class 'ranger.commands.delete'>, 'find': <class 'ranger.commands.find'>, 'mkdir': <class 'ranger.commands.mkdir'>, 'q': <class 'ranger.commands.quit'>, 'quit': <class 'ranger.commands.quit'>}<br> +<strong>varname</strong> = 'delete'</td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/ranger.container.bookmarks.html b/doc/ranger.container.bookmarks.html new file mode 100644 index 00000000..699524c4 --- /dev/null +++ b/doc/ranger.container.bookmarks.html @@ -0,0 +1,173 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module ranger.container.bookmarks</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.container.html"><font color="#ffffff">container</font></a>.bookmarks</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/container/bookmarks.py">/home/hut/work/ranger/ranger/container/bookmarks.py</a></font></td></tr></table> + <p></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</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="os.html">os</a><br> +</td><td width="25%" valign=top><a href="re.html">re</a><br> +</td><td width="25%" valign=top><a href="string.html">string</a><br> +</td><td width="25%" valign=top></td></tr></table></td></tr></table><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="builtins.html#Exception">builtins.Exception</a>(<a href="builtins.html#BaseException">builtins.BaseException</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="ranger.container.bookmarks.html#NonexistantBookmark">NonexistantBookmark</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.container.bookmarks.html#Bookmarks">Bookmarks</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="Bookmarks">class <strong>Bookmarks</strong></a>(<a href="builtins.html#object">builtins.object</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt><a href="#Bookmarks">Bookmarks</a> is a container which associates keys with bookmarks.<br> + <br> +A key is a string with: len(key) == 1 and key in ALLOWED_KEYS.<br> + <br> +A bookmark is an <a href="builtins.html#object">object</a> with: bookmark == bookmarktype(str(instance))<br> +Which is true for str or FileSystemObject. This condition is required<br> +so bookmark-objects can be saved to and loaded from a file.<br> + <br> +Optionally, a bookmark.go() method is used for entering a bookmark.<br> </tt></td></tr> +<tr><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="Bookmarks-__contains__"><strong>__contains__</strong></a>(self, key)</dt><dd><tt>Test whether a bookmark-key is defined</tt></dd></dl> + +<dl><dt><a name="Bookmarks-__getitem__"><strong>__getitem__</strong></a>(self, key)</dt><dd><tt>Get the bookmark associated with the key</tt></dd></dl> + +<dl><dt><a name="Bookmarks-__init__"><strong>__init__</strong></a>(self, bookmarkfile, bookmarktype<font color="#909090">=<class 'str'></font>, autosave<font color="#909090">=False</font>)</dt><dd><tt><bookmarkfile> specifies the path to the file where<br> +bookmarks are saved in.</tt></dd></dl> + +<dl><dt><a name="Bookmarks-__setitem__"><strong>__setitem__</strong></a>(self, key, value)</dt><dd><tt>Bookmark <value> to the key <key>.<br> +key is expected to be a 1-character string and element of ALLOWED_KEYS.<br> +value is expected to be a filesystemobject.</tt></dd></dl> + +<dl><dt><a name="Bookmarks-delete"><strong>delete</strong></a>(self, key)</dt><dd><tt>Delete the bookmark with the given key</tt></dd></dl> + +<dl><dt><a name="Bookmarks-enter"><strong>enter</strong></a>(self, key)</dt><dd><tt>Enter the bookmark with the given key.<br> +Requires the bookmark instance to have a go() method.</tt></dd></dl> + +<dl><dt><a name="Bookmarks-load"><strong>load</strong></a>(self)</dt><dd><tt>Load the bookmarks from path/bookmarks</tt></dd></dl> + +<dl><dt><a name="Bookmarks-remember"><strong>remember</strong></a>(self, value)</dt><dd><tt><a href="#Bookmarks">Bookmarks</a> <value> to the keys ` and '</tt></dd></dl> + +<dl><dt><a name="Bookmarks-save"><strong>save</strong></a>(self)</dt><dd><tt>Save the bookmarks to the bookmarkfile.<br> +This is done automatically after every modification if autosave is True.</tt></dd></dl> + +<dl><dt><a name="Bookmarks-update"><strong>update</strong></a>(self)</dt><dd><tt>Update the bookmarks from the bookmark file.<br> +Useful if two instances are running which define different bookmarks.</tt></dd></dl> + +<dl><dt><a name="Bookmarks-update_if_outdated"><strong>update_if_outdated</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>autosave</strong> = True</dl> + +<dl><dt><strong>last_mtime</strong> = None</dl> + +<dl><dt><strong>load_pattern</strong> = <_sre.SRE_Pattern object at 0x15161a0></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="NonexistantBookmark">class <strong>NonexistantBookmark</strong></a>(<a href="builtins.html#Exception">builtins.Exception</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.container.bookmarks.html#NonexistantBookmark">NonexistantBookmark</a></dd> +<dd><a href="builtins.html#Exception">builtins.Exception</a></dd> +<dd><a href="builtins.html#BaseException">builtins.BaseException</a></dd> +<dd><a href="builtins.html#object">builtins.object</a></dd> +</dl> +<hr> +Data descriptors defined here:<br> +<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#Exception">builtins.Exception</a>:<br> +<dl><dt><a name="NonexistantBookmark-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#NonexistantBookmark-__init__">__init__</a>(...) initializes x; see x.__class__.__doc__ for signature</tt></dd></dl> + +<hr> +Data and other attributes inherited from <a href="builtins.html#Exception">builtins.Exception</a>:<br> +<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object at 0x7f327d94a120><dd><tt>T.<a href="#NonexistantBookmark-__new__">__new__</a>(S, ...) -> a new <a href="builtins.html#object">object</a> with type S, a subtype of T</tt></dl> + +<hr> +Methods inherited from <a href="builtins.html#BaseException">builtins.BaseException</a>:<br> +<dl><dt><a name="NonexistantBookmark-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#NonexistantBookmark-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> + +<dl><dt><a name="NonexistantBookmark-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#NonexistantBookmark-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> + +<dl><dt><a name="NonexistantBookmark-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> + +<dl><dt><a name="NonexistantBookmark-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#NonexistantBookmark-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> + +<dl><dt><a name="NonexistantBookmark-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#NonexistantBookmark-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> + +<dl><dt><a name="NonexistantBookmark-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> + +<dl><dt><a name="NonexistantBookmark-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#NonexistantBookmark-__str__">__str__</a>() <==> str(x)</tt></dd></dl> + +<dl><dt><a name="NonexistantBookmark-with_traceback"><strong>with_traceback</strong></a>(...)</dt><dd><tt><a href="builtins.html#Exception">Exception</a>.<a href="#NonexistantBookmark-with_traceback">with_traceback</a>(tb) --<br> +set self.<strong>__traceback__</strong> to tb and return self.</tt></dd></dl> + +<hr> +Data descriptors inherited from <a href="builtins.html#BaseException">builtins.BaseException</a>:<br> +<dl><dt><strong>__cause__</strong></dt> +<dd><tt>exception cause</tt></dd> +</dl> +<dl><dt><strong>__context__</strong></dt> +<dd><tt>exception context</tt></dd> +</dl> +<dl><dt><strong>__dict__</strong></dt> +</dl> +<dl><dt><strong>__traceback__</strong></dt> +</dl> +<dl><dt><strong>args</strong></dt> +</dl> +</td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#55aa55"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> + +<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> +<td width="100%"><strong>ALLOWED_KEYS</strong> = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789`'"</td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/ranger.container.commandlist.html b/doc/ranger.container.commandlist.html new file mode 100644 index 00000000..1620984c --- /dev/null +++ b/doc/ranger.container.commandlist.html @@ -0,0 +1,129 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module ranger.container.commandlist</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.container.html"><font color="#ffffff">container</font></a>.commandlist</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/container/commandlist.py">/home/hut/work/ranger/ranger/container/commandlist.py</a></font></td></tr></table> + <p></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="builtins.html#object">builtins.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="ranger.container.commandlist.html#Command">Command</a> +</font></dt><dt><font face="helvetica, arial"><a href="ranger.container.commandlist.html#CommandList">CommandList</a> +</font></dt><dt><font face="helvetica, arial"><a href="ranger.container.commandlist.html#Hint">Hint</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="Command">class <strong>Command</strong></a>(<a href="builtins.html#object">builtins.object</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt><a href="#Command">Command</a> objects store information about a command<br> </tt></td></tr> +<tr><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="Command-__init__"><strong>__init__</strong></a>(self, fnc, keys)</dt></dl> + +<dl><dt><a name="Command-execute"><strong>execute</strong></a>(self, *args)</dt><dd><tt>Execute the command</tt></dd></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>keys</strong> = []</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="CommandList">class <strong>CommandList</strong></a>(<a href="builtins.html#object">builtins.object</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>CommandLists are dictionary-like objects which give you a command<br> +for a given key combination. CommandLists must be filled before use.<br> </tt></td></tr> +<tr><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="CommandList-__getitem__"><strong>__getitem__</strong></a>(self, key)</dt><dd><tt>Returns the command with the given key combination</tt></dd></dl> + +<dl><dt><a name="CommandList-__init__"><strong>__init__</strong></a>(self)</dt></dl> + +<dl><dt><a name="CommandList-bind"><strong>bind</strong></a>(self, fnc, *keys)</dt><dd><tt>create a <a href="#Command">Command</a> <a href="builtins.html#object">object</a> and assign it to the given key combinations.</tt></dd></dl> + +<dl><dt><a name="CommandList-hint"><strong>hint</strong></a>(self, text, *keys)</dt><dd><tt>create a <a href="#Hint">Hint</a> <a href="builtins.html#object">object</a> and assign it to the given key combinations.</tt></dd></dl> + +<dl><dt><a name="CommandList-rebuild_paths"><strong>rebuild_paths</strong></a>(self)</dt><dd><tt>Fill the path dictionary with dummie objects.<br> +We need to know when to clear the keybuffer (when a wrong key is pressed)<br> +and when to wait for the rest of the key combination. For "gg" we<br> +will assign "g" to a dummy which tells the program to do the latter<br> +and wait.</tt></dd></dl> + +<dl><dt><a name="CommandList-remove_dummies"><strong>remove_dummies</strong></a>(self)</dt><dd><tt>Remove dummie objects in case you have to rebuild a path dictionary<br> +which already contains dummie objects.</tt></dd></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>commandlist</strong> = []</dl> + +<dl><dt><strong>dummies_in_paths</strong> = False</dl> + +<dl><dt><strong>dummy_object</strong> = None</dl> + +<dl><dt><strong>paths</strong> = {}</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="Hint">class <strong>Hint</strong></a>(<a href="builtins.html#object">builtins.object</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>Hints display text without clearing the keybuffer<br> </tt></td></tr> +<tr><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="Hint-__init__"><strong>__init__</strong></a>(self, text, keys)</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>keys</strong> = []</dl> + +<dl><dt><strong>text</strong> = ''</dl> + +</td></tr></table></td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/ranger.container.environment.html b/doc/ranger.container.environment.html new file mode 100644 index 00000000..4909d588 --- /dev/null +++ b/doc/ranger.container.environment.html @@ -0,0 +1,105 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module ranger.container.environment</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.container.html"><font color="#ffffff">container</font></a>.environment</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/container/environment.py">/home/hut/work/ranger/ranger/container/environment.py</a></font></td></tr></table> + <p></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.shared.settings.html#SettingsAware">ranger.shared.settings.SettingsAware</a>(<a href="builtins.html#object">builtins.object</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="ranger.container.environment.html#Environment">Environment</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="Environment">class <strong>Environment</strong></a>(<a href="ranger.shared.settings.html#SettingsAware">ranger.shared.settings.SettingsAware</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>A collection of data which is relevant for more than<br> +one class.<br> </tt></td></tr> +<tr><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="ranger.container.environment.html#Environment">Environment</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="Environment-__init__"><strong>__init__</strong></a>(self, path)</dt></dl> + +<dl><dt><a name="Environment-assign_correct_cursor_positions"><strong>assign_correct_cursor_positions</strong></a>(self)</dt><dd><tt>Assign correct cursor positions for subdirectories</tt></dd></dl> + +<dl><dt><a name="Environment-at_level"><strong>at_level</strong></a>(self, level)</dt><dd><tt>Returns the FileSystemObject at the given level.<br> +level 1 => preview<br> +level 0 => current file/directory<br> +level <0 => parent directories</tt></dd></dl> + +<dl><dt><a name="Environment-enter_dir"><strong>enter_dir</strong></a>(self, path, history<font color="#909090">=True</font>)</dt><dd><tt>Enter given path</tt></dd></dl> + +<dl><dt><a name="Environment-garbage_collect"><strong>garbage_collect</strong></a>(self)</dt><dd><tt>Delete unused directory objects</tt></dd></dl> + +<dl><dt><a name="Environment-get_directory"><strong>get_directory</strong></a>(self, path)</dt><dd><tt>Get the directory object at the given path</tt></dd></dl> + +<dl><dt><a name="Environment-get_selection"><strong>get_selection</strong></a>(self)</dt></dl> + +<dl><dt><a name="Environment-history_go"><strong>history_go</strong></a>(self, relative)</dt><dd><tt>Move relative in history</tt></dd></dl> + +<dl><dt><a name="Environment-key_append"><strong>key_append</strong></a>(self, key)</dt><dd><tt>Append a key to the keybuffer</tt></dd></dl> + +<dl><dt><a name="Environment-key_clear"><strong>key_clear</strong></a>(self)</dt><dd><tt>Clear the keybuffer</tt></dd></dl> + +<hr> +Data and other attributes defined here:<br> +<dl><dt><strong>cf</strong> = None</dl> + +<dl><dt><strong>copy</strong> = None</dl> + +<dl><dt><strong>cut</strong> = None</dl> + +<dl><dt><strong>directories</strong> = None</dl> + +<dl><dt><strong>history</strong> = None</dl> + +<dl><dt><strong>keybuffer</strong> = None</dl> + +<dl><dt><strong>last_search</strong> = None</dl> + +<dl><dt><strong>path</strong> = None</dl> + +<dl><dt><strong>pathway</strong> = None</dl> + +<dl><dt><strong>pwd</strong> = None</dl> + +<dl><dt><strong>termsize</strong> = None</dl> + +<hr> +Data descriptors inherited from <a href="ranger.shared.settings.html#SettingsAware">ranger.shared.settings.SettingsAware</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 diff --git a/doc/ranger.container.history.html b/doc/ranger.container.history.html new file mode 100644 index 00000000..5094de92 --- /dev/null +++ b/doc/ranger.container.history.html @@ -0,0 +1,136 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module ranger.container.history</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.container.html"><font color="#ffffff">container</font></a>.history</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/container/history.py">/home/hut/work/ranger/ranger/container/history.py</a></font></td></tr></table> + <p></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="builtins.html#Exception">builtins.Exception</a>(<a href="builtins.html#BaseException">builtins.BaseException</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="ranger.container.history.html#HistoryEmptyException">HistoryEmptyException</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.container.history.html#History">History</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="History">class <strong>History</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="History-__init__"><strong>__init__</strong></a>(self, maxlen<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="History-__iter__"><strong>__iter__</strong></a>(self)</dt></dl> + +<dl><dt><a name="History-__len__"><strong>__len__</strong></a>(self)</dt></dl> + +<dl><dt><a name="History-add"><strong>add</strong></a>(self, item)</dt></dl> + +<dl><dt><a name="History-back"><strong>back</strong></a>(self)</dt></dl> + +<dl><dt><a name="History-bottom"><strong>bottom</strong></a>(self)</dt></dl> + +<dl><dt><a name="History-current"><strong>current</strong></a>(self)</dt></dl> + +<dl><dt><a name="History-fast_forward"><strong>fast_forward</strong></a>(self)</dt></dl> + +<dl><dt><a name="History-forward"><strong>forward</strong></a>(self)</dt></dl> + +<dl><dt><a name="History-modify"><strong>modify</strong></a>(self, item)</dt></dl> + +<dl><dt><a name="History-move"><strong>move</strong></a>(self, n)</dt></dl> + +<dl><dt><a name="History-next"><strong>next</strong></a>(self)</dt></dl> + +<dl><dt><a name="History-top"><strong>top</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> +</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="HistoryEmptyException">class <strong>HistoryEmptyException</strong></a>(<a href="builtins.html#Exception">builtins.Exception</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.container.history.html#HistoryEmptyException">HistoryEmptyException</a></dd> +<dd><a href="builtins.html#Exception">builtins.Exception</a></dd> +<dd><a href="builtins.html#BaseException">builtins.BaseException</a></dd> +<dd><a href="builtins.html#object">builtins.object</a></dd> +</dl> +<hr> +Data descriptors defined here:<br> +<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#Exception">builtins.Exception</a>:<br> +<dl><dt><a name="HistoryEmptyException-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#HistoryEmptyException-__init__">__init__</a>(...) initializes x; see x.__class__.__doc__ for signature</tt></dd></dl> + +<hr> +Data and other attributes inherited from <a href="builtins.html#Exception">builtins.Exception</a>:<br> +<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object at 0x7f327d94a120><dd><tt>T.<a href="#HistoryEmptyException-__new__">__new__</a>(S, ...) -> a new <a href="builtins.html#object">object</a> with type S, a subtype of T</tt></dl> + +<hr> +Methods inherited from <a href="builtins.html#BaseException">builtins.BaseException</a>:<br> +<dl><dt><a name="HistoryEmptyException-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#HistoryEmptyException-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> + +<dl><dt><a name="HistoryEmptyException-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#HistoryEmptyException-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> + +<dl><dt><a name="HistoryEmptyException-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> + +<dl><dt><a name="HistoryEmptyException-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#HistoryEmptyException-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> + +<dl><dt><a name="HistoryEmptyException-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#HistoryEmptyException-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> + +<dl><dt><a name="HistoryEmptyException-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> + +<dl><dt><a name="HistoryEmptyException-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#HistoryEmptyException-__str__">__str__</a>() <==> str(x)</tt></dd></dl> + +<dl><dt><a name="HistoryEmptyException-with_traceback"><strong>with_traceback</strong></a>(...)</dt><dd><tt><a href="builtins.html#Exception">Exception</a>.<a href="#HistoryEmptyException-with_traceback">with_traceback</a>(tb) --<br> +set self.<strong>__traceback__</strong> to tb and return self.</tt></dd></dl> + +<hr> +Data descriptors inherited from <a href="builtins.html#BaseException">builtins.BaseException</a>:<br> +<dl><dt><strong>__cause__</strong></dt> +<dd><tt>exception cause</tt></dd> +</dl> +<dl><dt><strong>__context__</strong></dt> +<dd><tt>exception context</tt></dd> +</dl> +<dl><dt><strong>__dict__</strong></dt> +</dl> +<dl><dt><strong>__traceback__</strong></dt> +</dl> +<dl><dt><strong>args</strong></dt> +</dl> +</td></tr></table></td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/ranger.container.html b/doc/ranger.container.html new file mode 100644 index 00000000..7154fd15 --- /dev/null +++ b/doc/ranger.container.html @@ -0,0 +1,27 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: package ranger.container</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>.container</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/container/__init__.py">/home/hut/work/ranger/ranger/container/__init__.py</a></font></td></tr></table> + <p><tt>This package includes container-objects which are<br> +used to manage stored data</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<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.container.bookmarks.html">bookmarks</a><br> +<a href="ranger.container.commandlist.html">commandlist</a><br> +</td><td width="25%" valign=top><a href="ranger.container.environment.html">environment</a><br> +<a href="ranger.container.history.html">history</a><br> +</td><td width="25%" valign=top><a href="ranger.container.keybuffer.html">keybuffer</a><br> +</td><td width="25%" valign=top></td></tr></table></td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/ranger.container.keybuffer.html b/doc/ranger.container.keybuffer.html new file mode 100644 index 00000000..4990a3fc --- /dev/null +++ b/doc/ranger.container.keybuffer.html @@ -0,0 +1,76 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module ranger.container.keybuffer</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.container.html"><font color="#ffffff">container</font></a>.keybuffer</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/container/keybuffer.py">/home/hut/work/ranger/ranger/container/keybuffer.py</a></font></td></tr></table> + <p></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="builtins.html#object">builtins.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="ranger.container.keybuffer.html#KeyBuffer">KeyBuffer</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="KeyBuffer">class <strong>KeyBuffer</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="KeyBuffer-__init__"><strong>__init__</strong></a>(self)</dt></dl> + +<dl><dt><a name="KeyBuffer-__str__"><strong>__str__</strong></a>(self)</dt><dd><tt>returns a concatenation of all characters</tt></dd></dl> + +<dl><dt><a name="KeyBuffer-append"><strong>append</strong></a>(self, key)</dt><dd><tt>Append a key to the keybuffer, or initial numbers to<br> +the number attribute.</tt></dd></dl> + +<dl><dt><a name="KeyBuffer-clear"><strong>clear</strong></a>(self)</dt><dd><tt>Clear the keybuffer and restore the initial state</tt></dd></dl> + +<dl><dt><a name="KeyBuffer-tuple_with_numbers"><strong>tuple_with_numbers</strong></a>(self)</dt><dd><tt>Get a tuple of ascii codes.</tt></dd></dl> + +<dl><dt><a name="KeyBuffer-tuple_without_numbers"><strong>tuple_without_numbers</strong></a>(self)</dt><dd><tt>Get a tuple of ascii codes.<br> +If the keybuffer starts with numbers, those will<br> +be left out. To access them, use keybuffer.number</tt></dd></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> +</td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#eeaa77"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> + +<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt><a name="-to_string"><strong>to_string</strong></a>(i)</dt></dl> +</td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#55aa55"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> + +<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> +<td width="100%"><strong>NINE</strong> = 57<br> +<strong>ZERO</strong> = 48</td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/ranger.defaults.apps.html b/doc/ranger.defaults.apps.html new file mode 100644 index 00000000..f969eebf --- /dev/null +++ b/doc/ranger.defaults.apps.html @@ -0,0 +1,75 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module ranger.defaults.apps</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.defaults.html"><font color="#ffffff">defaults</font></a>.apps</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/defaults/apps.py">/home/hut/work/ranger/ranger/defaults/apps.py</a></font></td></tr></table> + <p></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.applications.html#Applications">ranger.applications.Applications</a>(<a href="builtins.html#object">builtins.object</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="ranger.defaults.apps.html#CustomApplications">CustomApplications</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="CustomApplications">class <strong>CustomApplications</strong></a>(<a href="ranger.applications.html#Applications">ranger.applications.Applications</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.defaults.apps.html#CustomApplications">CustomApplications</a></dd> +<dd><a href="ranger.applications.html#Applications">ranger.applications.Applications</a></dd> +<dd><a href="builtins.html#object">builtins.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="CustomApplications-app_aunpack"><strong>app_aunpack</strong></a>(self, **kw)</dt></dl> + +<dl><dt><a name="CustomApplications-app_default"><strong>app_default</strong></a>(self, **kw)</dt><dd><tt># How to determine the default application? {{{</tt></dd></dl> + +<dl><dt><a name="CustomApplications-app_editor"><strong>app_editor</strong></a> = <a href="#CustomApplications-app_vim">app_vim</a>(self, **kw)</dt></dl> + +<dl><dt><a name="CustomApplications-app_evince"><strong>app_evince</strong></a>(self, **kw)</dt></dl> + +<dl><dt><a name="CustomApplications-app_feh"><strong>app_feh</strong></a>(self, **kw)</dt></dl> + +<dl><dt><a name="CustomApplications-app_mplayer"><strong>app_mplayer</strong></a>(self, **kw)</dt></dl> + +<dl><dt><a name="CustomApplications-app_pager"><strong>app_pager</strong></a>(self, **kw)</dt></dl> + +<dl><dt><a name="CustomApplications-app_vim"><strong>app_vim</strong></a>(self, **kw)</dt></dl> + +<hr> +Methods inherited from <a href="ranger.applications.html#Applications">ranger.applications.Applications</a>:<br> +<dl><dt><a name="CustomApplications-all"><strong>all</strong></a>(self)</dt><dd><tt>Returns a list with all application functions</tt></dd></dl> + +<dl><dt><a name="CustomApplications-get"><strong>get</strong></a>(self, app)</dt><dd><tt>Looks for an application, returns app_default if it doesn't exist</tt></dd></dl> + +<dl><dt><a name="CustomApplications-has"><strong>has</strong></a>(self, app)</dt><dd><tt>Returns whether an application is defined</tt></dd></dl> + +<hr> +Data descriptors inherited from <a href="ranger.applications.html#Applications">ranger.applications.Applications</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> +</td></tr></table></td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/ranger.defaults.html b/doc/ranger.defaults.html new file mode 100644 index 00000000..22015dc0 --- /dev/null +++ b/doc/ranger.defaults.html @@ -0,0 +1,24 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: package ranger.defaults</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>.defaults</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/defaults/__init__.py">/home/hut/work/ranger/ranger/defaults/__init__.py</a></font></td></tr></table> + <p><tt>Default options and configration files</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<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.defaults.apps.html">apps</a><br> +</td><td width="25%" valign=top><a href="ranger.defaults.keys.html">keys</a><br> +</td><td width="25%" valign=top><a href="ranger.defaults.options.html">options</a><br> +</td><td width="25%" valign=top></td></tr></table></td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/ranger.defaults.keys.html b/doc/ranger.defaults.keys.html new file mode 100644 index 00000000..782ee6d2 --- /dev/null +++ b/doc/ranger.defaults.keys.html @@ -0,0 +1,357 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module ranger.defaults.keys</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.defaults.html"><font color="#ffffff">defaults</font></a>.keys</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/defaults/keys.py">/home/hut/work/ranger/ranger/defaults/keys.py</a></font></td></tr></table> + <p></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</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="curses.html">curses</a><br> +</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#eeaa77"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> + +<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt><a name="-baudrate"><strong>baudrate</strong></a>(...)</dt></dl> + <dl><dt><a name="-beep"><strong>beep</strong></a>(...)</dt></dl> + <dl><dt><a name="-can_change_color"><strong>can_change_color</strong></a>(...)</dt></dl> + <dl><dt><a name="-cbreak"><strong>cbreak</strong></a>(...)</dt></dl> + <dl><dt><a name="-color_content"><strong>color_content</strong></a>(...)</dt></dl> + <dl><dt><a name="-color_pair"><strong>color_pair</strong></a>(...)</dt></dl> + <dl><dt><a name="-curs_set"><strong>curs_set</strong></a>(...)</dt></dl> + <dl><dt><a name="-def_prog_mode"><strong>def_prog_mode</strong></a>(...)</dt></dl> + <dl><dt><a name="-def_shell_mode"><strong>def_shell_mode</strong></a>(...)</dt></dl> + <dl><dt><a name="-delay_output"><strong>delay_output</strong></a>(...)</dt></dl> + <dl><dt><a name="-doupdate"><strong>doupdate</strong></a>(...)</dt></dl> + <dl><dt><a name="-echo"><strong>echo</strong></a>(...)</dt></dl> + <dl><dt><a name="-endwin"><strong>endwin</strong></a>(...)</dt></dl> + <dl><dt><a name="-erasechar"><strong>erasechar</strong></a>(...)</dt></dl> + <dl><dt><a name="-filter"><strong>filter</strong></a>(...)</dt></dl> + <dl><dt><a name="-flash"><strong>flash</strong></a>(...)</dt></dl> + <dl><dt><a name="-flushinp"><strong>flushinp</strong></a>(...)</dt></dl> + <dl><dt><a name="-getmouse"><strong>getmouse</strong></a>(...)</dt></dl> + <dl><dt><a name="-getsyx"><strong>getsyx</strong></a>(...)</dt></dl> + <dl><dt><a name="-getwin"><strong>getwin</strong></a>(...)</dt></dl> + <dl><dt><a name="-halfdelay"><strong>halfdelay</strong></a>(...)</dt></dl> + <dl><dt><a name="-has_colors"><strong>has_colors</strong></a>(...)</dt></dl> + <dl><dt><a name="-has_ic"><strong>has_ic</strong></a>(...)</dt></dl> + <dl><dt><a name="-has_il"><strong>has_il</strong></a>(...)</dt></dl> + <dl><dt><a name="-has_key"><strong>has_key</strong></a>(...)</dt></dl> + <dl><dt><a name="-init_color"><strong>init_color</strong></a>(...)</dt></dl> + <dl><dt><a name="-init_pair"><strong>init_pair</strong></a>(...)</dt></dl> + <dl><dt><a name="-initialize_commands"><strong>initialize_commands</strong></a>(command_list)</dt><dd><tt>Initialize the commands for the main user interface</tt></dd></dl> + <dl><dt><a name="-initialize_console_commands"><strong>initialize_console_commands</strong></a>(command_list)</dt><dd><tt>Initialize the commands for the console widget only</tt></dd></dl> + <dl><dt><a name="-initialize_process_manager_commands"><strong>initialize_process_manager_commands</strong></a>(command_list)</dt><dd><tt>Initialize the commands for the process manager widget</tt></dd></dl> + <dl><dt><a name="-intrflush"><strong>intrflush</strong></a>(...)</dt></dl> + <dl><dt><a name="-is_term_resized"><strong>is_term_resized</strong></a>(...)</dt></dl> + <dl><dt><a name="-isendwin"><strong>isendwin</strong></a>(...)</dt></dl> + <dl><dt><a name="-keyname"><strong>keyname</strong></a>(...)</dt></dl> + <dl><dt><a name="-killchar"><strong>killchar</strong></a>(...)</dt></dl> + <dl><dt><a name="-longname"><strong>longname</strong></a>(...)</dt></dl> + <dl><dt><a name="-meta"><strong>meta</strong></a>(...)</dt></dl> + <dl><dt><a name="-mouseinterval"><strong>mouseinterval</strong></a>(...)</dt></dl> + <dl><dt><a name="-mousemask"><strong>mousemask</strong></a>(...)</dt></dl> + <dl><dt><a name="-napms"><strong>napms</strong></a>(...)</dt></dl> + <dl><dt><a name="-newpad"><strong>newpad</strong></a>(...)</dt></dl> + <dl><dt><a name="-newwin"><strong>newwin</strong></a>(...)</dt></dl> + <dl><dt><a name="-nl"><strong>nl</strong></a>(...)</dt></dl> + <dl><dt><a name="-nocbreak"><strong>nocbreak</strong></a>(...)</dt></dl> + <dl><dt><a name="-noecho"><strong>noecho</strong></a>(...)</dt></dl> + <dl><dt><a name="-nonl"><strong>nonl</strong></a>(...)</dt></dl> + <dl><dt><a name="-noqiflush"><strong>noqiflush</strong></a>(...)</dt></dl> + <dl><dt><a name="-noraw"><strong>noraw</strong></a>(...)</dt></dl> + <dl><dt><a name="-pair_content"><strong>pair_content</strong></a>(...)</dt></dl> + <dl><dt><a name="-pair_number"><strong>pair_number</strong></a>(...)</dt></dl> + <dl><dt><a name="-putp"><strong>putp</strong></a>(...)</dt></dl> + <dl><dt><a name="-qiflush"><strong>qiflush</strong></a>(...)</dt></dl> + <dl><dt><a name="-raw"><strong>raw</strong></a>(...)</dt></dl> + <dl><dt><a name="-reset_prog_mode"><strong>reset_prog_mode</strong></a>(...)</dt></dl> + <dl><dt><a name="-reset_shell_mode"><strong>reset_shell_mode</strong></a>(...)</dt></dl> + <dl><dt><a name="-resetty"><strong>resetty</strong></a>(...)</dt></dl> + <dl><dt><a name="-resize_term"><strong>resize_term</strong></a>(...)</dt></dl> + <dl><dt><a name="-resizeterm"><strong>resizeterm</strong></a>(...)</dt></dl> + <dl><dt><a name="-savetty"><strong>savetty</strong></a>(...)</dt></dl> + <dl><dt><a name="-setsyx"><strong>setsyx</strong></a>(...)</dt></dl> + <dl><dt><a name="-setupterm"><strong>setupterm</strong></a>(...)</dt></dl> + <dl><dt><a name="-termattrs"><strong>termattrs</strong></a>(...)</dt></dl> + <dl><dt><a name="-termname"><strong>termname</strong></a>(...)</dt></dl> + <dl><dt><a name="-tigetflag"><strong>tigetflag</strong></a>(...)</dt></dl> + <dl><dt><a name="-tigetnum"><strong>tigetnum</strong></a>(...)</dt></dl> + <dl><dt><a name="-tigetstr"><strong>tigetstr</strong></a>(...)</dt></dl> + <dl><dt><a name="-tparm"><strong>tparm</strong></a>(...)</dt></dl> + <dl><dt><a name="-typeahead"><strong>typeahead</strong></a>(...)</dt></dl> + <dl><dt><a name="-ungetch"><strong>ungetch</strong></a>(...)</dt></dl> + <dl><dt><a name="-ungetmouse"><strong>ungetmouse</strong></a>(...)</dt></dl> + <dl><dt><a name="-use_default_colors"><strong>use_default_colors</strong></a>(...)</dt></dl> + <dl><dt><a name="-use_env"><strong>use_env</strong></a>(...)</dt></dl> +</td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#55aa55"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> + +<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> +<td width="100%"><strong>ACK</strong> = 6<br> +<strong>ALLOWED_BOOKMARK_KEYS</strong> = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789`'"<br> +<strong>ALL_MOUSE_EVENTS</strong> = 134217727<br> +<strong>A_ALTCHARSET</strong> = 4194304<br> +<strong>A_ATTRIBUTES</strong> = 4294967040<br> +<strong>A_BLINK</strong> = 524288<br> +<strong>A_BOLD</strong> = 2097152<br> +<strong>A_CHARTEXT</strong> = 255<br> +<strong>A_COLOR</strong> = 65280<br> +<strong>A_DIM</strong> = 1048576<br> +<strong>A_HORIZONTAL</strong> = 33554432<br> +<strong>A_INVIS</strong> = 8388608<br> +<strong>A_LEFT</strong> = 67108864<br> +<strong>A_LOW</strong> = 134217728<br> +<strong>A_NORMAL</strong> = 0<br> +<strong>A_PROTECT</strong> = 16777216<br> +<strong>A_REVERSE</strong> = 262144<br> +<strong>A_RIGHT</strong> = 268435456<br> +<strong>A_STANDOUT</strong> = 65536<br> +<strong>A_TOP</strong> = 536870912<br> +<strong>A_UNDERLINE</strong> = 131072<br> +<strong>A_VERTICAL</strong> = 1073741824<br> +<strong>BEL</strong> = 7<br> +<strong>BS</strong> = 8<br> +<strong>BUTTON1_CLICKED</strong> = 4<br> +<strong>BUTTON1_DOUBLE_CLICKED</strong> = 8<br> +<strong>BUTTON1_PRESSED</strong> = 2<br> +<strong>BUTTON1_RELEASED</strong> = 1<br> +<strong>BUTTON1_TRIPLE_CLICKED</strong> = 16<br> +<strong>BUTTON2_CLICKED</strong> = 256<br> +<strong>BUTTON2_DOUBLE_CLICKED</strong> = 512<br> +<strong>BUTTON2_PRESSED</strong> = 128<br> +<strong>BUTTON2_RELEASED</strong> = 64<br> +<strong>BUTTON2_TRIPLE_CLICKED</strong> = 1024<br> +<strong>BUTTON3_CLICKED</strong> = 16384<br> +<strong>BUTTON3_DOUBLE_CLICKED</strong> = 32768<br> +<strong>BUTTON3_PRESSED</strong> = 8192<br> +<strong>BUTTON3_RELEASED</strong> = 4096<br> +<strong>BUTTON3_TRIPLE_CLICKED</strong> = 65536<br> +<strong>BUTTON4_CLICKED</strong> = 1048576<br> +<strong>BUTTON4_DOUBLE_CLICKED</strong> = 2097152<br> +<strong>BUTTON4_PRESSED</strong> = 524288<br> +<strong>BUTTON4_RELEASED</strong> = 262144<br> +<strong>BUTTON4_TRIPLE_CLICKED</strong> = 4194304<br> +<strong>BUTTON_ALT</strong> = 67108864<br> +<strong>BUTTON_CTRL</strong> = 16777216<br> +<strong>BUTTON_SHIFT</strong> = 33554432<br> +<strong>CAN</strong> = 24<br> +<strong>COLOR_BLACK</strong> = 0<br> +<strong>COLOR_BLUE</strong> = 4<br> +<strong>COLOR_CYAN</strong> = 6<br> +<strong>COLOR_GREEN</strong> = 2<br> +<strong>COLOR_MAGENTA</strong> = 5<br> +<strong>COLOR_RED</strong> = 1<br> +<strong>COLOR_WHITE</strong> = 7<br> +<strong>COLOR_YELLOW</strong> = 3<br> +<strong>CR</strong> = 13<br> +<strong>DC1</strong> = 17<br> +<strong>DC2</strong> = 18<br> +<strong>DC3</strong> = 19<br> +<strong>DC4</strong> = 20<br> +<strong>DEL</strong> = 127<br> +<strong>DLE</strong> = 16<br> +<strong>EM</strong> = 25<br> +<strong>ENQ</strong> = 5<br> +<strong>EOT</strong> = 4<br> +<strong>ERR</strong> = -1<br> +<strong>ESC</strong> = 27<br> +<strong>ETB</strong> = 23<br> +<strong>ETX</strong> = 3<br> +<strong>FF</strong> = 12<br> +<strong>FS</strong> = 28<br> +<strong>GS</strong> = 29<br> +<strong>HT</strong> = 9<br> +<strong>KEY_A1</strong> = 348<br> +<strong>KEY_A3</strong> = 349<br> +<strong>KEY_B2</strong> = 350<br> +<strong>KEY_BACKSPACE</strong> = 263<br> +<strong>KEY_BEG</strong> = 354<br> +<strong>KEY_BREAK</strong> = 257<br> +<strong>KEY_BTAB</strong> = 353<br> +<strong>KEY_C1</strong> = 351<br> +<strong>KEY_C3</strong> = 352<br> +<strong>KEY_CANCEL</strong> = 355<br> +<strong>KEY_CATAB</strong> = 342<br> +<strong>KEY_CLEAR</strong> = 333<br> +<strong>KEY_CLOSE</strong> = 356<br> +<strong>KEY_COMMAND</strong> = 357<br> +<strong>KEY_COPY</strong> = 358<br> +<strong>KEY_CREATE</strong> = 359<br> +<strong>KEY_CTAB</strong> = 341<br> +<strong>KEY_DC</strong> = 330<br> +<strong>KEY_DL</strong> = 328<br> +<strong>KEY_DOWN</strong> = 258<br> +<strong>KEY_EIC</strong> = 332<br> +<strong>KEY_END</strong> = 360<br> +<strong>KEY_ENTER</strong> = 343<br> +<strong>KEY_EOL</strong> = 335<br> +<strong>KEY_EOS</strong> = 334<br> +<strong>KEY_EXIT</strong> = 361<br> +<strong>KEY_F0</strong> = 264<br> +<strong>KEY_F1</strong> = 265<br> +<strong>KEY_F10</strong> = 274<br> +<strong>KEY_F11</strong> = 275<br> +<strong>KEY_F12</strong> = 276<br> +<strong>KEY_F13</strong> = 277<br> +<strong>KEY_F14</strong> = 278<br> +<strong>KEY_F15</strong> = 279<br> +<strong>KEY_F16</strong> = 280<br> +<strong>KEY_F17</strong> = 281<br> +<strong>KEY_F18</strong> = 282<br> +<strong>KEY_F19</strong> = 283<br> +<strong>KEY_F2</strong> = 266<br> +<strong>KEY_F20</strong> = 284<br> +<strong>KEY_F21</strong> = 285<br> +<strong>KEY_F22</strong> = 286<br> +<strong>KEY_F23</strong> = 287<br> +<strong>KEY_F24</strong> = 288<br> +<strong>KEY_F25</strong> = 289<br> +<strong>KEY_F26</strong> = 290<br> +<strong>KEY_F27</strong> = 291<br> +<strong>KEY_F28</strong> = 292<br> +<strong>KEY_F29</strong> = 293<br> +<strong>KEY_F3</strong> = 267<br> +<strong>KEY_F30</strong> = 294<br> +<strong>KEY_F31</strong> = 295<br> +<strong>KEY_F32</strong> = 296<br> +<strong>KEY_F33</strong> = 297<br> +<strong>KEY_F34</strong> = 298<br> +<strong>KEY_F35</strong> = 299<br> +<strong>KEY_F36</strong> = 300<br> +<strong>KEY_F37</strong> = 301<br> +<strong>KEY_F38</strong> = 302<br> +<strong>KEY_F39</strong> = 303<br> +<strong>KEY_F4</strong> = 268<br> +<strong>KEY_F40</strong> = 304<br> +<strong>KEY_F41</strong> = 305<br> +<strong>KEY_F42</strong> = 306<br> +<strong>KEY_F43</strong> = 307<br> +<strong>KEY_F44</strong> = 308<br> +<strong>KEY_F45</strong> = 309<br> +<strong>KEY_F46</strong> = 310<br> +<strong>KEY_F47</strong> = 311<br> +<strong>KEY_F48</strong> = 312<br> +<strong>KEY_F49</strong> = 313<br> +<strong>KEY_F5</strong> = 269<br> +<strong>KEY_F50</strong> = 314<br> +<strong>KEY_F51</strong> = 315<br> +<strong>KEY_F52</strong> = 316<br> +<strong>KEY_F53</strong> = 317<br> +<strong>KEY_F54</strong> = 318<br> +<strong>KEY_F55</strong> = 319<br> +<strong>KEY_F56</strong> = 320<br> +<strong>KEY_F57</strong> = 321<br> +<strong>KEY_F58</strong> = 322<br> +<strong>KEY_F59</strong> = 323<br> +<strong>KEY_F6</strong> = 270<br> +<strong>KEY_F60</strong> = 324<br> +<strong>KEY_F61</strong> = 325<br> +<strong>KEY_F62</strong> = 326<br> +<strong>KEY_F63</strong> = 327<br> +<strong>KEY_F7</strong> = 271<br> +<strong>KEY_F8</strong> = 272<br> +<strong>KEY_F9</strong> = 273<br> +<strong>KEY_FIND</strong> = 362<br> +<strong>KEY_HELP</strong> = 363<br> +<strong>KEY_HOME</strong> = 262<br> +<strong>KEY_IC</strong> = 331<br> +<strong>KEY_IL</strong> = 329<br> +<strong>KEY_LEFT</strong> = 260<br> +<strong>KEY_LL</strong> = 347<br> +<strong>KEY_MARK</strong> = 364<br> +<strong>KEY_MAX</strong> = 511<br> +<strong>KEY_MESSAGE</strong> = 365<br> +<strong>KEY_MIN</strong> = 257<br> +<strong>KEY_MOUSE</strong> = 409<br> +<strong>KEY_MOVE</strong> = 366<br> +<strong>KEY_NEXT</strong> = 367<br> +<strong>KEY_NPAGE</strong> = 338<br> +<strong>KEY_OPEN</strong> = 368<br> +<strong>KEY_OPTIONS</strong> = 369<br> +<strong>KEY_PPAGE</strong> = 339<br> +<strong>KEY_PREVIOUS</strong> = 370<br> +<strong>KEY_PRINT</strong> = 346<br> +<strong>KEY_REDO</strong> = 371<br> +<strong>KEY_REFERENCE</strong> = 372<br> +<strong>KEY_REFRESH</strong> = 373<br> +<strong>KEY_REPLACE</strong> = 374<br> +<strong>KEY_RESET</strong> = 345<br> +<strong>KEY_RESIZE</strong> = 410<br> +<strong>KEY_RESTART</strong> = 375<br> +<strong>KEY_RESUME</strong> = 376<br> +<strong>KEY_RIGHT</strong> = 261<br> +<strong>KEY_SAVE</strong> = 377<br> +<strong>KEY_SBEG</strong> = 378<br> +<strong>KEY_SCANCEL</strong> = 379<br> +<strong>KEY_SCOMMAND</strong> = 380<br> +<strong>KEY_SCOPY</strong> = 381<br> +<strong>KEY_SCREATE</strong> = 382<br> +<strong>KEY_SDC</strong> = 383<br> +<strong>KEY_SDL</strong> = 384<br> +<strong>KEY_SELECT</strong> = 385<br> +<strong>KEY_SEND</strong> = 386<br> +<strong>KEY_SEOL</strong> = 387<br> +<strong>KEY_SEXIT</strong> = 388<br> +<strong>KEY_SF</strong> = 336<br> +<strong>KEY_SFIND</strong> = 389<br> +<strong>KEY_SHELP</strong> = 390<br> +<strong>KEY_SHOME</strong> = 391<br> +<strong>KEY_SIC</strong> = 392<br> +<strong>KEY_SLEFT</strong> = 393<br> +<strong>KEY_SMESSAGE</strong> = 394<br> +<strong>KEY_SMOVE</strong> = 395<br> +<strong>KEY_SNEXT</strong> = 396<br> +<strong>KEY_SOPTIONS</strong> = 397<br> +<strong>KEY_SPREVIOUS</strong> = 398<br> +<strong>KEY_SPRINT</strong> = 399<br> +<strong>KEY_SR</strong> = 337<br> +<strong>KEY_SREDO</strong> = 400<br> +<strong>KEY_SREPLACE</strong> = 401<br> +<strong>KEY_SRESET</strong> = 344<br> +<strong>KEY_SRIGHT</strong> = 402<br> +<strong>KEY_SRSUME</strong> = 403<br> +<strong>KEY_SSAVE</strong> = 404<br> +<strong>KEY_SSUSPEND</strong> = 405<br> +<strong>KEY_STAB</strong> = 340<br> +<strong>KEY_SUNDO</strong> = 406<br> +<strong>KEY_SUSPEND</strong> = 407<br> +<strong>KEY_UNDO</strong> = 408<br> +<strong>KEY_UP</strong> = 259<br> +<strong>LF</strong> = 10<br> +<strong>NAK</strong> = 21<br> +<strong>NL</strong> = 10<br> +<strong>NUL</strong> = 0<br> +<strong>OK</strong> = 0<br> +<strong>RANGERDIR</strong> = '/home/hut/work/ranger/ranger'<br> +<strong>REPORT_MOUSE_POSITION</strong> = 134217728<br> +<strong>RS</strong> = 30<br> +<strong>SI</strong> = 15<br> +<strong>SO</strong> = 14<br> +<strong>SOH</strong> = 1<br> +<strong>SP</strong> = 32<br> +<strong>STX</strong> = 2<br> +<strong>SUB</strong> = 26<br> +<strong>SYN</strong> = 22<br> +<strong>TAB</strong> = 9<br> +<strong>US</strong> = 31<br> +<strong>VT</strong> = 11<br> +<strong>controlnames</strong> = ['NUL', 'SOH', 'STX', 'ETX', 'EOT', 'ENQ', 'ACK', 'BEL', 'BS', 'HT', 'LF', 'VT', 'FF', 'CR', 'SO', 'SI', 'DLE', 'DC1', 'DC2', 'DC3', ...]<br> +<strong>version</strong> = b'2.2'</td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/ranger.defaults.options.html b/doc/ranger.defaults.options.html new file mode 100644 index 00000000..09542348 --- /dev/null +++ b/doc/ranger.defaults.options.html @@ -0,0 +1,41 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module ranger.defaults.options</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.defaults.html"><font color="#ffffff">defaults</font></a>.options</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/defaults/options.py">/home/hut/work/ranger/ranger/defaults/options.py</a></font></td></tr></table> + <p></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</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.defaults.apps.html">ranger.defaults.apps</a><br> +</td><td width="25%" valign=top><a href="ranger.colorschemes.default.html">ranger.colorschemes.default</a><br> +</td><td width="25%" valign=top><a href="ranger.colorschemes.html">ranger.colorschemes</a><br> +</td><td width="25%" valign=top><a href="ranger.defaults.keys.html">ranger.defaults.keys</a><br> +</td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#55aa55"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> + +<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> +<td width="100%"><strong>auto_load_preview</strong> = True<br> +<strong>collapse_preview</strong> = True<br> +<strong>directories_first</strong> = True<br> +<strong>max_dirsize_for_autopreview</strong> = None<br> +<strong>max_history_size</strong> = 20<br> +<strong>preview_files</strong> = False<br> +<strong>reverse</strong> = False<br> +<strong>scroll_offset</strong> = 2<br> +<strong>show_hidden</strong> = False<br> +<strong>sort</strong> = 'basename'</td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/ranger.ext.accumulator.html b/doc/ranger.ext.accumulator.html new file mode 100644 index 00000000..7a1a2304 --- /dev/null +++ b/doc/ranger.ext.accumulator.html @@ -0,0 +1,59 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module ranger.ext.accumulator</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.ext.html"><font color="#ffffff">ext</font></a>.accumulator</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/ext/accumulator.py">/home/hut/work/ranger/ranger/ext/accumulator.py</a></font></td></tr></table> + <p></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="builtins.html#object">builtins.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="ranger.ext.accumulator.html#Accumulator">Accumulator</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="Accumulator">class <strong>Accumulator</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="Accumulator-__init__"><strong>__init__</strong></a>(self)</dt></dl> + +<dl><dt><a name="Accumulator-correct_pointer"><strong>correct_pointer</strong></a>(self)</dt></dl> + +<dl><dt><a name="Accumulator-get_list"><strong>get_list</strong></a>(self)</dt><dd><tt>OVERRIDE THIS</tt></dd></dl> + +<dl><dt><a name="Accumulator-move"><strong>move</strong></a>(self, relative<font color="#909090">=0</font>, absolute<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="Accumulator-move_to_obj"><strong>move_to_obj</strong></a>(self, arg, attr<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="Accumulator-pointer_is_synced"><strong>pointer_is_synced</strong></a>(self)</dt></dl> + +<dl><dt><a name="Accumulator-sync_index"><strong>sync_index</strong></a>(self, **kw)</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> +</td></tr></table></td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/ranger.ext.debug.html b/doc/ranger.ext.debug.html new file mode 100644 index 00000000..e3a49ead --- /dev/null +++ b/doc/ranger.ext.debug.html @@ -0,0 +1,31 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module ranger.ext.debug</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.ext.html"><font color="#ffffff">ext</font></a>.debug</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/ext/debug.py">/home/hut/work/ranger/ranger/ext/debug.py</a></font></td></tr></table> + <p></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#eeaa77"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> + +<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt><a name="-log"><strong>log</strong></a>(*objects, **keywords)</dt><dd><tt>Writes objects to a logfile.<br> +Has the same arguments as print() in python3</tt></dd></dl> + <dl><dt><a name="-trace"><strong>trace</strong></a>()</dt></dl> +</td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#55aa55"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> + +<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> +<td width="100%"><strong>LOGFILE</strong> = '/tmp/errorlog'</td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/ranger.ext.get_all_modules.html b/doc/ranger.ext.get_all_modules.html new file mode 100644 index 00000000..b7698581 --- /dev/null +++ b/doc/ranger.ext.get_all_modules.html @@ -0,0 +1,22 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module ranger.ext.get_all_modules</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.ext.html"><font color="#ffffff">ext</font></a>.get_all_modules</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/ext/get_all_modules.py">/home/hut/work/ranger/ranger/ext/get_all_modules.py</a></font></td></tr></table> + <p></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#eeaa77"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> + +<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt><a name="-get_all_modules"><strong>get_all_modules</strong></a>(dirname)</dt><dd><tt>returns a list of strings containing the names of modules in a directory</tt></dd></dl> +</td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/ranger.ext.html b/doc/ranger.ext.html new file mode 100644 index 00000000..06848c5d --- /dev/null +++ b/doc/ranger.ext.html @@ -0,0 +1,29 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: package ranger.ext</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>.ext</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/ext/__init__.py">/home/hut/work/ranger/ranger/ext/__init__.py</a></font></td></tr></table> + <p><tt>This package includes extensions with broader usability</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<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.ext.accumulator.html">accumulator</a><br> +<a href="ranger.ext.debug.html">debug</a><br> +</td><td width="25%" valign=top><a href="ranger.ext.get_all_modules.html">get_all_modules</a><br> +<a href="ranger.ext.human_readable.html">human_readable</a><br> +</td><td width="25%" valign=top><a href="ranger.ext.openstruct.html">openstruct</a><br> +<a href="ranger.ext.relpath.html">relpath</a><br> +</td><td width="25%" valign=top><a href="ranger.ext.shutil_generatorized.html">shutil_generatorized</a><br> +<a href="ranger.ext.waitpid_no_intr.html">waitpid_no_intr</a><br> +</td></tr></table></td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/ranger.ext.human_readable.html b/doc/ranger.ext.human_readable.html new file mode 100644 index 00000000..d1815c9b --- /dev/null +++ b/doc/ranger.ext.human_readable.html @@ -0,0 +1,31 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module ranger.ext.human_readable</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.ext.html"><font color="#ffffff">ext</font></a>.human_readable</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/ext/human_readable.py">/home/hut/work/ranger/ranger/ext/human_readable.py</a></font></td></tr></table> + <p></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#eeaa77"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> + +<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt><a name="-human_readable"><strong>human_readable</strong></a>(byte)</dt></dl> +</td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#55aa55"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> + +<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> +<td width="100%"><strong>MAX_EXPONENT</strong> = 5<br> +<strong>ONE_KB</strong> = 1024<br> +<strong>UNITS</strong> = 'BKMGTP'</td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/ranger.ext.openstruct.html b/doc/ranger.ext.openstruct.html new file mode 100644 index 00000000..798c7352 --- /dev/null +++ b/doc/ranger.ext.openstruct.html @@ -0,0 +1,53 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module ranger.ext.openstruct</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.ext.html"><font color="#ffffff">ext</font></a>.openstruct</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/ext/openstruct.py">/home/hut/work/ranger/ranger/ext/openstruct.py</a></font></td></tr></table> + <p></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="builtins.html#object">builtins.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="ranger.ext.openstruct.html#OpenStruct">OpenStruct</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="OpenStruct">class <strong>OpenStruct</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="OpenStruct-__contains__"><strong>__contains__</strong></a>(self, key)</dt></dl> + +<dl><dt><a name="OpenStruct-__getitem__"><strong>__getitem__</strong></a>(self, key)</dt></dl> + +<dl><dt><a name="OpenStruct-__init__"><strong>__init__</strong></a>(self, _OpenStruct__dictionary<font color="#909090">=None</font>, **_OpenStruct__keywords)</dt></dl> + +<dl><dt><a name="OpenStruct-__setitem__"><strong>__setitem__</strong></a>(self, key, value)</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> +</td></tr></table></td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/ranger.ext.relpath.html b/doc/ranger.ext.relpath.html new file mode 100644 index 00000000..0e431e12 --- /dev/null +++ b/doc/ranger.ext.relpath.html @@ -0,0 +1,32 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module ranger.ext.relpath</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.ext.html"><font color="#ffffff">ext</font></a>.relpath</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/ext/relpath.py">/home/hut/work/ranger/ranger/ext/relpath.py</a></font></td></tr></table> + <p></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</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="os.html">os</a><br> +</td><td width="25%" valign=top><a href="ranger.html">ranger</a><br> +</td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#eeaa77"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> + +<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt><a name="-relpath"><strong>relpath</strong></a>(*paths)</dt><dd><tt>returns the path relative to rangers library directory</tt></dd></dl> + <dl><dt><a name="-relpath_conf"><strong>relpath_conf</strong></a>(*paths)</dt><dd><tt>returns the path relative to rangers configuration directory</tt></dd></dl> +</td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/ranger.ext.shutil_generatorized.html b/doc/ranger.ext.shutil_generatorized.html new file mode 100644 index 00000000..bee4db77 --- /dev/null +++ b/doc/ranger.ext.shutil_generatorized.html @@ -0,0 +1,257 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module ranger.ext.shutil_generatorized</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.ext.html"><font color="#ffffff">ext</font></a>.shutil_generatorized</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/ext/shutil_generatorized.py">/home/hut/work/ranger/ranger/ext/shutil_generatorized.py</a></font></td></tr></table> + <p><tt>Utility functions for copying files and directory trees.<br> + <br> +XXX The functions here don't copy the resource fork or other metadata on Mac.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</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="fnmatch.html">fnmatch</a><br> +</td><td width="25%" valign=top><a href="os.html">os</a><br> +</td><td width="25%" valign=top><a href="stat.html">stat</a><br> +</td><td width="25%" valign=top><a href="sys.html">sys</a><br> +</td></tr></table></td></tr></table><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="builtins.html#EnvironmentError">builtins.EnvironmentError</a>(<a href="builtins.html#Exception">builtins.Exception</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="ranger.ext.shutil_generatorized.html#Error">Error</a> +</font></dt><dt><font face="helvetica, arial"><a href="ranger.ext.shutil_generatorized.html#SpecialFileError">SpecialFileError</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="Error">class <strong>Error</strong></a>(<a href="builtins.html#EnvironmentError">builtins.EnvironmentError</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.ext.shutil_generatorized.html#Error">Error</a></dd> +<dd><a href="builtins.html#EnvironmentError">builtins.EnvironmentError</a></dd> +<dd><a href="builtins.html#Exception">builtins.Exception</a></dd> +<dd><a href="builtins.html#BaseException">builtins.BaseException</a></dd> +<dd><a href="builtins.html#object">builtins.object</a></dd> +</dl> +<hr> +Data descriptors defined here:<br> +<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#EnvironmentError">builtins.EnvironmentError</a>:<br> +<dl><dt><a name="Error-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__init__">__init__</a>(...) initializes x; see x.__class__.__doc__ for signature</tt></dd></dl> + +<dl><dt><a name="Error-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> + +<dl><dt><a name="Error-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__str__">__str__</a>() <==> str(x)</tt></dd></dl> + +<hr> +Data descriptors inherited from <a href="builtins.html#EnvironmentError">builtins.EnvironmentError</a>:<br> +<dl><dt><strong>errno</strong></dt> +<dd><tt>exception errno</tt></dd> +</dl> +<dl><dt><strong>filename</strong></dt> +<dd><tt>exception filename</tt></dd> +</dl> +<dl><dt><strong>strerror</strong></dt> +<dd><tt>exception strerror</tt></dd> +</dl> +<hr> +Data and other attributes inherited from <a href="builtins.html#EnvironmentError">builtins.EnvironmentError</a>:<br> +<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object at 0x7f327d94ac80><dd><tt>T.<a href="#Error-__new__">__new__</a>(S, ...) -> a new object with type S, a subtype of T</tt></dl> + +<hr> +Methods inherited from <a href="builtins.html#BaseException">builtins.BaseException</a>:<br> +<dl><dt><a name="Error-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> + +<dl><dt><a name="Error-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> + +<dl><dt><a name="Error-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> + +<dl><dt><a name="Error-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> + +<dl><dt><a name="Error-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> + +<dl><dt><a name="Error-with_traceback"><strong>with_traceback</strong></a>(...)</dt><dd><tt>Exception.<a href="#Error-with_traceback">with_traceback</a>(tb) --<br> +set self.<strong>__traceback__</strong> to tb and return self.</tt></dd></dl> + +<hr> +Data descriptors inherited from <a href="builtins.html#BaseException">builtins.BaseException</a>:<br> +<dl><dt><strong>__cause__</strong></dt> +<dd><tt>exception cause</tt></dd> +</dl> +<dl><dt><strong>__context__</strong></dt> +<dd><tt>exception context</tt></dd> +</dl> +<dl><dt><strong>__dict__</strong></dt> +</dl> +<dl><dt><strong>__traceback__</strong></dt> +</dl> +<dl><dt><strong>args</strong></dt> +</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="SpecialFileError">class <strong>SpecialFileError</strong></a>(<a href="builtins.html#EnvironmentError">builtins.EnvironmentError</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>Raised when trying to do a kind of operation (e.g. copying) which is<br> +not supported on a special file (e.g. a named pipe)<br> </tt></td></tr> +<tr><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="ranger.ext.shutil_generatorized.html#SpecialFileError">SpecialFileError</a></dd> +<dd><a href="builtins.html#EnvironmentError">builtins.EnvironmentError</a></dd> +<dd><a href="builtins.html#Exception">builtins.Exception</a></dd> +<dd><a href="builtins.html#BaseException">builtins.BaseException</a></dd> +<dd><a href="builtins.html#object">builtins.object</a></dd> +</dl> +<hr> +Data descriptors defined here:<br> +<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#EnvironmentError">builtins.EnvironmentError</a>:<br> +<dl><dt><a name="SpecialFileError-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#SpecialFileError-__init__">__init__</a>(...) initializes x; see x.__class__.__doc__ for signature</tt></dd></dl> + +<dl><dt><a name="SpecialFileError-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> + +<dl><dt><a name="SpecialFileError-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#SpecialFileError-__str__">__str__</a>() <==> str(x)</tt></dd></dl> + +<hr> +Data descriptors inherited from <a href="builtins.html#EnvironmentError">builtins.EnvironmentError</a>:<br> +<dl><dt><strong>errno</strong></dt> +<dd><tt>exception errno</tt></dd> +</dl> +<dl><dt><strong>filename</strong></dt> +<dd><tt>exception filename</tt></dd> +</dl> +<dl><dt><strong>strerror</strong></dt> +<dd><tt>exception strerror</tt></dd> +</dl> +<hr> +Data and other attributes inherited from <a href="builtins.html#EnvironmentError">builtins.EnvironmentError</a>:<br> +<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object at 0x7f327d94ac80><dd><tt>T.<a href="#SpecialFileError-__new__">__new__</a>(S, ...) -> a new object with type S, a subtype of T</tt></dl> + +<hr> +Methods inherited from <a href="builtins.html#BaseException">builtins.BaseException</a>:<br> +<dl><dt><a name="SpecialFileError-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#SpecialFileError-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> + +<dl><dt><a name="SpecialFileError-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#SpecialFileError-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> + +<dl><dt><a name="SpecialFileError-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#SpecialFileError-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> + +<dl><dt><a name="SpecialFileError-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#SpecialFileError-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> + +<dl><dt><a name="SpecialFileError-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> + +<dl><dt><a name="SpecialFileError-with_traceback"><strong>with_traceback</strong></a>(...)</dt><dd><tt>Exception.<a href="#SpecialFileError-with_traceback">with_traceback</a>(tb) --<br> +set self.<strong>__traceback__</strong> to tb and return self.</tt></dd></dl> + +<hr> +Data descriptors inherited from <a href="builtins.html#BaseException">builtins.BaseException</a>:<br> +<dl><dt><strong>__cause__</strong></dt> +<dd><tt>exception cause</tt></dd> +</dl> +<dl><dt><strong>__context__</strong></dt> +<dd><tt>exception context</tt></dd> +</dl> +<dl><dt><strong>__dict__</strong></dt> +</dl> +<dl><dt><strong>__traceback__</strong></dt> +</dl> +<dl><dt><strong>args</strong></dt> +</dl> +</td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#eeaa77"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> + +<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt><a name="-copy"><strong>copy</strong></a>(src, dst)</dt><dd><tt>Copy data and mode bits ("cp src dst").<br> + <br> +The destination may be a directory.</tt></dd></dl> + <dl><dt><a name="-copy2"><strong>copy2</strong></a>(src, dst)</dt><dd><tt>Copy data and all stat info ("cp -p src dst").<br> + <br> +The destination may be a directory.</tt></dd></dl> + <dl><dt><a name="-copyfile"><strong>copyfile</strong></a>(src, dst)</dt><dd><tt>Copy data from src to dst</tt></dd></dl> + <dl><dt><a name="-copyfileobj"><strong>copyfileobj</strong></a>(fsrc, fdst, length<font color="#909090">=16384</font>)</dt><dd><tt>copy data from file-like object fsrc to file-like object fdst</tt></dd></dl> + <dl><dt><a name="-copymode"><strong>copymode</strong></a>(src, dst)</dt><dd><tt>Copy mode bits from src to dst</tt></dd></dl> + <dl><dt><a name="-copystat"><strong>copystat</strong></a>(src, dst)</dt><dd><tt>Copy all stat info (mode bits, atime, mtime, flags) from src to dst</tt></dd></dl> + <dl><dt><a name="-copytree"><strong>copytree</strong></a>(src, dst, symlinks<font color="#909090">=False</font>, ignore<font color="#909090">=None</font>)</dt><dd><tt>Recursively copy a directory tree using <a href="#-copy2">copy2</a>().<br> + <br> +The destination directory must not already exist.<br> +If exception(s) occur, an <a href="#Error">Error</a> is raised with a list of reasons.<br> + <br> +If the optional symlinks flag is true, symbolic links in the<br> +source tree result in symbolic links in the destination tree; if<br> +it is false, the contents of the files pointed to by symbolic<br> +links are copied.<br> + <br> +The optional ignore argument is a callable. If given, it<br> +is called with the `src` parameter, which is the directory<br> +being visited by <a href="#-copytree">copytree</a>(), and `names` which is the list of<br> +`src` contents, as returned by os.listdir():<br> + <br> + callable(src, names) -> ignored_names<br> + <br> +Since <a href="#-copytree">copytree</a>() is called recursively, the callable will be<br> +called once for each directory that is copied. It returns a<br> +list of names relative to the `src` directory that should<br> +not be copied.<br> + <br> +XXX Consider this example code rather than the ultimate tool.</tt></dd></dl> + <dl><dt><a name="-move"><strong>move</strong></a>(src, dst)</dt><dd><tt>Recursively move a file or directory to another location. This is<br> +similar to the Unix "mv" command.<br> + <br> +If the destination is a directory or a symlink to a directory, the source<br> +is moved inside the directory. The destination path must not already<br> +exist.<br> + <br> +If the destination already exists but is not a directory, it may be<br> +overwritten depending on os.rename() semantics.<br> + <br> +If the destination is on our current filesystem, then rename() is used.<br> +Otherwise, src is copied to the destination and then removed.<br> +A lot more could be done here... A look at a mv.c shows a lot of<br> +the issues this implementation glosses over.</tt></dd></dl> + <dl><dt><a name="-rmtree"><strong>rmtree</strong></a>(path, ignore_errors<font color="#909090">=False</font>, onerror<font color="#909090">=None</font>)</dt><dd><tt>Recursively delete a directory tree.<br> + <br> +If ignore_errors is set, errors are ignored; otherwise, if onerror<br> +is set, it is called to handle the error with arguments (func,<br> +path, exc_info) where func is os.listdir, os.remove, or os.rmdir;<br> +path is the argument to that function that caused it to fail; and<br> +exc_info is a tuple returned by sys.exc_info(). If ignore_errors<br> +is false and onerror is None, an exception is raised.</tt></dd></dl> +</td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#55aa55"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> + +<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> +<td width="100%"><strong>__all__</strong> = ['copyfileobj', 'copyfile', 'copymode', 'copystat', 'copy', 'copy2', 'copytree', 'move', 'rmtree', 'Error', 'SpecialFileError']</td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/ranger.ext.waitpid_no_intr.html b/doc/ranger.ext.waitpid_no_intr.html new file mode 100644 index 00000000..147d6896 --- /dev/null +++ b/doc/ranger.ext.waitpid_no_intr.html @@ -0,0 +1,22 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module ranger.ext.waitpid_no_intr</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.ext.html"><font color="#ffffff">ext</font></a>.waitpid_no_intr</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/ext/waitpid_no_intr.py">/home/hut/work/ranger/ranger/ext/waitpid_no_intr.py</a></font></td></tr></table> + <p></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#eeaa77"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> + +<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt><a name="-waitpid_no_intr"><strong>waitpid_no_intr</strong></a>(pid)</dt><dd><tt>catch interrupts which occur while using os.waitpid</tt></dd></dl> +</td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/ranger.fm.html b/doc/ranger.fm.html new file mode 100644 index 00000000..2d4f7f62 --- /dev/null +++ b/doc/ranger.fm.html @@ -0,0 +1,182 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module ranger.fm</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>.fm</strong></big></big> (version 1.0.0)</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/fm.py">/home/hut/work/ranger/ranger/fm.py</a></font></td></tr></table> + <p></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.actions.html#Actions">ranger.actions.Actions</a>(<a href="ranger.shared.html#EnvironmentAware">ranger.shared.EnvironmentAware</a>, <a href="ranger.shared.settings.html#SettingsAware">ranger.shared.settings.SettingsAware</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="ranger.fm.html#FM">FM</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="FM">class <strong>FM</strong></a>(<a href="ranger.actions.html#Actions">ranger.actions.Actions</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.fm.html#FM">FM</a></dd> +<dd><a href="ranger.actions.html#Actions">ranger.actions.Actions</a></dd> +<dd><a href="ranger.shared.html#EnvironmentAware">ranger.shared.EnvironmentAware</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="FM-__init__"><strong>__init__</strong></a>(self, ui<font color="#909090">=None</font>, bookmarks<font color="#909090">=None</font>)</dt><dd><tt>Initialize <a href="#FM">FM</a>.</tt></dd></dl> + +<dl><dt><a name="FM-block_input"><strong>block_input</strong></a>(self, sec<font color="#909090">=0</font>)</dt></dl> + +<dl><dt><a name="FM-initialize"><strong>initialize</strong></a>(self)</dt><dd><tt>If ui/bookmarks are None, they will be initialized here.</tt></dd></dl> + +<dl><dt><a name="FM-loop"><strong>loop</strong></a>(self)</dt><dd><tt>The main loop consists of:<br> +1. reloading bookmarks if outdated<br> +2. drawing and finalizing ui<br> +3. reading and handling user input<br> +4. after X loops: collecting unused directory objects</tt></dd></dl> + +<hr> +Data and other attributes defined here:<br> +<dl><dt><strong>input_blocked</strong> = False</dl> + +<dl><dt><strong>input_blocked_until</strong> = 0</dl> + +<dl><dt><strong>stderr_to_out</strong> = False</dl> + +<hr> +Methods inherited from <a href="ranger.actions.html#Actions">ranger.actions.Actions</a>:<br> +<dl><dt><a name="FM-cd"><strong>cd</strong></a> = enter_dir(self, path)</dt><dd><tt>Enter the directory at the given path</tt></dd></dl> + +<dl><dt><a name="FM-copy"><strong>copy</strong></a>(self)</dt><dd><tt>Copy the selected items</tt></dd></dl> + +<dl><dt><a name="FM-cut"><strong>cut</strong></a>(self)</dt></dl> + +<dl><dt><a name="FM-delete"><strong>delete</strong></a>(self)</dt></dl> + +<dl><dt><a name="FM-edit_file"><strong>edit_file</strong></a>(self)</dt><dd><tt>Calls execute_file with the current file and app='editor'</tt></dd></dl> + +<dl><dt><a name="FM-enter_bookmark"><strong>enter_bookmark</strong></a>(self, key)</dt><dd><tt>Enter the bookmark with the name <key></tt></dd></dl> + +<dl><dt><a name="FM-enter_dir"><strong>enter_dir</strong></a>(self, path)</dt><dd><tt>Enter the directory at the given path</tt></dd></dl> + +<dl><dt><a name="FM-execute_file"><strong>execute_file</strong></a>(self, files, app<font color="#909090">=''</font>, flags<font color="#909090">=''</font>, mode<font color="#909090">=0</font>)</dt><dd><tt>Execute a file.<br> +app is the name of a method in Applications, without the "app_"<br> +flags is a string consisting of applications.ALLOWED_FLAGS<br> +mode is a positive integer.<br> +Both flags and mode specify how the program is run.</tt></dd></dl> + +<dl><dt><a name="FM-exit"><strong>exit</strong></a>(self)</dt><dd><tt>Exit the program</tt></dd></dl> + +<dl><dt><a name="FM-force_load_preview"><strong>force_load_preview</strong></a>(self)</dt></dl> + +<dl><dt><a name="FM-handle_mouse"><strong>handle_mouse</strong></a>(self)</dt><dd><tt>Handle mouse-buttons if one was pressed</tt></dd></dl> + +<dl><dt><a name="FM-history_go"><strong>history_go</strong></a>(self, relative)</dt><dd><tt>Move back and forth in the history</tt></dd></dl> + +<dl><dt><a name="FM-interrupt"><strong>interrupt</strong></a>(self)</dt><dd><tt>Waits a short time.<br> +If CTRL+C is pressed while waiting, the program will be exited.</tt></dd></dl> + +<dl><dt><a name="FM-mark"><strong>mark</strong></a>(self, all<font color="#909090">=False</font>, toggle<font color="#909090">=False</font>, val<font color="#909090">=None</font>, movedown<font color="#909090">=None</font>)</dt><dd><tt>A wrapper for the directory.mark_xyz functions.<br> + <br> +Arguments:<br> +all - change all files of the current directory at once?<br> +toggle - toggle the marked-status?<br> +val - mark or unmark?</tt></dd></dl> + +<dl><dt><a name="FM-mkdir"><strong>mkdir</strong></a>(self, name)</dt></dl> + +<dl><dt><a name="FM-move_left"><strong>move_left</strong></a>(self, n<font color="#909090">=1</font>)</dt><dd><tt>Enter the parent directory</tt></dd></dl> + +<dl><dt><a name="FM-move_pointer"><strong>move_pointer</strong></a>(self, relative<font color="#909090">=0</font>, absolute<font color="#909090">=None</font>)</dt><dd><tt>Move the pointer down by <relative> or to <absolute></tt></dd></dl> + +<dl><dt><a name="FM-move_pointer_by_pages"><strong>move_pointer_by_pages</strong></a>(self, relative)</dt><dd><tt>Move the pointer down by <relative> pages</tt></dd></dl> + +<dl><dt><a name="FM-move_pointer_by_percentage"><strong>move_pointer_by_percentage</strong></a>(self, relative<font color="#909090">=0</font>, absolute<font color="#909090">=None</font>)</dt><dd><tt>Move the pointer down by <relative>% or to <absolute>%</tt></dd></dl> + +<dl><dt><a name="FM-move_right"><strong>move_right</strong></a>(self, mode<font color="#909090">=0</font>)</dt><dd><tt>Enter the current directory or execute the current file</tt></dd></dl> + +<dl><dt><a name="FM-notify"><strong>notify</strong></a>(self, text, duration<font color="#909090">=4</font>, bad<font color="#909090">=False</font>)</dt></dl> + +<dl><dt><a name="FM-open_console"><strong>open_console</strong></a>(self, mode<font color="#909090">=':'</font>, string<font color="#909090">=''</font>)</dt><dd><tt>Open the console if the current UI supports that</tt></dd></dl> + +<dl><dt><a name="FM-paste"><strong>paste</strong></a>(self)</dt><dd><tt>Paste the selected items into the current directory</tt></dd></dl> + +<dl><dt><a name="FM-redraw_window"><strong>redraw_window</strong></a>(self)</dt><dd><tt>Redraw the window</tt></dd></dl> + +<dl><dt><a name="FM-reset"><strong>reset</strong></a>(self)</dt><dd><tt>Reset the filemanager, clearing the directory buffer</tt></dd></dl> + +<dl><dt><a name="FM-resize"><strong>resize</strong></a>(self)</dt><dd><tt>Update the size of the UI</tt></dd></dl> + +<dl><dt><a name="FM-scroll"><strong>scroll</strong></a>(self, relative)</dt><dd><tt>Scroll down by <relative> lines</tt></dd></dl> + +<dl><dt><a name="FM-search_backward"><strong>search_backward</strong></a>(self)</dt><dd><tt>Search backward for the regexp in self.<strong>env</strong>.last_search</tt></dd></dl> + +<dl><dt><a name="FM-search_forward"><strong>search_forward</strong></a>(self)</dt><dd><tt>Search forward for the regexp in self.<strong>env</strong>.last_search</tt></dd></dl> + +<dl><dt><a name="FM-set_bookmark"><strong>set_bookmark</strong></a>(self, key)</dt><dd><tt>Set the bookmark with the name <key> to the current directory</tt></dd></dl> + +<dl><dt><a name="FM-sort"><strong>sort</strong></a>(self, func<font color="#909090">=None</font>, reverse<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="FM-spawn"><strong>spawn</strong></a>(self, command)</dt></dl> + +<dl><dt><a name="FM-toggle_boolean_option"><strong>toggle_boolean_option</strong></a>(self, string)</dt><dd><tt>Toggle a boolean option named <string></tt></dd></dl> + +<dl><dt><a name="FM-unset_bookmark"><strong>unset_bookmark</strong></a>(self, key)</dt><dd><tt>Delete the bookmark with the name <key></tt></dd></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 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><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#eeaa77"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> + +<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt><a name="-time"><strong>time</strong></a>(...)</dt><dd><tt><a href="#-time">time</a>() -> floating point number<br> + <br> +Return the current time in seconds since the Epoch.<br> +Fractions of a second may be present if the system clock provides them.</tt></dd></dl> +</td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#55aa55"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> + +<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> +<td width="100%"><strong>CTRL_C</strong> = 3<br> +<strong>TICKS_BEFORE_COLLECTING_GARBAGE</strong> = 100<br> +<strong>__version__</strong> = '1.0.0'</td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/ranger.fsobject.directory.html b/doc/ranger.fsobject.directory.html new file mode 100644 index 00000000..ee87c5bb --- /dev/null +++ b/doc/ranger.fsobject.directory.html @@ -0,0 +1,344 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module ranger.fsobject.directory</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.fsobject.html"><font color="#ffffff">fsobject</font></a>.directory</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/fsobject/directory.py">/home/hut/work/ranger/ranger/fsobject/directory.py</a></font></td></tr></table> + <p></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</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.html">ranger</a><br> +</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><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="builtins.html#Exception">builtins.Exception</a>(<a href="builtins.html#BaseException">builtins.BaseException</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="ranger.fsobject.directory.html#NoDirectoryGiven">NoDirectoryGiven</a> +</font></dt></dl> +</dd> +<dt><font face="helvetica, arial"><a href="ranger.ext.accumulator.html#Accumulator">ranger.ext.accumulator.Accumulator</a>(<a href="builtins.html#object">builtins.object</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="ranger.fsobject.directory.html#Directory">Directory</a>(<a href="ranger.fsobject.fsobject.html#FileSystemObject">ranger.fsobject.fsobject.FileSystemObject</a>, <a href="ranger.ext.accumulator.html#Accumulator">ranger.ext.accumulator.Accumulator</a>, <a href="ranger.shared.settings.html#SettingsAware">ranger.shared.settings.SettingsAware</a>) +</font></dt></dl> +</dd> +<dt><font face="helvetica, arial"><a href="ranger.fsobject.fsobject.html#FileSystemObject">ranger.fsobject.fsobject.FileSystemObject</a>(<a href="ranger.shared.mimetype.html#MimeTypeAware">ranger.shared.mimetype.MimeTypeAware</a>, <a href="ranger.shared.html#FileManagerAware">ranger.shared.FileManagerAware</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="ranger.fsobject.directory.html#Directory">Directory</a>(<a href="ranger.fsobject.fsobject.html#FileSystemObject">ranger.fsobject.fsobject.FileSystemObject</a>, <a href="ranger.ext.accumulator.html#Accumulator">ranger.ext.accumulator.Accumulator</a>, <a href="ranger.shared.settings.html#SettingsAware">ranger.shared.settings.SettingsAware</a>) +</font></dt></dl> +</dd> +<dt><font face="helvetica, arial"><a href="ranger.shared.settings.html#SettingsAware">ranger.shared.settings.SettingsAware</a>(<a href="builtins.html#object">builtins.object</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="ranger.fsobject.directory.html#Directory">Directory</a>(<a href="ranger.fsobject.fsobject.html#FileSystemObject">ranger.fsobject.fsobject.FileSystemObject</a>, <a href="ranger.ext.accumulator.html#Accumulator">ranger.ext.accumulator.Accumulator</a>, <a href="ranger.shared.settings.html#SettingsAware">ranger.shared.settings.SettingsAware</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="Directory">class <strong>Directory</strong></a>(<a href="ranger.fsobject.fsobject.html#FileSystemObject">ranger.fsobject.fsobject.FileSystemObject</a>, <a href="ranger.ext.accumulator.html#Accumulator">ranger.ext.accumulator.Accumulator</a>, <a href="ranger.shared.settings.html#SettingsAware">ranger.shared.settings.SettingsAware</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.fsobject.directory.html#Directory">Directory</a></dd> +<dd><a href="ranger.fsobject.fsobject.html#FileSystemObject">ranger.fsobject.fsobject.FileSystemObject</a></dd> +<dd><a href="ranger.shared.mimetype.html#MimeTypeAware">ranger.shared.mimetype.MimeTypeAware</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.ext.accumulator.html#Accumulator">ranger.ext.accumulator.Accumulator</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="Directory-__eq__"><strong>__eq__</strong></a>(self, other)</dt><dd><tt>Check for equality of the directories paths</tt></dd></dl> + +<dl><dt><a name="Directory-__getitem__"><strong>__getitem__</strong></a>(self, key)</dt><dd><tt>Get the file by its index</tt></dd></dl> + +<dl><dt><a name="Directory-__hash__"><strong>__hash__</strong></a>(self)</dt></dl> + +<dl><dt><a name="Directory-__init__"><strong>__init__</strong></a>(self, path)</dt></dl> + +<dl><dt><a name="Directory-__len__"><strong>__len__</strong></a>(self)</dt><dd><tt>The number of containing files</tt></dd></dl> + +<dl><dt><a name="Directory-__neq__"><strong>__neq__</strong></a>(self, other)</dt><dd><tt>Check for inequality of the directories paths</tt></dd></dl> + +<dl><dt><a name="Directory-__nonzero__"><strong>__nonzero__</strong></a>(self)</dt><dd><tt>Always True</tt></dd></dl> + +<dl><dt><a name="Directory-correct_pointer"><strong>correct_pointer</strong></a>(self)</dt><dd><tt>Make sure the pointer is in the valid range</tt></dd></dl> + +<dl><dt><a name="Directory-empty"><strong>empty</strong></a>(self)</dt><dd><tt>Is the directory empty?</tt></dd></dl> + +<dl><dt><a name="Directory-get_list"><strong>get_list</strong></a>(self)</dt></dl> + +<dl><dt><a name="Directory-get_selection"><strong>get_selection</strong></a>(self)</dt><dd><tt>READ ONLY</tt></dd></dl> + +<dl><dt><a name="Directory-load_bit_by_bit"><strong>load_bit_by_bit</strong></a>(self)</dt><dd><tt>Returns a generator which load a part of the directory<br> +in each iteration.</tt></dd></dl> + +<dl><dt><a name="Directory-load_content"><strong>load_content</strong></a>(self, schedule<font color="#909090">=None</font>)</dt><dd><tt>Loads the contents of the directory. Use this sparingly since<br> +it takes rather long.</tt></dd></dl> + +<dl><dt><a name="Directory-load_content_if_outdated"><strong>load_content_if_outdated</strong></a>(self, *a, **k)</dt><dd><tt>Load the contents of the directory if it's<br> +outdated or not done yet</tt></dd></dl> + +<dl><dt><a name="Directory-load_content_once"><strong>load_content_once</strong></a>(self, *a, **k)</dt><dd><tt>Load the contents of the directory if not done yet</tt></dd></dl> + +<dl><dt><a name="Directory-mark_all"><strong>mark_all</strong></a>(self, val)</dt></dl> + +<dl><dt><a name="Directory-mark_item"><strong>mark_item</strong></a>(self, item, val)</dt></dl> + +<dl><dt><a name="Directory-move_to_obj"><strong>move_to_obj</strong></a>(self, arg)</dt></dl> + +<dl><dt><a name="Directory-search"><strong>search</strong></a>(self, arg, direction<font color="#909090">=1</font>)</dt><dd><tt>Search for a regular expression</tt></dd></dl> + +<dl><dt><a name="Directory-sort"><strong>sort</strong></a>(self)</dt><dd><tt>Sort the containing files</tt></dd></dl> + +<dl><dt><a name="Directory-sort_if_outdated"><strong>sort_if_outdated</strong></a>(self)</dt><dd><tt>Sort the containing files if they are outdated</tt></dd></dl> + +<dl><dt><a name="Directory-toggle_all_marks"><strong>toggle_all_marks</strong></a>(self)</dt></dl> + +<dl><dt><a name="Directory-toggle_mark"><strong>toggle_mark</strong></a>(self, item)</dt></dl> + +<dl><dt><a name="Directory-unload"><strong>unload</strong></a>(self)</dt></dl> + +<hr> +Data and other attributes defined here:<br> +<dl><dt><strong>enterable</strong> = False</dl> + +<dl><dt><strong>filenames</strong> = None</dl> + +<dl><dt><strong>files</strong> = None</dl> + +<dl><dt><strong>filter</strong> = None</dl> + +<dl><dt><strong>load_generator</strong> = None</dl> + +<dl><dt><strong>loading</strong> = False</dl> + +<dl><dt><strong>marked_items</strong> = None</dl> + +<dl><dt><strong>old_directories_first</strong> = None</dl> + +<dl><dt><strong>old_reverse</strong> = None</dl> + +<dl><dt><strong>old_show_hidden</strong> = None</dl> + +<dl><dt><strong>old_sort</strong> = None</dl> + +<dl><dt><strong>scroll_begin</strong> = 0</dl> + +<dl><dt><strong>scroll_offset</strong> = 0</dl> + +<dl><dt><strong>sort_dict</strong> = {'basename': <function sort_by_basename at 0x154a408>, 'mtime': <function <lambda> at 0x1569518>, 'size': <function <lambda> at 0x1569490>, 'type': <function <lambda> at 0x15695a0>}</dl> + +<hr> +Methods inherited from <a href="ranger.fsobject.fsobject.html#FileSystemObject">ranger.fsobject.fsobject.FileSystemObject</a>:<br> +<dl><dt><a name="Directory-__str__"><strong>__str__</strong></a>(self)</dt><dd><tt>returns a string containing the absolute path</tt></dd></dl> + +<dl><dt><a name="Directory-get_description"><strong>get_description</strong></a>(self)</dt></dl> + +<dl><dt><a name="Directory-get_permission_string"><strong>get_permission_string</strong></a>(self)</dt></dl> + +<dl><dt><a name="Directory-go"><strong>go</strong></a>(self)</dt><dd><tt>enter the directory if the filemanager is running</tt></dd></dl> + +<dl><dt><a name="Directory-is_older_than"><strong>is_older_than</strong></a>(self, seconds)</dt><dd><tt>returns whether this object wasn't <a href="#Directory-use">use</a>()d in the last n seconds</tt></dd></dl> + +<dl><dt><a name="Directory-load"><strong>load</strong></a>(self)</dt><dd><tt>reads useful information about the filesystem-object from the<br> +filesystem and caches it for later use</tt></dd></dl> + +<dl><dt><a name="Directory-load_if_outdated"><strong>load_if_outdated</strong></a>(self)</dt><dd><tt>Calls <a href="#Directory-load">load</a>() if the currently cached information is outdated<br> +or nonexistant.</tt></dd></dl> + +<dl><dt><a name="Directory-load_once"><strong>load_once</strong></a>(self)</dt><dd><tt>calls <a href="#Directory-load">load</a>() if it has not been called at least once yet</tt></dd></dl> + +<dl><dt><a name="Directory-mark"><strong>mark</strong></a>(self, boolean)</dt></dl> + +<dl><dt><a name="Directory-set_mimetype"><strong>set_mimetype</strong></a>(self)</dt><dd><tt>assign attributes such as self.<strong>video</strong> according to the mimetype</tt></dd></dl> + +<dl><dt><a name="Directory-use"><strong>use</strong></a>(self)</dt><dd><tt>mark the filesystem-object as used at the current time</tt></dd></dl> + +<hr> +Data and other attributes inherited from <a href="ranger.fsobject.fsobject.html#FileSystemObject">ranger.fsobject.fsobject.FileSystemObject</a>:<br> +<dl><dt><strong>accessible</strong> = False</dl> + +<dl><dt><strong>audio</strong> = False</dl> + +<dl><dt><strong>basename</strong> = None</dl> + +<dl><dt><strong>basename_lower</strong> = None</dl> + +<dl><dt><strong>container</strong> = False</dl> + +<dl><dt><strong>content_loaded</strong> = False</dl> + +<dl><dt><strong>dirname</strong> = None</dl> + +<dl><dt><strong>document</strong> = False</dl> + +<dl><dt><strong>exists</strong> = False</dl> + +<dl><dt><strong>extension</strong> = None</dl> + +<dl><dt><strong>force_load</strong> = False</dl> + +<dl><dt><strong>image</strong> = False</dl> + +<dl><dt><strong>infostring</strong> = None</dl> + +<dl><dt><strong>islink</strong> = False</dl> + +<dl><dt><strong>last_used</strong> = None</dl> + +<dl><dt><strong>loaded</strong> = False</dl> + +<dl><dt><strong>marked</strong> = False</dl> + +<dl><dt><strong>media</strong> = False</dl> + +<dl><dt><strong>mimetype_tuple</strong> = ()</dl> + +<dl><dt><strong>path</strong> = None</dl> + +<dl><dt><strong>permissions</strong> = None</dl> + +<dl><dt><strong>readlink</strong> = None</dl> + +<dl><dt><strong>runnable</strong> = False</dl> + +<dl><dt><strong>size</strong> = 0</dl> + +<dl><dt><strong>stat</strong> = None</dl> + +<dl><dt><strong>stopped</strong> = False</dl> + +<dl><dt><strong>tagged</strong> = False</dl> + +<dl><dt><strong>type</strong> = 'unknown'</dl> + +<dl><dt><strong>video</strong> = False</dl> + +<hr> +Data descriptors inherited from <a href="ranger.shared.mimetype.html#MimeTypeAware">ranger.shared.mimetype.MimeTypeAware</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.mimetype.html#MimeTypeAware">ranger.shared.mimetype.MimeTypeAware</a>:<br> +<dl><dt><strong>mimetypes</strong> = {}</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> +Methods inherited from <a href="ranger.ext.accumulator.html#Accumulator">ranger.ext.accumulator.Accumulator</a>:<br> +<dl><dt><a name="Directory-move"><strong>move</strong></a>(self, relative<font color="#909090">=0</font>, absolute<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="Directory-pointer_is_synced"><strong>pointer_is_synced</strong></a>(self)</dt></dl> + +<dl><dt><a name="Directory-sync_index"><strong>sync_index</strong></a>(self, **kw)</dt></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> <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="NoDirectoryGiven">class <strong>NoDirectoryGiven</strong></a>(<a href="builtins.html#Exception">builtins.Exception</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.fsobject.directory.html#NoDirectoryGiven">NoDirectoryGiven</a></dd> +<dd><a href="builtins.html#Exception">builtins.Exception</a></dd> +<dd><a href="builtins.html#BaseException">builtins.BaseException</a></dd> +<dd><a href="builtins.html#object">builtins.object</a></dd> +</dl> +<hr> +Data descriptors defined here:<br> +<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#Exception">builtins.Exception</a>:<br> +<dl><dt><a name="NoDirectoryGiven-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#NoDirectoryGiven-__init__">__init__</a>(...) initializes x; see x.__class__.__doc__ for signature</tt></dd></dl> + +<hr> +Data and other attributes inherited from <a href="builtins.html#Exception">builtins.Exception</a>:<br> +<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object at 0x7f327d94a120><dd><tt>T.<a href="#NoDirectoryGiven-__new__">__new__</a>(S, ...) -> a new object with type S, a subtype of T</tt></dl> + +<hr> +Methods inherited from <a href="builtins.html#BaseException">builtins.BaseException</a>:<br> +<dl><dt><a name="NoDirectoryGiven-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#NoDirectoryGiven-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> + +<dl><dt><a name="NoDirectoryGiven-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#NoDirectoryGiven-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> + +<dl><dt><a name="NoDirectoryGiven-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> + +<dl><dt><a name="NoDirectoryGiven-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#NoDirectoryGiven-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> + +<dl><dt><a name="NoDirectoryGiven-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#NoDirectoryGiven-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> + +<dl><dt><a name="NoDirectoryGiven-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> + +<dl><dt><a name="NoDirectoryGiven-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#NoDirectoryGiven-__str__">__str__</a>() <==> str(x)</tt></dd></dl> + +<dl><dt><a name="NoDirectoryGiven-with_traceback"><strong>with_traceback</strong></a>(...)</dt><dd><tt><a href="builtins.html#Exception">Exception</a>.<a href="#NoDirectoryGiven-with_traceback">with_traceback</a>(tb) --<br> +set self.<strong>__traceback__</strong> to tb and return self.</tt></dd></dl> + +<hr> +Data descriptors inherited from <a href="builtins.html#BaseException">builtins.BaseException</a>:<br> +<dl><dt><strong>__cause__</strong></dt> +<dd><tt>exception cause</tt></dd> +</dl> +<dl><dt><strong>__context__</strong></dt> +<dd><tt>exception context</tt></dd> +</dl> +<dl><dt><strong>__dict__</strong></dt> +</dl> +<dl><dt><strong>__traceback__</strong></dt> +</dl> +<dl><dt><strong>args</strong></dt> +</dl> +</td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#eeaa77"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> + +<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt><a name="-sort_by_basename"><strong>sort_by_basename</strong></a>(path)</dt><dd><tt>returns path.basename (for sorting)</tt></dd></dl> + <dl><dt><a name="-sort_by_directory"><strong>sort_by_directory</strong></a>(path)</dt><dd><tt>returns 0 if path is a directory, otherwise 1 (for sorting)</tt></dd></dl> +</td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#55aa55"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> + +<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> +<td width="100%"><strong>BAD_INFO</strong> = None</td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/ranger.fsobject.file.html b/doc/ranger.fsobject.file.html new file mode 100644 index 00000000..b2929879 --- /dev/null +++ b/doc/ranger.fsobject.file.html @@ -0,0 +1,148 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module ranger.fsobject.file</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.fsobject.html"><font color="#ffffff">fsobject</font></a>.file</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/fsobject/file.py">/home/hut/work/ranger/ranger/fsobject/file.py</a></font></td></tr></table> + <p></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.fsobject.fsobject.html#FileSystemObject">ranger.fsobject.fsobject.FileSystemObject</a>(<a href="ranger.shared.mimetype.html#MimeTypeAware">ranger.shared.mimetype.MimeTypeAware</a>, <a href="ranger.shared.html#FileManagerAware">ranger.shared.FileManagerAware</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="ranger.fsobject.file.html#File">File</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="File">class <strong>File</strong></a>(<a href="ranger.fsobject.fsobject.html#FileSystemObject">ranger.fsobject.fsobject.FileSystemObject</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.fsobject.file.html#File">File</a></dd> +<dd><a href="ranger.fsobject.fsobject.html#FileSystemObject">ranger.fsobject.fsobject.FileSystemObject</a></dd> +<dd><a href="ranger.shared.mimetype.html#MimeTypeAware">ranger.shared.mimetype.MimeTypeAware</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="builtins.html#object">builtins.object</a></dd> +</dl> +<hr> +Methods inherited from <a href="ranger.fsobject.fsobject.html#FileSystemObject">ranger.fsobject.fsobject.FileSystemObject</a>:<br> +<dl><dt><a name="File-__init__"><strong>__init__</strong></a>(self, path)</dt></dl> + +<dl><dt><a name="File-__str__"><strong>__str__</strong></a>(self)</dt><dd><tt>returns a string containing the absolute path</tt></dd></dl> + +<dl><dt><a name="File-get_description"><strong>get_description</strong></a>(self)</dt></dl> + +<dl><dt><a name="File-get_permission_string"><strong>get_permission_string</strong></a>(self)</dt></dl> + +<dl><dt><a name="File-go"><strong>go</strong></a>(self)</dt><dd><tt>enter the directory if the filemanager is running</tt></dd></dl> + +<dl><dt><a name="File-is_older_than"><strong>is_older_than</strong></a>(self, seconds)</dt><dd><tt>returns whether this object wasn't <a href="#File-use">use</a>()d in the last n seconds</tt></dd></dl> + +<dl><dt><a name="File-load"><strong>load</strong></a>(self)</dt><dd><tt>reads useful information about the filesystem-object from the<br> +filesystem and caches it for later use</tt></dd></dl> + +<dl><dt><a name="File-load_if_outdated"><strong>load_if_outdated</strong></a>(self)</dt><dd><tt>Calls <a href="#File-load">load</a>() if the currently cached information is outdated<br> +or nonexistant.</tt></dd></dl> + +<dl><dt><a name="File-load_once"><strong>load_once</strong></a>(self)</dt><dd><tt>calls <a href="#File-load">load</a>() if it has not been called at least once yet</tt></dd></dl> + +<dl><dt><a name="File-mark"><strong>mark</strong></a>(self, boolean)</dt></dl> + +<dl><dt><a name="File-set_mimetype"><strong>set_mimetype</strong></a>(self)</dt><dd><tt>assign attributes such as self.<strong>video</strong> according to the mimetype</tt></dd></dl> + +<dl><dt><a name="File-use"><strong>use</strong></a>(self)</dt><dd><tt>mark the filesystem-object as used at the current time</tt></dd></dl> + +<hr> +Data and other attributes inherited from <a href="ranger.fsobject.fsobject.html#FileSystemObject">ranger.fsobject.fsobject.FileSystemObject</a>:<br> +<dl><dt><strong>accessible</strong> = False</dl> + +<dl><dt><strong>audio</strong> = False</dl> + +<dl><dt><strong>basename</strong> = None</dl> + +<dl><dt><strong>basename_lower</strong> = None</dl> + +<dl><dt><strong>container</strong> = False</dl> + +<dl><dt><strong>content_loaded</strong> = False</dl> + +<dl><dt><strong>dirname</strong> = None</dl> + +<dl><dt><strong>document</strong> = False</dl> + +<dl><dt><strong>exists</strong> = False</dl> + +<dl><dt><strong>extension</strong> = None</dl> + +<dl><dt><strong>force_load</strong> = False</dl> + +<dl><dt><strong>image</strong> = False</dl> + +<dl><dt><strong>infostring</strong> = None</dl> + +<dl><dt><strong>islink</strong> = False</dl> + +<dl><dt><strong>last_used</strong> = None</dl> + +<dl><dt><strong>loaded</strong> = False</dl> + +<dl><dt><strong>marked</strong> = False</dl> + +<dl><dt><strong>media</strong> = False</dl> + +<dl><dt><strong>mimetype_tuple</strong> = ()</dl> + +<dl><dt><strong>path</strong> = None</dl> + +<dl><dt><strong>permissions</strong> = None</dl> + +<dl><dt><strong>readlink</strong> = None</dl> + +<dl><dt><strong>runnable</strong> = False</dl> + +<dl><dt><strong>size</strong> = 0</dl> + +<dl><dt><strong>stat</strong> = None</dl> + +<dl><dt><strong>stopped</strong> = False</dl> + +<dl><dt><strong>tagged</strong> = False</dl> + +<dl><dt><strong>type</strong> = 'unknown'</dl> + +<dl><dt><strong>video</strong> = False</dl> + +<hr> +Data descriptors inherited from <a href="ranger.shared.mimetype.html#MimeTypeAware">ranger.shared.mimetype.MimeTypeAware</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.mimetype.html#MimeTypeAware">ranger.shared.mimetype.MimeTypeAware</a>:<br> +<dl><dt><strong>mimetypes</strong> = {}</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> + +</td></tr></table></td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/ranger.fsobject.fsobject.html b/doc/ranger.fsobject.fsobject.html new file mode 100644 index 00000000..ecdf11f8 --- /dev/null +++ b/doc/ranger.fsobject.fsobject.html @@ -0,0 +1,167 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module ranger.fsobject.fsobject</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.fsobject.html"><font color="#ffffff">fsobject</font></a>.fsobject</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/fsobject/fsobject.py">/home/hut/work/ranger/ranger/fsobject/fsobject.py</a></font></td></tr></table> + <p></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.shared.html#FileManagerAware">ranger.shared.FileManagerAware</a>(<a href="ranger.shared.html#Awareness">ranger.shared.Awareness</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="ranger.fsobject.fsobject.html#FileSystemObject">FileSystemObject</a>(<a href="ranger.shared.mimetype.html#MimeTypeAware">ranger.shared.mimetype.MimeTypeAware</a>, <a href="ranger.shared.html#FileManagerAware">ranger.shared.FileManagerAware</a>) +</font></dt></dl> +</dd> +<dt><font face="helvetica, arial"><a href="ranger.shared.mimetype.html#MimeTypeAware">ranger.shared.mimetype.MimeTypeAware</a>(<a href="builtins.html#object">builtins.object</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="ranger.fsobject.fsobject.html#FileSystemObject">FileSystemObject</a>(<a href="ranger.shared.mimetype.html#MimeTypeAware">ranger.shared.mimetype.MimeTypeAware</a>, <a href="ranger.shared.html#FileManagerAware">ranger.shared.FileManagerAware</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="FileSystemObject">class <strong>FileSystemObject</strong></a>(<a href="ranger.shared.mimetype.html#MimeTypeAware">ranger.shared.mimetype.MimeTypeAware</a>, <a href="ranger.shared.html#FileManagerAware">ranger.shared.FileManagerAware</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.fsobject.fsobject.html#FileSystemObject">FileSystemObject</a></dd> +<dd><a href="ranger.shared.mimetype.html#MimeTypeAware">ranger.shared.mimetype.MimeTypeAware</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="builtins.html#object">builtins.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="FileSystemObject-__init__"><strong>__init__</strong></a>(self, path)</dt></dl> + +<dl><dt><a name="FileSystemObject-__str__"><strong>__str__</strong></a>(self)</dt><dd><tt>returns a string containing the absolute path</tt></dd></dl> + +<dl><dt><a name="FileSystemObject-get_description"><strong>get_description</strong></a>(self)</dt></dl> + +<dl><dt><a name="FileSystemObject-get_permission_string"><strong>get_permission_string</strong></a>(self)</dt></dl> + +<dl><dt><a name="FileSystemObject-go"><strong>go</strong></a>(self)</dt><dd><tt>enter the directory if the filemanager is running</tt></dd></dl> + +<dl><dt><a name="FileSystemObject-is_older_than"><strong>is_older_than</strong></a>(self, seconds)</dt><dd><tt>returns whether this object wasn't <a href="#FileSystemObject-use">use</a>()d in the last n seconds</tt></dd></dl> + +<dl><dt><a name="FileSystemObject-load"><strong>load</strong></a>(self)</dt><dd><tt>reads useful information about the filesystem-object from the<br> +filesystem and caches it for later use</tt></dd></dl> + +<dl><dt><a name="FileSystemObject-load_if_outdated"><strong>load_if_outdated</strong></a>(self)</dt><dd><tt>Calls <a href="#FileSystemObject-load">load</a>() if the currently cached information is outdated<br> +or nonexistant.</tt></dd></dl> + +<dl><dt><a name="FileSystemObject-load_once"><strong>load_once</strong></a>(self)</dt><dd><tt>calls <a href="#FileSystemObject-load">load</a>() if it has not been called at least once yet</tt></dd></dl> + +<dl><dt><a name="FileSystemObject-mark"><strong>mark</strong></a>(self, boolean)</dt></dl> + +<dl><dt><a name="FileSystemObject-set_mimetype"><strong>set_mimetype</strong></a>(self)</dt><dd><tt>assign attributes such as self.<strong>video</strong> according to the mimetype</tt></dd></dl> + +<dl><dt><a name="FileSystemObject-use"><strong>use</strong></a>(self)</dt><dd><tt>mark the filesystem-object as used at the current time</tt></dd></dl> + +<hr> +Data and other attributes defined here:<br> +<dl><dt><strong>accessible</strong> = False</dl> + +<dl><dt><strong>audio</strong> = False</dl> + +<dl><dt><strong>basename</strong> = None</dl> + +<dl><dt><strong>basename_lower</strong> = None</dl> + +<dl><dt><strong>container</strong> = False</dl> + +<dl><dt><strong>content_loaded</strong> = False</dl> + +<dl><dt><strong>dirname</strong> = None</dl> + +<dl><dt><strong>document</strong> = False</dl> + +<dl><dt><strong>exists</strong> = False</dl> + +<dl><dt><strong>extension</strong> = None</dl> + +<dl><dt><strong>force_load</strong> = False</dl> + +<dl><dt><strong>image</strong> = False</dl> + +<dl><dt><strong>infostring</strong> = None</dl> + +<dl><dt><strong>islink</strong> = False</dl> + +<dl><dt><strong>last_used</strong> = None</dl> + +<dl><dt><strong>loaded</strong> = False</dl> + +<dl><dt><strong>marked</strong> = False</dl> + +<dl><dt><strong>media</strong> = False</dl> + +<dl><dt><strong>mimetype_tuple</strong> = ()</dl> + +<dl><dt><strong>path</strong> = None</dl> + +<dl><dt><strong>permissions</strong> = None</dl> + +<dl><dt><strong>readlink</strong> = None</dl> + +<dl><dt><strong>runnable</strong> = False</dl> + +<dl><dt><strong>size</strong> = 0</dl> + +<dl><dt><strong>stat</strong> = None</dl> + +<dl><dt><strong>stopped</strong> = False</dl> + +<dl><dt><strong>tagged</strong> = False</dl> + +<dl><dt><strong>type</strong> = 'unknown'</dl> + +<dl><dt><strong>video</strong> = False</dl> + +<hr> +Data descriptors inherited from <a href="ranger.shared.mimetype.html#MimeTypeAware">ranger.shared.mimetype.MimeTypeAware</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.mimetype.html#MimeTypeAware">ranger.shared.mimetype.MimeTypeAware</a>:<br> +<dl><dt><strong>mimetypes</strong> = {}</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> + +</td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#55aa55"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> + +<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> +<td width="100%"><strong>BAD_INFO</strong> = None<br> +<strong>CONTAINER_EXTENSIONS</strong> = ['rar', 'zip', 'tar', 'gz', 'bz', 'bz2', 'tgz', '7z', 'iso', 'cab']<br> +<strong>DOCUMENT_BASENAMES</strong> = ['README', 'TODO', 'LICENSE']<br> +<strong>DOCUMENT_EXTENSIONS</strong> = ['pdf', 'doc', 'ppt', 'odt']<br> +<strong>T_DIRECTORY</strong> = 'directory'<br> +<strong>T_FILE</strong> = 'file'<br> +<strong>T_NONEXISTANT</strong> = 'nonexistant'<br> +<strong>T_UNKNOWN</strong> = 'unknown'</td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/ranger.fsobject.html b/doc/ranger.fsobject.html new file mode 100644 index 00000000..fff54d0c --- /dev/null +++ b/doc/ranger.fsobject.html @@ -0,0 +1,111 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: package ranger.fsobject</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>.fsobject</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/fsobject/__init__.py">/home/hut/work/ranger/ranger/fsobject/__init__.py</a></font></td></tr></table> + <p><tt>FileSystemObjects are representation of files and directories<br> +with fast access to their properties through caching</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<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.fsobject.directory.html">directory</a><br> +</td><td width="25%" valign=top><a href="ranger.fsobject.file.html">file</a><br> +</td><td width="25%" valign=top><a href="ranger.fsobject.fsobject.html">fsobject</a><br> +</td><td width="25%" valign=top><a href="ranger.fsobject.loader.html">loader</a><br> +</td></tr></table></td></tr></table><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="builtins.html#Exception">builtins.Exception</a>(<a href="builtins.html#BaseException">builtins.BaseException</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="ranger.fsobject.html#NotLoadedYet">NotLoadedYet</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="NotLoadedYet">class <strong>NotLoadedYet</strong></a>(<a href="builtins.html#Exception">builtins.Exception</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.fsobject.html#NotLoadedYet">NotLoadedYet</a></dd> +<dd><a href="builtins.html#Exception">builtins.Exception</a></dd> +<dd><a href="builtins.html#BaseException">builtins.BaseException</a></dd> +<dd><a href="builtins.html#object">builtins.object</a></dd> +</dl> +<hr> +Data descriptors defined here:<br> +<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#Exception">builtins.Exception</a>:<br> +<dl><dt><a name="NotLoadedYet-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#NotLoadedYet-__init__">__init__</a>(...) initializes x; see x.__class__.__doc__ for signature</tt></dd></dl> + +<hr> +Data and other attributes inherited from <a href="builtins.html#Exception">builtins.Exception</a>:<br> +<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object at 0x7f327d94a120><dd><tt>T.<a href="#NotLoadedYet-__new__">__new__</a>(S, ...) -> a new object with type S, a subtype of T</tt></dl> + +<hr> +Methods inherited from <a href="builtins.html#BaseException">builtins.BaseException</a>:<br> +<dl><dt><a name="NotLoadedYet-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#NotLoadedYet-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> + +<dl><dt><a name="NotLoadedYet-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#NotLoadedYet-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> + +<dl><dt><a name="NotLoadedYet-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> + +<dl><dt><a name="NotLoadedYet-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#NotLoadedYet-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> + +<dl><dt><a name="NotLoadedYet-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#NotLoadedYet-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> + +<dl><dt><a name="NotLoadedYet-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> + +<dl><dt><a name="NotLoadedYet-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#NotLoadedYet-__str__">__str__</a>() <==> str(x)</tt></dd></dl> + +<dl><dt><a name="NotLoadedYet-with_traceback"><strong>with_traceback</strong></a>(...)</dt><dd><tt><a href="builtins.html#Exception">Exception</a>.<a href="#NotLoadedYet-with_traceback">with_traceback</a>(tb) --<br> +set self.<strong>__traceback__</strong> to tb and return self.</tt></dd></dl> + +<hr> +Data descriptors inherited from <a href="builtins.html#BaseException">builtins.BaseException</a>:<br> +<dl><dt><strong>__cause__</strong></dt> +<dd><tt>exception cause</tt></dd> +</dl> +<dl><dt><strong>__context__</strong></dt> +<dd><tt>exception context</tt></dd> +</dl> +<dl><dt><strong>__dict__</strong></dt> +</dl> +<dl><dt><strong>__traceback__</strong></dt> +</dl> +<dl><dt><strong>args</strong></dt> +</dl> +</td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#55aa55"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> + +<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> +<td width="100%"><strong>BAD_INFO</strong> = None<br> +<strong>T_DIRECTORY</strong> = 'directory'<br> +<strong>T_FILE</strong> = 'file'<br> +<strong>T_NONEXISTANT</strong> = 'nonexistant'<br> +<strong>T_UNKNOWN</strong> = 'unknown'</td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/ranger.fsobject.loader.html b/doc/ranger.fsobject.loader.html new file mode 100644 index 00000000..2e2cc099 --- /dev/null +++ b/doc/ranger.fsobject.loader.html @@ -0,0 +1,122 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module ranger.fsobject.loader</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.fsobject.html"><font color="#ffffff">fsobject</font></a>.loader</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/fsobject/loader.py">/home/hut/work/ranger/ranger/fsobject/loader.py</a></font></td></tr></table> + <p></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</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="math.html">math</a><br> +</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><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="builtins.html#object">builtins.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="ranger.fsobject.loader.html#LoadableObject">LoadableObject</a> +</font></dt></dl> +</dd> +<dt><font face="helvetica, arial"><a href="ranger.shared.html#FileManagerAware">ranger.shared.FileManagerAware</a>(<a href="ranger.shared.html#Awareness">ranger.shared.Awareness</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="ranger.fsobject.loader.html#Loader">Loader</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="LoadableObject">class <strong>LoadableObject</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="LoadableObject-__init__"><strong>__init__</strong></a>(self, gen, descr)</dt></dl> + +<dl><dt><a name="LoadableObject-get_description"><strong>get_description</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> +</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="Loader">class <strong>Loader</strong></a>(<a href="ranger.shared.html#FileManagerAware">ranger.shared.FileManagerAware</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.fsobject.loader.html#Loader">Loader</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="builtins.html#object">builtins.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="Loader-__init__"><strong>__init__</strong></a>(self)</dt></dl> + +<dl><dt><a name="Loader-add"><strong>add</strong></a>(self, obj)</dt><dd><tt>Add an <a href="builtins.html#object">object</a> to the queue.<br> +It should have a load_generator method.</tt></dd></dl> + +<dl><dt><a name="Loader-has_work"><strong>has_work</strong></a>(self)</dt><dd><tt>Is there anything to load?</tt></dd></dl> + +<dl><dt><a name="Loader-move"><strong>move</strong></a>(self, _from, to)</dt></dl> + +<dl><dt><a name="Loader-remove"><strong>remove</strong></a>(self, item<font color="#909090">=None</font>, index<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="Loader-rotate"><strong>rotate</strong></a>(self)</dt><dd><tt>Rotate the throbber</tt></dd></dl> + +<dl><dt><a name="Loader-work"><strong>work</strong></a>(self)</dt><dd><tt>Load items from the queue if there are any.<br> +Stop after approximately self.<strong>seconds_of_work_time</strong>.</tt></dd></dl> + +<hr> +Data and other attributes defined here:<br> +<dl><dt><strong>seconds_of_work_time</strong> = 0.05</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> +</td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#eeaa77"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> + +<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt><a name="-status_generator"><strong>status_generator</strong></a>()</dt><dd><tt>Generate a rotating line which can be used as a throbber</tt></dd></dl> + <dl><dt><a name="-time"><strong>time</strong></a>(...)</dt><dd><tt><a href="#-time">time</a>() -> floating point number<br> + <br> +Return the current time in seconds since the Epoch.<br> +Fractions of a second may be present if the system clock provides them.</tt></dd></dl> +</td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/ranger.gui.color.html b/doc/ranger.gui.color.html new file mode 100644 index 00000000..a1e48be3 --- /dev/null +++ b/doc/ranger.gui.color.html @@ -0,0 +1,52 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module ranger.gui.color</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>.color</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/color.py">/home/hut/work/ranger/ranger/gui/color.py</a></font></td></tr></table> + <p><tt>Contains abbreviations to curses' color/attribute constants.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</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="curses.html">curses</a><br> +</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#eeaa77"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> + +<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt><a name="-get_color"><strong>get_color</strong></a>(fg, bg)</dt><dd><tt>Returns the color pair for the given fg/bg combination.</tt></dd></dl> +</td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#55aa55"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> + +<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> +<td width="100%"><strong>COLOR_PAIRS</strong> = {10: 0}<br> +<strong>black</strong> = 0<br> +<strong>blue</strong> = 4<br> +<strong>bold</strong> = 2097152<br> +<strong>cyan</strong> = 6<br> +<strong>default</strong> = -1<br> +<strong>default_colors</strong> = (-1, -1, 0)<br> +<strong>green</strong> = 2<br> +<strong>invisible</strong> = 8388608<br> +<strong>magenta</strong> = 5<br> +<strong>normal</strong> = 0<br> +<strong>red</strong> = 1<br> +<strong>reverse</strong> = 262144<br> +<strong>underline</strong> = 131072<br> +<strong>white</strong> = 7<br> +<strong>yellow</strong> = 3</td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/ranger.gui.colorscheme.html b/doc/ranger.gui.colorscheme.html new file mode 100644 index 00000000..dd12acae --- /dev/null +++ b/doc/ranger.gui.colorscheme.html @@ -0,0 +1,62 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module ranger.gui.colorscheme</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>.colorscheme</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/colorscheme.py">/home/hut/work/ranger/ranger/gui/colorscheme.py</a></font></td></tr></table> + <p></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="builtins.html#object">builtins.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="ranger.gui.colorscheme.html#ColorScheme">ColorScheme</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="ColorScheme">class <strong>ColorScheme</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="ColorScheme-__init__"><strong>__init__</strong></a>(self)</dt></dl> + +<dl><dt><a name="ColorScheme-get"><strong>get</strong></a>(self, *keys)</dt><dd><tt>Determine the (fg, bg, attr) tuple or get it from cache</tt></dd></dl> + +<dl><dt><a name="ColorScheme-get_attr"><strong>get_attr</strong></a>(self, *keys)</dt><dd><tt>Returns the curses attr integer for the specified keys</tt></dd></dl> + +<dl><dt><a name="ColorScheme-use"><strong>use</strong></a>(self, context)</dt><dd><tt>Use the colorscheme to determine the (fg, bg, attr) tuple.<br> +This is a dummy function which always returns default_colors.<br> +Override this in your custom colorscheme!</tt></dd></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> +</td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#55aa55"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> + +<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> +<td width="100%"><strong>CONTEXT_KEYS</strong> = ['reset', 'error', 'in_display', 'in_statusbar', 'in_titlebar', 'in_console', 'in_notify', 'in_pman', 'directory', 'file', 'hostname', 'executable', 'media', 'link', 'video', 'audio', 'image', 'media', 'document', 'container', ...]</td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/ranger.gui.defaultui.html b/doc/ranger.gui.defaultui.html new file mode 100644 index 00000000..4d80acac --- /dev/null +++ b/doc/ranger.gui.defaultui.html @@ -0,0 +1,173 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module ranger.gui.defaultui</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>.defaultui</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/defaultui.py">/home/hut/work/ranger/ranger/gui/defaultui.py</a></font></td></tr></table> + <p></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.ui.html#UI">ranger.gui.ui.UI</a>(<a href="ranger.gui.displayable.html#DisplayableContainer">ranger.gui.displayable.DisplayableContainer</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="ranger.gui.defaultui.html#DefaultUI">DefaultUI</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="DefaultUI">class <strong>DefaultUI</strong></a>(<a href="ranger.gui.ui.html#UI">ranger.gui.ui.UI</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.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.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="DefaultUI-close_console"><strong>close_console</strong></a>(self)</dt></dl> + +<dl><dt><a name="DefaultUI-close_pman"><strong>close_pman</strong></a>(self)</dt></dl> + +<dl><dt><a name="DefaultUI-display"><strong>display</strong></a>(self, *a, **k)</dt></dl> + +<dl><dt><a name="DefaultUI-hint"><strong>hint</strong></a>(self, text<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="DefaultUI-open_console"><strong>open_console</strong></a>(self, mode, string<font color="#909090">=''</font>)</dt></dl> + +<dl><dt><a name="DefaultUI-open_pman"><strong>open_pman</strong></a>(self)</dt></dl> + +<dl><dt><a name="DefaultUI-poke"><strong>poke</strong></a>(self)</dt></dl> + +<dl><dt><a name="DefaultUI-scroll"><strong>scroll</strong></a>(self, relative)</dt></dl> + +<dl><dt><a name="DefaultUI-setup"><strong>setup</strong></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"><strong>throbber</strong></a>(self, string<font color="#909090">='.'</font>, remove<font color="#909090">=False</font>)</dt></dl> + +<dl><dt><a name="DefaultUI-update_size"><strong>update_size</strong></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>:<br> +<dl><dt><a name="DefaultUI-__init__"><strong>__init__</strong></a>(self, commandlist<font color="#909090">=None</font>, env<font color="#909090">=None</font>, fm<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="DefaultUI-destroy"><strong>destroy</strong></a>(self)</dt><dd><tt>Destroy all widgets and turn off curses</tt></dd></dl> + +<dl><dt><a name="DefaultUI-draw"><strong>draw</strong></a>(self)</dt><dd><tt>Erase the window, then draw all objects in the container</tt></dd></dl> + +<dl><dt><a name="DefaultUI-finalize"><strong>finalize</strong></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"><strong>get_next_key</strong></a>(self)</dt><dd><tt>Waits for key input and returns the pressed key</tt></dd></dl> + +<dl><dt><a name="DefaultUI-handle_key"><strong>handle_key</strong></a>(self, key)</dt><dd><tt>Handles key input</tt></dd></dl> + +<dl><dt><a name="DefaultUI-handle_mouse"><strong>handle_mouse</strong></a>(self)</dt><dd><tt>Handles mouse input</tt></dd></dl> + +<dl><dt><a name="DefaultUI-initialize"><strong>initialize</strong></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"><strong>redraw</strong></a>(self)</dt><dd><tt>Redraw all widgets</tt></dd></dl> + +<dl><dt><a name="DefaultUI-redraw_window"><strong>redraw_window</strong></a>(self)</dt><dd><tt>Redraw the window. This only calls self.<strong>win</strong>.redrawwin().</tt></dd></dl> + +<dl><dt><a name="DefaultUI-set_load_mode"><strong>set_load_mode</strong></a>(self, boolean)</dt></dl> + +<dl><dt><a name="DefaultUI-suspend"><strong>suspend</strong></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>:<br> +<dl><dt><strong>is_set_up</strong> = False</dl> + +<dl><dt><strong>load_mode</strong> = False</dl> + +<dl><dt><strong>mousemask</strong> = 268435455</dl> + +<hr> +Methods inherited from <a href="ranger.gui.displayable.html#DisplayableContainer">ranger.gui.displayable.DisplayableContainer</a>:<br> +<dl><dt><a name="DefaultUI-add_obj"><strong>add_obj</strong></a>(self, *objs)</dt></dl> + +<dl><dt><a name="DefaultUI-click"><strong>click</strong></a>(self, event)</dt><dd><tt>Recursively called on objects in container</tt></dd></dl> + +<dl><dt><a name="DefaultUI-get_focused_obj"><strong>get_focused_obj</strong></a>(self)</dt><dd><tt>Finds a focused displayable object in the container.</tt></dd></dl> + +<dl><dt><a name="DefaultUI-press"><strong>press</strong></a>(self, key)</dt><dd><tt>Recursively called on objects in container</tt></dd></dl> + +<hr> +Data and other attributes inherited from <a href="ranger.gui.displayable.html#DisplayableContainer">ranger.gui.displayable.DisplayableContainer</a>:<br> +<dl><dt><strong>container</strong> = None</dl> + +<hr> +Methods inherited from <a href="ranger.gui.displayable.html#Displayable">ranger.gui.displayable.Displayable</a>:<br> +<dl><dt><a name="DefaultUI-__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="DefaultUI-__nonzero__"><strong>__nonzero__</strong></a>(self)</dt><dd><tt>Always True</tt></dd></dl> + +<dl><dt><a name="DefaultUI-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="DefaultUI-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="DefaultUI-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="DefaultUI-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="DefaultUI-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><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#55aa55"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> + +<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> +<td width="100%"><strong>RATIO</strong> = (3, 3, 12, 9)</td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/ranger.gui.displayable.html b/doc/ranger.gui.displayable.html new file mode 100644 index 00000000..a581fbeb --- /dev/null +++ b/doc/ranger.gui.displayable.html @@ -0,0 +1,297 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module ranger.gui.displayable</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>.displayable</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/displayable.py">/home/hut/work/ranger/ranger/gui/displayable.py</a></font></td></tr></table> + <p></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="builtins.html#Exception">builtins.Exception</a>(<a href="builtins.html#BaseException">builtins.BaseException</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="ranger.gui.displayable.html#OutOfBoundsException">OutOfBoundsException</a> +</font></dt></dl> +</dd> +<dt><font face="helvetica, arial"><a href="ranger.shared.html#EnvironmentAware">ranger.shared.EnvironmentAware</a>(<a href="ranger.shared.html#Awareness">ranger.shared.Awareness</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><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.shared.settings.html#SettingsAware">ranger.shared.settings.SettingsAware</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="ranger.gui.displayable.html#DisplayableContainer">DisplayableContainer</a> +</font></dt></dl> +</dd> +</dl> +</dd> +<dt><font face="helvetica, arial"><a href="ranger.shared.html#FileManagerAware">ranger.shared.FileManagerAware</a>(<a href="ranger.shared.html#Awareness">ranger.shared.Awareness</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><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.shared.settings.html#SettingsAware">ranger.shared.settings.SettingsAware</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="ranger.gui.displayable.html#DisplayableContainer">DisplayableContainer</a> +</font></dt></dl> +</dd> +</dl> +</dd> +<dt><font face="helvetica, arial"><a href="ranger.shared.settings.html#SettingsAware">ranger.shared.settings.SettingsAware</a>(<a href="builtins.html#object">builtins.object</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><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.shared.settings.html#SettingsAware">ranger.shared.settings.SettingsAware</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="ranger.gui.displayable.html#DisplayableContainer">DisplayableContainer</a> +</font></dt></dl> +</dd> +</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="Displayable">class <strong>Displayable</strong></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>)</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.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.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="Displayable-__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="Displayable-__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="Displayable-__nonzero__"><strong>__nonzero__</strong></a>(self)</dt><dd><tt>Always True</tt></dd></dl> + +<dl><dt><a name="Displayable-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="Displayable-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="Displayable-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="Displayable-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="Displayable-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="Displayable-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="Displayable-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="Displayable-finalize"><strong>finalize</strong></a>(self)</dt><dd><tt>Called after every displayable is done drawing.<br> +Override this!</tt></dd></dl> + +<dl><dt><a name="Displayable-poke"><strong>poke</strong></a>(self)</dt><dd><tt>Called before drawing, even if invisible</tt></dd></dl> + +<dl><dt><a name="Displayable-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="Displayable-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 defined here:<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> <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="DisplayableContainer">class <strong>DisplayableContainer</strong></a>(<a href="ranger.gui.displayable.html#Displayable">Displayable</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.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.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="DisplayableContainer-__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="DisplayableContainer-add_obj"><strong>add_obj</strong></a>(self, *objs)</dt></dl> + +<dl><dt><a name="DisplayableContainer-click"><strong>click</strong></a>(self, event)</dt><dd><tt>Recursively called on objects in container</tt></dd></dl> + +<dl><dt><a name="DisplayableContainer-destroy"><strong>destroy</strong></a>(self)</dt><dd><tt>Recursively called on objects in container</tt></dd></dl> + +<dl><dt><a name="DisplayableContainer-draw"><strong>draw</strong></a>(self)</dt><dd><tt>Recursively called on visible objects in container</tt></dd></dl> + +<dl><dt><a name="DisplayableContainer-finalize"><strong>finalize</strong></a>(self)</dt><dd><tt>Recursively called on visible objects in container</tt></dd></dl> + +<dl><dt><a name="DisplayableContainer-get_focused_obj"><strong>get_focused_obj</strong></a>(self)</dt><dd><tt>Finds a focused displayable object in the container.</tt></dd></dl> + +<dl><dt><a name="DisplayableContainer-poke"><strong>poke</strong></a>(self)</dt><dd><tt>Recursively called on objects in container</tt></dd></dl> + +<dl><dt><a name="DisplayableContainer-press"><strong>press</strong></a>(self, key)</dt><dd><tt>Recursively called on objects in container</tt></dd></dl> + +<hr> +Data and other attributes defined here:<br> +<dl><dt><strong>container</strong> = None</dl> + +<hr> +Methods inherited from <a href="ranger.gui.displayable.html#Displayable">Displayable</a>:<br> +<dl><dt><a name="DisplayableContainer-__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="DisplayableContainer-__nonzero__"><strong>__nonzero__</strong></a>(self)</dt><dd><tt>Always True</tt></dd></dl> + +<dl><dt><a name="DisplayableContainer-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="DisplayableContainer-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="DisplayableContainer-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="DisplayableContainer-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="DisplayableContainer-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">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> <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="OutOfBoundsException">class <strong>OutOfBoundsException</strong></a>(<a href="builtins.html#Exception">builtins.Exception</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.displayable.html#OutOfBoundsException">OutOfBoundsException</a></dd> +<dd><a href="builtins.html#Exception">builtins.Exception</a></dd> +<dd><a href="builtins.html#BaseException">builtins.BaseException</a></dd> +<dd><a href="builtins.html#object">builtins.object</a></dd> +</dl> +<hr> +Data descriptors defined here:<br> +<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#Exception">builtins.Exception</a>:<br> +<dl><dt><a name="OutOfBoundsException-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#OutOfBoundsException-__init__">__init__</a>(...) initializes x; see x.__class__.__doc__ for signature</tt></dd></dl> + +<hr> +Data and other attributes inherited from <a href="builtins.html#Exception">builtins.Exception</a>:<br> +<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object at 0x7f327d94a120><dd><tt>T.<a href="#OutOfBoundsException-__new__">__new__</a>(S, ...) -> a new object with type S, a subtype of T</tt></dl> + +<hr> +Methods inherited from <a href="builtins.html#BaseException">builtins.BaseException</a>:<br> +<dl><dt><a name="OutOfBoundsException-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#OutOfBoundsException-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> + +<dl><dt><a name="OutOfBoundsException-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#OutOfBoundsException-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> + +<dl><dt><a name="OutOfBoundsException-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> + +<dl><dt><a name="OutOfBoundsException-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#OutOfBoundsException-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> + +<dl><dt><a name="OutOfBoundsException-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#OutOfBoundsException-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> + +<dl><dt><a name="OutOfBoundsException-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> + +<dl><dt><a name="OutOfBoundsException-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#OutOfBoundsException-__str__">__str__</a>() <==> str(x)</tt></dd></dl> + +<dl><dt><a name="OutOfBoundsException-with_traceback"><strong>with_traceback</strong></a>(...)</dt><dd><tt><a href="builtins.html#Exception">Exception</a>.<a href="#OutOfBoundsException-with_traceback">with_traceback</a>(tb) --<br> +set self.<strong>__traceback__</strong> to tb and return self.</tt></dd></dl> + +<hr> +Data descriptors inherited from <a href="builtins.html#BaseException">builtins.BaseException</a>:<br> +<dl><dt><strong>__cause__</strong></dt> +<dd><tt>exception cause</tt></dd> +</dl> +<dl><dt><strong>__context__</strong></dt> +<dd><tt>exception context</tt></dd> +</dl> +<dl><dt><strong>__dict__</strong></dt> +</dl> +<dl><dt><strong>__traceback__</strong></dt> +</dl> +<dl><dt><strong>args</strong></dt> +</dl> +</td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#eeaa77"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> + +<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt><a name="-combine"><strong>combine</strong></a>(seq, tup)</dt><dd><tt>Add seq and tup. Ensures that the result is a tuple.</tt></dd></dl> +</td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/ranger.gui.html b/doc/ranger.gui.html new file mode 100644 index 00000000..58ba2974 --- /dev/null +++ b/doc/ranger.gui.html @@ -0,0 +1,28 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: package ranger.gui</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>.gui</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/__init__.py">/home/hut/work/ranger/ranger/gui/__init__.py</a></font></td></tr></table> + <p></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<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.color.html">color</a><br> +<a href="ranger.gui.colorscheme.html">colorscheme</a><br> +</td><td width="25%" valign=top><a href="ranger.gui.defaultui.html">defaultui</a><br> +<a href="ranger.gui.displayable.html">displayable</a><br> +</td><td width="25%" valign=top><a href="ranger.gui.mouse_event.html">mouse_event</a><br> +<a href="ranger.gui.ui.html">ui</a><br> +</td><td width="25%" valign=top><a href="ranger.gui.widgets.html"><strong>widgets</strong> (package)</a><br> +</td></tr></table></td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/ranger.gui.mouse_event.html b/doc/ranger.gui.mouse_event.html new file mode 100644 index 00000000..80c114e3 --- /dev/null +++ b/doc/ranger.gui.mouse_event.html @@ -0,0 +1,69 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module ranger.gui.mouse_event</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>.mouse_event</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/mouse_event.py">/home/hut/work/ranger/ranger/gui/mouse_event.py</a></font></td></tr></table> + <p></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</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="curses.html">curses</a><br> +</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><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="builtins.html#object">builtins.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="ranger.gui.mouse_event.html#MouseEvent">MouseEvent</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="MouseEvent">class <strong>MouseEvent</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="MouseEvent-__init__"><strong>__init__</strong></a>(self, getmouse)</dt><dd><tt>Creates a <a href="#MouseEvent">MouseEvent</a> <a href="builtins.html#object">object</a> from the result of win.getmouse()</tt></dd></dl> + +<dl><dt><a name="MouseEvent-alt"><strong>alt</strong></a>(self)</dt></dl> + +<dl><dt><a name="MouseEvent-ctrl"><strong>ctrl</strong></a>(self)</dt></dl> + +<dl><dt><a name="MouseEvent-key_invalid"><strong>key_invalid</strong></a>(self)</dt></dl> + +<dl><dt><a name="MouseEvent-pressed"><strong>pressed</strong></a>(self, n)</dt><dd><tt>Returns whether the mouse key n is pressed</tt></dd></dl> + +<dl><dt><a name="MouseEvent-shift"><strong>shift</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>PRESSED</strong> = [0, 2, 128, 8192, 524288]</dl> + +</td></tr></table></td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/ranger.gui.ui.html b/doc/ranger.gui.ui.html new file mode 100644 index 00000000..003a4ffd --- /dev/null +++ b/doc/ranger.gui.ui.html @@ -0,0 +1,157 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module ranger.gui.ui</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>.ui</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/ui.py">/home/hut/work/ranger/ranger/gui/ui.py</a></font></td></tr></table> + <p></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</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="curses.html">curses</a><br> +</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><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.displayable.html#DisplayableContainer">ranger.gui.displayable.DisplayableContainer</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.ui.html#UI">UI</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="UI">class <strong>UI</strong></a>(<a href="ranger.gui.displayable.html#DisplayableContainer">ranger.gui.displayable.DisplayableContainer</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.ui.html#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.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="UI-__init__"><strong>__init__</strong></a>(self, commandlist<font color="#909090">=None</font>, env<font color="#909090">=None</font>, fm<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="UI-destroy"><strong>destroy</strong></a>(self)</dt><dd><tt>Destroy all widgets and turn off curses</tt></dd></dl> + +<dl><dt><a name="UI-draw"><strong>draw</strong></a>(self)</dt><dd><tt>Erase the window, then draw all objects in the container</tt></dd></dl> + +<dl><dt><a name="UI-finalize"><strong>finalize</strong></a>(self)</dt><dd><tt>Finalize every object in container and refresh the window</tt></dd></dl> + +<dl><dt><a name="UI-get_next_key"><strong>get_next_key</strong></a>(self)</dt><dd><tt>Waits for key input and returns the pressed key</tt></dd></dl> + +<dl><dt><a name="UI-handle_key"><strong>handle_key</strong></a>(self, key)</dt><dd><tt>Handles key input</tt></dd></dl> + +<dl><dt><a name="UI-handle_mouse"><strong>handle_mouse</strong></a>(self)</dt><dd><tt>Handles mouse input</tt></dd></dl> + +<dl><dt><a name="UI-initialize"><strong>initialize</strong></a>(self)</dt><dd><tt>initialize curses, then call setup (at the first time) and resize.</tt></dd></dl> + +<dl><dt><a name="UI-redraw"><strong>redraw</strong></a>(self)</dt><dd><tt>Redraw all widgets</tt></dd></dl> + +<dl><dt><a name="UI-redraw_window"><strong>redraw_window</strong></a>(self)</dt><dd><tt>Redraw the window. This only calls self.<strong>win</strong>.redrawwin().</tt></dd></dl> + +<dl><dt><a name="UI-set_load_mode"><strong>set_load_mode</strong></a>(self, boolean)</dt></dl> + +<dl><dt><a name="UI-setup"><strong>setup</strong></a>(self)</dt><dd><tt>Called after an <a href="#UI-initialize">initialize</a>() call.<br> +Override this!</tt></dd></dl> + +<dl><dt><a name="UI-suspend"><strong>suspend</strong></a>(self)</dt><dd><tt>Turn off curses</tt></dd></dl> + +<dl><dt><a name="UI-update_size"><strong>update_size</strong></a>(self)</dt><dd><tt>Update self.<strong>env</strong>.termsize.<br> +Extend this method to resize all widgets!</tt></dd></dl> + +<hr> +Data and other attributes defined here:<br> +<dl><dt><strong>is_set_up</strong> = False</dl> + +<dl><dt><strong>load_mode</strong> = False</dl> + +<dl><dt><strong>mousemask</strong> = 268435455</dl> + +<hr> +Methods inherited from <a href="ranger.gui.displayable.html#DisplayableContainer">ranger.gui.displayable.DisplayableContainer</a>:<br> +<dl><dt><a name="UI-add_obj"><strong>add_obj</strong></a>(self, *objs)</dt></dl> + +<dl><dt><a name="UI-click"><strong>click</strong></a>(self, event)</dt><dd><tt>Recursively called on objects in container</tt></dd></dl> + +<dl><dt><a name="UI-get_focused_obj"><strong>get_focused_obj</strong></a>(self)</dt><dd><tt>Finds a focused displayable object in the container.</tt></dd></dl> + +<dl><dt><a name="UI-poke"><strong>poke</strong></a>(self)</dt><dd><tt>Recursively called on objects in container</tt></dd></dl> + +<dl><dt><a name="UI-press"><strong>press</strong></a>(self, key)</dt><dd><tt>Recursively called on objects in container</tt></dd></dl> + +<hr> +Data and other attributes inherited from <a href="ranger.gui.displayable.html#DisplayableContainer">ranger.gui.displayable.DisplayableContainer</a>:<br> +<dl><dt><strong>container</strong> = None</dl> + +<hr> +Methods inherited from <a href="ranger.gui.displayable.html#Displayable">ranger.gui.displayable.Displayable</a>:<br> +<dl><dt><a name="UI-__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="UI-__nonzero__"><strong>__nonzero__</strong></a>(self)</dt><dd><tt>Always True</tt></dd></dl> + +<dl><dt><a name="UI-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="UI-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="UI-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="UI-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="UI-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 diff --git a/doc/ranger.gui.widgets.console.html b/doc/ranger.gui.widgets.console.html new file mode 100644 index 00000000..a14b7212 --- /dev/null +++ b/doc/ranger.gui.widgets.console.html @@ -0,0 +1,908 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module ranger.gui.widgets.console</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>.console</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/console.py">/home/hut/work/ranger/ranger/gui/widgets/console.py</a></font></td></tr></table> + <p><tt>The <a href="#Console">Console</a> widget implements a vim-like console for entering<br> +commands, searching and executing files.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</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.commands.html">ranger.commands</a><br> +</td><td width="25%" valign=top><a href="curses.html">curses</a><br> +</td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><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.console.html#Console">Console</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="ranger.gui.widgets.console.html#CommandConsole">CommandConsole</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="ranger.gui.widgets.console.html#QuickCommandConsole">QuickCommandConsole</a> +</font></dt></dl> +</dd> +<dt><font face="helvetica, arial"><a href="ranger.gui.widgets.console.html#OpenConsole">OpenConsole</a> +</font></dt><dt><font face="helvetica, arial"><a href="ranger.gui.widgets.console.html#QuickOpenConsole">QuickOpenConsole</a> +</font></dt><dt><font face="helvetica, arial"><a href="ranger.gui.widgets.console.html#SearchConsole">SearchConsole</a> +</font></dt></dl> +</dd> +</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="CommandConsole">class <strong>CommandConsole</strong></a>(<a href="ranger.gui.widgets.console.html#Console">Console</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.console.html#CommandConsole">CommandConsole</a></dd> +<dd><a href="ranger.gui.widgets.console.html#Console">Console</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="CommandConsole-execute"><strong>execute</strong></a>(self)</dt></dl> + +<dl><dt><a name="CommandConsole-tab"><strong>tab</strong></a>(self, n<font color="#909090">=1</font>)</dt></dl> + +<hr> +Data and other attributes defined here:<br> +<dl><dt><strong>prompt</strong> = ':'</dl> + +<hr> +Methods inherited from <a href="ranger.gui.widgets.console.html#Console">Console</a>:<br> +<dl><dt><a name="CommandConsole-__init__"><strong>__init__</strong></a>(self, win)</dt></dl> + +<dl><dt><a name="CommandConsole-add_to_history"><strong>add_to_history</strong></a>(self)</dt></dl> + +<dl><dt><a name="CommandConsole-clear"><strong>clear</strong></a>(self)</dt></dl> + +<dl><dt><a name="CommandConsole-close"><strong>close</strong></a>(self)</dt></dl> + +<dl><dt><a name="CommandConsole-delete"><strong>delete</strong></a>(self, mod)</dt></dl> + +<dl><dt><a name="CommandConsole-delete_rest"><strong>delete_rest</strong></a>(self, direction)</dt></dl> + +<dl><dt><a name="CommandConsole-delete_word"><strong>delete_word</strong></a>(self)</dt></dl> + +<dl><dt><a name="CommandConsole-draw"><strong>draw</strong></a>(self)</dt></dl> + +<dl><dt><a name="CommandConsole-finalize"><strong>finalize</strong></a>(self)</dt></dl> + +<dl><dt><a name="CommandConsole-history_move"><strong>history_move</strong></a>(self, n)</dt></dl> + +<dl><dt><a name="CommandConsole-init"><strong>init</strong></a>(self)</dt><dd><tt>override this. Called directly after class change</tt></dd></dl> + +<dl><dt><a name="CommandConsole-move"><strong>move</strong></a>(self, relative<font color="#909090">=0</font>, absolute<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="CommandConsole-on_line_change"><strong>on_line_change</strong></a>(self)</dt></dl> + +<dl><dt><a name="CommandConsole-open"><strong>open</strong></a>(self, mode, string<font color="#909090">=''</font>)</dt></dl> + +<dl><dt><a name="CommandConsole-paste"><strong>paste</strong></a>(self)</dt></dl> + +<dl><dt><a name="CommandConsole-press"><strong>press</strong></a>(self, key)</dt></dl> + +<dl><dt><a name="CommandConsole-type_key"><strong>type_key</strong></a>(self, key)</dt></dl> + +<hr> +Data and other attributes inherited from <a href="ranger.gui.widgets.console.html#Console">Console</a>:<br> +<dl><dt><strong>commandlist</strong> = None</dl> + +<dl><dt><strong>copy</strong> = ''</dl> + +<dl><dt><strong>histories</strong> = None</dl> + +<dl><dt><strong>history</strong> = None</dl> + +<dl><dt><strong>last_cursor_mode</strong> = 1</dl> + +<dl><dt><strong>mode</strong> = None</dl> + +<dl><dt><strong>mode_classes</strong> = {'!': <class 'ranger.gui.widgets.console.OpenConsole'>, '/': <class 'ranger.gui.widgets.console.SearchConsole'>, ':': <class 'ranger.gui.widgets.console.CommandConsole'>, '>': <class 'ranger.gui.widgets.console.QuickCommandConsole'>, '?': <class 'ranger.gui.widgets.console.SearchConsole'>, '@': <class 'ranger.gui.widgets.console.QuickOpenConsole'>}</dl> + +<dl><dt><strong>original_line</strong> = None</dl> + +<dl><dt><strong>override</strong> = None</dl> + +<dl><dt><strong>tab_deque</strong> = None</dl> + +<dl><dt><strong>visible</strong> = False</dl> + +<hr> +Methods inherited from <a href="ranger.gui.displayable.html#Displayable">ranger.gui.displayable.Displayable</a>:<br> +<dl><dt><a name="CommandConsole-__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="CommandConsole-__nonzero__"><strong>__nonzero__</strong></a>(self)</dt><dd><tt>Always True</tt></dd></dl> + +<dl><dt><a name="CommandConsole-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="CommandConsole-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="CommandConsole-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="CommandConsole-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="CommandConsole-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="CommandConsole-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="CommandConsole-poke"><strong>poke</strong></a>(self)</dt><dd><tt>Called before drawing, even if invisible</tt></dd></dl> + +<dl><dt><a name="CommandConsole-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>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> <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="Console">class <strong>Console</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.console.html#Console">Console</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="Console-__init__"><strong>__init__</strong></a>(self, win)</dt></dl> + +<dl><dt><a name="Console-add_to_history"><strong>add_to_history</strong></a>(self)</dt></dl> + +<dl><dt><a name="Console-clear"><strong>clear</strong></a>(self)</dt></dl> + +<dl><dt><a name="Console-close"><strong>close</strong></a>(self)</dt></dl> + +<dl><dt><a name="Console-delete"><strong>delete</strong></a>(self, mod)</dt></dl> + +<dl><dt><a name="Console-delete_rest"><strong>delete_rest</strong></a>(self, direction)</dt></dl> + +<dl><dt><a name="Console-delete_word"><strong>delete_word</strong></a>(self)</dt></dl> + +<dl><dt><a name="Console-draw"><strong>draw</strong></a>(self)</dt></dl> + +<dl><dt><a name="Console-execute"><strong>execute</strong></a>(self)</dt></dl> + +<dl><dt><a name="Console-finalize"><strong>finalize</strong></a>(self)</dt></dl> + +<dl><dt><a name="Console-history_move"><strong>history_move</strong></a>(self, n)</dt></dl> + +<dl><dt><a name="Console-init"><strong>init</strong></a>(self)</dt><dd><tt>override this. Called directly after class change</tt></dd></dl> + +<dl><dt><a name="Console-move"><strong>move</strong></a>(self, relative<font color="#909090">=0</font>, absolute<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="Console-on_line_change"><strong>on_line_change</strong></a>(self)</dt></dl> + +<dl><dt><a name="Console-open"><strong>open</strong></a>(self, mode, string<font color="#909090">=''</font>)</dt></dl> + +<dl><dt><a name="Console-paste"><strong>paste</strong></a>(self)</dt></dl> + +<dl><dt><a name="Console-press"><strong>press</strong></a>(self, key)</dt></dl> + +<dl><dt><a name="Console-tab"><strong>tab</strong></a>(self)</dt></dl> + +<dl><dt><a name="Console-type_key"><strong>type_key</strong></a>(self, key)</dt></dl> + +<hr> +Data and other attributes defined here:<br> +<dl><dt><strong>commandlist</strong> = None</dl> + +<dl><dt><strong>copy</strong> = ''</dl> + +<dl><dt><strong>histories</strong> = None</dl> + +<dl><dt><strong>history</strong> = None</dl> + +<dl><dt><strong>last_cursor_mode</strong> = 1</dl> + +<dl><dt><strong>mode</strong> = None</dl> + +<dl><dt><strong>mode_classes</strong> = {'!': <class 'ranger.gui.widgets.console.OpenConsole'>, '/': <class 'ranger.gui.widgets.console.SearchConsole'>, ':': <class 'ranger.gui.widgets.console.CommandConsole'>, '>': <class 'ranger.gui.widgets.console.QuickCommandConsole'>, '?': <class 'ranger.gui.widgets.console.SearchConsole'>, '@': <class 'ranger.gui.widgets.console.QuickOpenConsole'>}</dl> + +<dl><dt><strong>original_line</strong> = None</dl> + +<dl><dt><strong>override</strong> = None</dl> + +<dl><dt><strong>prompt</strong> = ':'</dl> + +<dl><dt><strong>tab_deque</strong> = None</dl> + +<dl><dt><strong>visible</strong> = False</dl> + +<hr> +Methods inherited from <a href="ranger.gui.displayable.html#Displayable">ranger.gui.displayable.Displayable</a>:<br> +<dl><dt><a name="Console-__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="Console-__nonzero__"><strong>__nonzero__</strong></a>(self)</dt><dd><tt>Always True</tt></dd></dl> + +<dl><dt><a name="Console-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="Console-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="Console-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="Console-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="Console-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="Console-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="Console-poke"><strong>poke</strong></a>(self)</dt><dd><tt>Called before drawing, even if invisible</tt></dd></dl> + +<dl><dt><a name="Console-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>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> <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="OpenConsole">class <strong>OpenConsole</strong></a>(<a href="ranger.gui.widgets.console.html#Console">Console</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.console.html#OpenConsole">OpenConsole</a></dd> +<dd><a href="ranger.gui.widgets.console.html#Console">Console</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> +Data and other attributes defined here:<br> +<dl><dt><strong>prompt</strong> = '!'</dl> + +<hr> +Methods inherited from <a href="ranger.gui.widgets.console.html#Console">Console</a>:<br> +<dl><dt><a name="OpenConsole-__init__"><strong>__init__</strong></a>(self, win)</dt></dl> + +<dl><dt><a name="OpenConsole-add_to_history"><strong>add_to_history</strong></a>(self)</dt></dl> + +<dl><dt><a name="OpenConsole-clear"><strong>clear</strong></a>(self)</dt></dl> + +<dl><dt><a name="OpenConsole-close"><strong>close</strong></a>(self)</dt></dl> + +<dl><dt><a name="OpenConsole-delete"><strong>delete</strong></a>(self, mod)</dt></dl> + +<dl><dt><a name="OpenConsole-delete_rest"><strong>delete_rest</strong></a>(self, direction)</dt></dl> + +<dl><dt><a name="OpenConsole-delete_word"><strong>delete_word</strong></a>(self)</dt></dl> + +<dl><dt><a name="OpenConsole-draw"><strong>draw</strong></a>(self)</dt></dl> + +<dl><dt><a name="OpenConsole-execute"><strong>execute</strong></a>(self)</dt></dl> + +<dl><dt><a name="OpenConsole-finalize"><strong>finalize</strong></a>(self)</dt></dl> + +<dl><dt><a name="OpenConsole-history_move"><strong>history_move</strong></a>(self, n)</dt></dl> + +<dl><dt><a name="OpenConsole-init"><strong>init</strong></a>(self)</dt><dd><tt>override this. Called directly after class change</tt></dd></dl> + +<dl><dt><a name="OpenConsole-move"><strong>move</strong></a>(self, relative<font color="#909090">=0</font>, absolute<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="OpenConsole-on_line_change"><strong>on_line_change</strong></a>(self)</dt></dl> + +<dl><dt><a name="OpenConsole-open"><strong>open</strong></a>(self, mode, string<font color="#909090">=''</font>)</dt></dl> + +<dl><dt><a name="OpenConsole-paste"><strong>paste</strong></a>(self)</dt></dl> + +<dl><dt><a name="OpenConsole-press"><strong>press</strong></a>(self, key)</dt></dl> + +<dl><dt><a name="OpenConsole-tab"><strong>tab</strong></a>(self)</dt></dl> + +<dl><dt><a name="OpenConsole-type_key"><strong>type_key</strong></a>(self, key)</dt></dl> + +<hr> +Data and other attributes inherited from <a href="ranger.gui.widgets.console.html#Console">Console</a>:<br> +<dl><dt><strong>commandlist</strong> = None</dl> + +<dl><dt><strong>copy</strong> = ''</dl> + +<dl><dt><strong>histories</strong> = None</dl> + +<dl><dt><strong>history</strong> = None</dl> + +<dl><dt><strong>last_cursor_mode</strong> = 1</dl> + +<dl><dt><strong>mode</strong> = None</dl> + +<dl><dt><strong>mode_classes</strong> = {'!': <class 'ranger.gui.widgets.console.OpenConsole'>, '/': <class 'ranger.gui.widgets.console.SearchConsole'>, ':': <class 'ranger.gui.widgets.console.CommandConsole'>, '>': <class 'ranger.gui.widgets.console.QuickCommandConsole'>, '?': <class 'ranger.gui.widgets.console.SearchConsole'>, '@': <class 'ranger.gui.widgets.console.QuickOpenConsole'>}</dl> + +<dl><dt><strong>original_line</strong> = None</dl> + +<dl><dt><strong>override</strong> = None</dl> + +<dl><dt><strong>tab_deque</strong> = None</dl> + +<dl><dt><strong>visible</strong> = False</dl> + +<hr> +Methods inherited from <a href="ranger.gui.displayable.html#Displayable">ranger.gui.displayable.Displayable</a>:<br> +<dl><dt><a name="OpenConsole-__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="OpenConsole-__nonzero__"><strong>__nonzero__</strong></a>(self)</dt><dd><tt>Always True</tt></dd></dl> + +<dl><dt><a name="OpenConsole-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="OpenConsole-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="OpenConsole-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="OpenConsole-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="OpenConsole-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="OpenConsole-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="OpenConsole-poke"><strong>poke</strong></a>(self)</dt><dd><tt>Called before drawing, even if invisible</tt></dd></dl> + +<dl><dt><a name="OpenConsole-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>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> <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="QuickCommandConsole">class <strong>QuickCommandConsole</strong></a>(<a href="ranger.gui.widgets.console.html#CommandConsole">CommandConsole</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.console.html#QuickCommandConsole">QuickCommandConsole</a></dd> +<dd><a href="ranger.gui.widgets.console.html#CommandConsole">CommandConsole</a></dd> +<dd><a href="ranger.gui.widgets.console.html#Console">Console</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="QuickCommandConsole-on_line_change"><strong>on_line_change</strong></a>(self)</dt></dl> + +<hr> +Data and other attributes defined here:<br> +<dl><dt><strong>prompt</strong> = '>'</dl> + +<hr> +Methods inherited from <a href="ranger.gui.widgets.console.html#CommandConsole">CommandConsole</a>:<br> +<dl><dt><a name="QuickCommandConsole-execute"><strong>execute</strong></a>(self)</dt></dl> + +<dl><dt><a name="QuickCommandConsole-tab"><strong>tab</strong></a>(self, n<font color="#909090">=1</font>)</dt></dl> + +<hr> +Methods inherited from <a href="ranger.gui.widgets.console.html#Console">Console</a>:<br> +<dl><dt><a name="QuickCommandConsole-__init__"><strong>__init__</strong></a>(self, win)</dt></dl> + +<dl><dt><a name="QuickCommandConsole-add_to_history"><strong>add_to_history</strong></a>(self)</dt></dl> + +<dl><dt><a name="QuickCommandConsole-clear"><strong>clear</strong></a>(self)</dt></dl> + +<dl><dt><a name="QuickCommandConsole-close"><strong>close</strong></a>(self)</dt></dl> + +<dl><dt><a name="QuickCommandConsole-delete"><strong>delete</strong></a>(self, mod)</dt></dl> + +<dl><dt><a name="QuickCommandConsole-delete_rest"><strong>delete_rest</strong></a>(self, direction)</dt></dl> + +<dl><dt><a name="QuickCommandConsole-delete_word"><strong>delete_word</strong></a>(self)</dt></dl> + +<dl><dt><a name="QuickCommandConsole-draw"><strong>draw</strong></a>(self)</dt></dl> + +<dl><dt><a name="QuickCommandConsole-finalize"><strong>finalize</strong></a>(self)</dt></dl> + +<dl><dt><a name="QuickCommandConsole-history_move"><strong>history_move</strong></a>(self, n)</dt></dl> + +<dl><dt><a name="QuickCommandConsole-init"><strong>init</strong></a>(self)</dt><dd><tt>override this. Called directly after class change</tt></dd></dl> + +<dl><dt><a name="QuickCommandConsole-move"><strong>move</strong></a>(self, relative<font color="#909090">=0</font>, absolute<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="QuickCommandConsole-open"><strong>open</strong></a>(self, mode, string<font color="#909090">=''</font>)</dt></dl> + +<dl><dt><a name="QuickCommandConsole-paste"><strong>paste</strong></a>(self)</dt></dl> + +<dl><dt><a name="QuickCommandConsole-press"><strong>press</strong></a>(self, key)</dt></dl> + +<dl><dt><a name="QuickCommandConsole-type_key"><strong>type_key</strong></a>(self, key)</dt></dl> + +<hr> +Data and other attributes inherited from <a href="ranger.gui.widgets.console.html#Console">Console</a>:<br> +<dl><dt><strong>commandlist</strong> = None</dl> + +<dl><dt><strong>copy</strong> = ''</dl> + +<dl><dt><strong>histories</strong> = None</dl> + +<dl><dt><strong>history</strong> = None</dl> + +<dl><dt><strong>last_cursor_mode</strong> = 1</dl> + +<dl><dt><strong>mode</strong> = None</dl> + +<dl><dt><strong>mode_classes</strong> = {'!': <class 'ranger.gui.widgets.console.OpenConsole'>, '/': <class 'ranger.gui.widgets.console.SearchConsole'>, ':': <class 'ranger.gui.widgets.console.CommandConsole'>, '>': <class 'ranger.gui.widgets.console.QuickCommandConsole'>, '?': <class 'ranger.gui.widgets.console.SearchConsole'>, '@': <class 'ranger.gui.widgets.console.QuickOpenConsole'>}</dl> + +<dl><dt><strong>original_line</strong> = None</dl> + +<dl><dt><strong>override</strong> = None</dl> + +<dl><dt><strong>tab_deque</strong> = None</dl> + +<dl><dt><strong>visible</strong> = False</dl> + +<hr> +Methods inherited from <a href="ranger.gui.displayable.html#Displayable">ranger.gui.displayable.Displayable</a>:<br> +<dl><dt><a name="QuickCommandConsole-__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="QuickCommandConsole-__nonzero__"><strong>__nonzero__</strong></a>(self)</dt><dd><tt>Always True</tt></dd></dl> + +<dl><dt><a name="QuickCommandConsole-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="QuickCommandConsole-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="QuickCommandConsole-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="QuickCommandConsole-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="QuickCommandConsole-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="QuickCommandConsole-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="QuickCommandConsole-poke"><strong>poke</strong></a>(self)</dt><dd><tt>Called before drawing, even if invisible</tt></dd></dl> + +<dl><dt><a name="QuickCommandConsole-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>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> <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="QuickOpenConsole">class <strong>QuickOpenConsole</strong></a>(<a href="ranger.gui.widgets.console.html#Console">Console</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>The <a href="#QuickOpenConsole">QuickOpenConsole</a> allows you to open files with<br> +pre-defined programs and modes very quickly. By adding flags<br> +to the command, you can specify precisely how the program is run,<br> +ie. the d-flag will run it detached from the filemanager.<br> </tt></td></tr> +<tr><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="ranger.gui.widgets.console.html#QuickOpenConsole">QuickOpenConsole</a></dd> +<dd><a href="ranger.gui.widgets.console.html#Console">Console</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="QuickOpenConsole-execute"><strong>execute</strong></a>(self)</dt></dl> + +<dl><dt><a name="QuickOpenConsole-init"><strong>init</strong></a>(self)</dt></dl> + +<hr> +Data and other attributes defined here:<br> +<dl><dt><strong>prompt</strong> = 'open with: '</dl> + +<hr> +Methods inherited from <a href="ranger.gui.widgets.console.html#Console">Console</a>:<br> +<dl><dt><a name="QuickOpenConsole-__init__"><strong>__init__</strong></a>(self, win)</dt></dl> + +<dl><dt><a name="QuickOpenConsole-add_to_history"><strong>add_to_history</strong></a>(self)</dt></dl> + +<dl><dt><a name="QuickOpenConsole-clear"><strong>clear</strong></a>(self)</dt></dl> + +<dl><dt><a name="QuickOpenConsole-close"><strong>close</strong></a>(self)</dt></dl> + +<dl><dt><a name="QuickOpenConsole-delete"><strong>delete</strong></a>(self, mod)</dt></dl> + +<dl><dt><a name="QuickOpenConsole-delete_rest"><strong>delete_rest</strong></a>(self, direction)</dt></dl> + +<dl><dt><a name="QuickOpenConsole-delete_word"><strong>delete_word</strong></a>(self)</dt></dl> + +<dl><dt><a name="QuickOpenConsole-draw"><strong>draw</strong></a>(self)</dt></dl> + +<dl><dt><a name="QuickOpenConsole-finalize"><strong>finalize</strong></a>(self)</dt></dl> + +<dl><dt><a name="QuickOpenConsole-history_move"><strong>history_move</strong></a>(self, n)</dt></dl> + +<dl><dt><a name="QuickOpenConsole-move"><strong>move</strong></a>(self, relative<font color="#909090">=0</font>, absolute<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="QuickOpenConsole-on_line_change"><strong>on_line_change</strong></a>(self)</dt></dl> + +<dl><dt><a name="QuickOpenConsole-open"><strong>open</strong></a>(self, mode, string<font color="#909090">=''</font>)</dt></dl> + +<dl><dt><a name="QuickOpenConsole-paste"><strong>paste</strong></a>(self)</dt></dl> + +<dl><dt><a name="QuickOpenConsole-press"><strong>press</strong></a>(self, key)</dt></dl> + +<dl><dt><a name="QuickOpenConsole-tab"><strong>tab</strong></a>(self)</dt></dl> + +<dl><dt><a name="QuickOpenConsole-type_key"><strong>type_key</strong></a>(self, key)</dt></dl> + +<hr> +Data and other attributes inherited from <a href="ranger.gui.widgets.console.html#Console">Console</a>:<br> +<dl><dt><strong>commandlist</strong> = None</dl> + +<dl><dt><strong>copy</strong> = ''</dl> + +<dl><dt><strong>histories</strong> = None</dl> + +<dl><dt><strong>history</strong> = None</dl> + +<dl><dt><strong>last_cursor_mode</strong> = 1</dl> + +<dl><dt><strong>mode</strong> = None</dl> + +<dl><dt><strong>mode_classes</strong> = {'!': <class 'ranger.gui.widgets.console.OpenConsole'>, '/': <class 'ranger.gui.widgets.console.SearchConsole'>, ':': <class 'ranger.gui.widgets.console.CommandConsole'>, '>': <class 'ranger.gui.widgets.console.QuickCommandConsole'>, '?': <class 'ranger.gui.widgets.console.SearchConsole'>, '@': <class 'ranger.gui.widgets.console.QuickOpenConsole'>}</dl> + +<dl><dt><strong>original_line</strong> = None</dl> + +<dl><dt><strong>override</strong> = None</dl> + +<dl><dt><strong>tab_deque</strong> = None</dl> + +<dl><dt><strong>visible</strong> = False</dl> + +<hr> +Methods inherited from <a href="ranger.gui.displayable.html#Displayable">ranger.gui.displayable.Displayable</a>:<br> +<dl><dt><a name="QuickOpenConsole-__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="QuickOpenConsole-__nonzero__"><strong>__nonzero__</strong></a>(self)</dt><dd><tt>Always True</tt></dd></dl> + +<dl><dt><a name="QuickOpenConsole-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="QuickOpenConsole-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="QuickOpenConsole-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="QuickOpenConsole-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="QuickOpenConsole-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="QuickOpenConsole-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="QuickOpenConsole-poke"><strong>poke</strong></a>(self)</dt><dd><tt>Called before drawing, even if invisible</tt></dd></dl> + +<dl><dt><a name="QuickOpenConsole-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>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> <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="SearchConsole">class <strong>SearchConsole</strong></a>(<a href="ranger.gui.widgets.console.html#Console">Console</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.console.html#SearchConsole">SearchConsole</a></dd> +<dd><a href="ranger.gui.widgets.console.html#Console">Console</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="SearchConsole-execute"><strong>execute</strong></a>(self)</dt></dl> + +<dl><dt><a name="SearchConsole-init"><strong>init</strong></a>(self)</dt></dl> + +<hr> +Data and other attributes defined here:<br> +<dl><dt><strong>prompt</strong> = '/'</dl> + +<hr> +Methods inherited from <a href="ranger.gui.widgets.console.html#Console">Console</a>:<br> +<dl><dt><a name="SearchConsole-__init__"><strong>__init__</strong></a>(self, win)</dt></dl> + +<dl><dt><a name="SearchConsole-add_to_history"><strong>add_to_history</strong></a>(self)</dt></dl> + +<dl><dt><a name="SearchConsole-clear"><strong>clear</strong></a>(self)</dt></dl> + +<dl><dt><a name="SearchConsole-close"><strong>close</strong></a>(self)</dt></dl> + +<dl><dt><a name="SearchConsole-delete"><strong>delete</strong></a>(self, mod)</dt></dl> + +<dl><dt><a name="SearchConsole-delete_rest"><strong>delete_rest</strong></a>(self, direction)</dt></dl> + +<dl><dt><a name="SearchConsole-delete_word"><strong>delete_word</strong></a>(self)</dt></dl> + +<dl><dt><a name="SearchConsole-draw"><strong>draw</strong></a>(self)</dt></dl> + +<dl><dt><a name="SearchConsole-finalize"><strong>finalize</strong></a>(self)</dt></dl> + +<dl><dt><a name="SearchConsole-history_move"><strong>history_move</strong></a>(self, n)</dt></dl> + +<dl><dt><a name="SearchConsole-move"><strong>move</strong></a>(self, relative<font color="#909090">=0</font>, absolute<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="SearchConsole-on_line_change"><strong>on_line_change</strong></a>(self)</dt></dl> + +<dl><dt><a name="SearchConsole-open"><strong>open</strong></a>(self, mode, string<font color="#909090">=''</font>)</dt></dl> + +<dl><dt><a name="SearchConsole-paste"><strong>paste</strong></a>(self)</dt></dl> + +<dl><dt><a name="SearchConsole-press"><strong>press</strong></a>(self, key)</dt></dl> + +<dl><dt><a name="SearchConsole-tab"><strong>tab</strong></a>(self)</dt></dl> + +<dl><dt><a name="SearchConsole-type_key"><strong>type_key</strong></a>(self, key)</dt></dl> + +<hr> +Data and other attributes inherited from <a href="ranger.gui.widgets.console.html#Console">Console</a>:<br> +<dl><dt><strong>commandlist</strong> = None</dl> + +<dl><dt><strong>copy</strong> = ''</dl> + +<dl><dt><strong>histories</strong> = None</dl> + +<dl><dt><strong>history</strong> = None</dl> + +<dl><dt><strong>last_cursor_mode</strong> = 1</dl> + +<dl><dt><strong>mode</strong> = None</dl> + +<dl><dt><strong>mode_classes</strong> = {'!': <class 'ranger.gui.widgets.console.OpenConsole'>, '/': <class 'ranger.gui.widgets.console.SearchConsole'>, ':': <class 'ranger.gui.widgets.console.CommandConsole'>, '>': <class 'ranger.gui.widgets.console.QuickCommandConsole'>, '?': <class 'ranger.gui.widgets.console.SearchConsole'>, '@': <class 'ranger.gui.widgets.console.QuickOpenConsole'>}</dl> + +<dl><dt><strong>original_line</strong> = None</dl> + +<dl><dt><strong>override</strong> = None</dl> + +<dl><dt><strong>tab_deque</strong> = None</dl> + +<dl><dt><strong>visible</strong> = False</dl> + +<hr> +Methods inherited from <a href="ranger.gui.displayable.html#Displayable">ranger.gui.displayable.Displayable</a>:<br> +<dl><dt><a name="SearchConsole-__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="SearchConsole-__nonzero__"><strong>__nonzero__</strong></a>(self)</dt><dd><tt>Always True</tt></dd></dl> + +<dl><dt><a name="SearchConsole-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="SearchConsole-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="SearchConsole-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="SearchConsole-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="SearchConsole-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="SearchConsole-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="SearchConsole-poke"><strong>poke</strong></a>(self)</dt><dd><tt>Called before drawing, even if invisible</tt></dd></dl> + +<dl><dt><a name="SearchConsole-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>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><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#55aa55"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> + +<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> +<td width="100%"><strong>DEFAULT_HISTORY</strong> = 0<br> +<strong>QUICKOPEN_HISTORY</strong> = 2<br> +<strong>SEARCH_HISTORY</strong> = 1</td></tr></table> +</body></html> \ No newline at end of file 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 diff --git a/doc/ranger.gui.widgets.filelistcontainer.html b/doc/ranger.gui.widgets.filelistcontainer.html new file mode 100644 index 00000000..1d248bba --- /dev/null +++ b/doc/ranger.gui.widgets.filelistcontainer.html @@ -0,0 +1,136 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module ranger.gui.widgets.filelistcontainer</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>.filelistcontainer</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/filelistcontainer.py">/home/hut/work/ranger/ranger/gui/widgets/filelistcontainer.py</a></font></td></tr></table> + <p><tt>The <a href="#FileListContainer">FileListContainer</a> manages a set of FileLists.</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.displayable.html#DisplayableContainer">ranger.gui.displayable.DisplayableContainer</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.filelistcontainer.html#FileListContainer">FileListContainer</a>(<a href="ranger.gui.widgets.html#Widget">ranger.gui.widgets.Widget</a>, <a href="ranger.gui.displayable.html#DisplayableContainer">ranger.gui.displayable.DisplayableContainer</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> +<dt><font face="helvetica, arial"><a href="ranger.gui.widgets.filelistcontainer.html#FileListContainer">FileListContainer</a>(<a href="ranger.gui.widgets.html#Widget">ranger.gui.widgets.Widget</a>, <a href="ranger.gui.displayable.html#DisplayableContainer">ranger.gui.displayable.DisplayableContainer</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="FileListContainer">class <strong>FileListContainer</strong></a>(<a href="ranger.gui.widgets.html#Widget">ranger.gui.widgets.Widget</a>, <a href="ranger.gui.displayable.html#DisplayableContainer">ranger.gui.displayable.DisplayableContainer</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.filelistcontainer.html#FileListContainer">FileListContainer</a></dd> +<dd><a href="ranger.gui.widgets.html#Widget">ranger.gui.widgets.Widget</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.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="FileListContainer-__init__"><strong>__init__</strong></a>(self, win, ratios, preview<font color="#909090">=True</font>)</dt></dl> + +<dl><dt><a name="FileListContainer-poke"><strong>poke</strong></a>(self)</dt></dl> + +<dl><dt><a name="FileListContainer-resize"><strong>resize</strong></a>(self, y, x, hei, wid)</dt><dd><tt>Resize all the filelists according to the given ratio</tt></dd></dl> + +<hr> +Data and other attributes defined here:<br> +<dl><dt><strong>preview</strong> = True</dl> + +<dl><dt><strong>preview_available</strong> = True</dl> + +<dl><dt><strong>ratios</strong> = None</dl> + +<dl><dt><strong>stretch_ratios</strong> = None</dl> + +<hr> +Methods inherited from <a href="ranger.gui.displayable.html#DisplayableContainer">ranger.gui.displayable.DisplayableContainer</a>:<br> +<dl><dt><a name="FileListContainer-add_obj"><strong>add_obj</strong></a>(self, *objs)</dt></dl> + +<dl><dt><a name="FileListContainer-click"><strong>click</strong></a>(self, event)</dt><dd><tt>Recursively called on objects in container</tt></dd></dl> + +<dl><dt><a name="FileListContainer-destroy"><strong>destroy</strong></a>(self)</dt><dd><tt>Recursively called on objects in container</tt></dd></dl> + +<dl><dt><a name="FileListContainer-draw"><strong>draw</strong></a>(self)</dt><dd><tt>Recursively called on visible objects in container</tt></dd></dl> + +<dl><dt><a name="FileListContainer-finalize"><strong>finalize</strong></a>(self)</dt><dd><tt>Recursively called on visible objects in container</tt></dd></dl> + +<dl><dt><a name="FileListContainer-get_focused_obj"><strong>get_focused_obj</strong></a>(self)</dt><dd><tt>Finds a focused displayable object in the container.</tt></dd></dl> + +<dl><dt><a name="FileListContainer-press"><strong>press</strong></a>(self, key)</dt><dd><tt>Recursively called on objects in container</tt></dd></dl> + +<hr> +Data and other attributes inherited from <a href="ranger.gui.displayable.html#DisplayableContainer">ranger.gui.displayable.DisplayableContainer</a>:<br> +<dl><dt><strong>container</strong> = None</dl> + +<hr> +Methods inherited from <a href="ranger.gui.displayable.html#Displayable">ranger.gui.displayable.Displayable</a>:<br> +<dl><dt><a name="FileListContainer-__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="FileListContainer-__nonzero__"><strong>__nonzero__</strong></a>(self)</dt><dd><tt>Always True</tt></dd></dl> + +<dl><dt><a name="FileListContainer-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="FileListContainer-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="FileListContainer-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="FileListContainer-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> + +<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 diff --git a/doc/ranger.gui.widgets.html b/doc/ranger.gui.widgets.html new file mode 100644 index 00000000..7c93bf98 --- /dev/null +++ b/doc/ranger.gui.widgets.html @@ -0,0 +1,128 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: package ranger.gui.widgets</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>.widgets</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/__init__.py">/home/hut/work/ranger/ranger/gui/widgets/__init__.py</a></font></td></tr></table> + <p></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<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> +<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></tr></table></td></tr></table><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.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>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="ranger.gui.widgets.html#Widget">Widget</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="Widget">class <strong>Widget</strong></a>(<a href="ranger.gui.displayable.html#Displayable">ranger.gui.displayable.Displayable</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>The <a href="#Widget">Widget</a> class defines no methods and only exists for<br> +classification of widgets.<br> </tt></td></tr> +<tr><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="ranger.gui.widgets.html#Widget">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 inherited from <a href="ranger.gui.displayable.html#Displayable">ranger.gui.displayable.Displayable</a>:<br> +<dl><dt><a name="Widget-__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="Widget-__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="Widget-__nonzero__"><strong>__nonzero__</strong></a>(self)</dt><dd><tt>Always True</tt></dd></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-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-finalize"><strong>finalize</strong></a>(self)</dt><dd><tt>Called after every displayable is done drawing.<br> +Override this!</tt></dd></dl> + +<dl><dt><a name="Widget-poke"><strong>poke</strong></a>(self)</dt><dd><tt>Called before drawing, even if invisible</tt></dd></dl> + +<dl><dt><a name="Widget-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="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> + +<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 diff --git a/doc/ranger.gui.widgets.notify.html b/doc/ranger.gui.widgets.notify.html new file mode 100644 index 00000000..cd74e50e --- /dev/null +++ b/doc/ranger.gui.widgets.notify.html @@ -0,0 +1,174 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module ranger.gui.widgets.notify</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>.notify</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/notify.py">/home/hut/work/ranger/ranger/gui/widgets/notify.py</a></font></td></tr></table> + <p><tt><a href="#Notify">Notify</a> is a bar which displays messages.</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="builtins.html#object">builtins.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="ranger.gui.widgets.notify.html#Message">Message</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> +<dt><font face="helvetica, arial"><a href="ranger.gui.widgets.notify.html#Notify">Notify</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="Message">class <strong>Message</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="Message-__init__"><strong>__init__</strong></a>(self, container, text, duration, bad)</dt></dl> + +<dl><dt><a name="Message-delete"><strong>delete</strong></a>(self)</dt></dl> + +<dl><dt><a name="Message-set_duration"><strong>set_duration</strong></a>(self, n<font color="#909090">=4</font>)</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>alive</strong> = True</dl> + +<dl><dt><strong>bad</strong> = False</dl> + +<dl><dt><strong>container</strong> = None</dl> + +<dl><dt><strong>elapse</strong> = None</dl> + +<dl><dt><strong>text</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="Notify">class <strong>Notify</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.notify.html#Notify">Notify</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="Notify-__init__"><strong>__init__</strong></a>(self, win)</dt></dl> + +<dl><dt><a name="Notify-display"><strong>display</strong></a>(self, text, duration<font color="#909090">=4</font>, bad<font color="#909090">=False</font>)</dt></dl> + +<dl><dt><a name="Notify-draw"><strong>draw</strong></a>(self)</dt></dl> + +<dl><dt><a name="Notify-poke"><strong>poke</strong></a>(self)</dt></dl> + +<hr> +Data and other attributes defined here:<br> +<dl><dt><strong>max_size</strong> = 5</dl> + +<dl><dt><strong>requested_height</strong> = 0</dl> + +<dl><dt><strong>textcontainer</strong> = None</dl> + +<hr> +Methods inherited from <a href="ranger.gui.displayable.html#Displayable">ranger.gui.displayable.Displayable</a>:<br> +<dl><dt><a name="Notify-__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> + +<dl><dt><a name="Notify-__nonzero__"><strong>__nonzero__</strong></a>(self)</dt><dd><tt>Always True</tt></dd></dl> + +<dl><dt><a name="Notify-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="Notify-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="Notify-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="Notify-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="Notify-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="Notify-destroy"><strong>destroy</strong></a>(self)</dt><dd><tt>Called when the <a href="builtins.html#object">object</a> is destroyed.<br> +Override this!</tt></dd></dl> + +<dl><dt><a name="Notify-finalize"><strong>finalize</strong></a>(self)</dt><dd><tt>Called after every displayable is done drawing.<br> +Override this!</tt></dd></dl> + +<dl><dt><a name="Notify-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="Notify-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><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#eeaa77"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> + +<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt><a name="-time"><strong>time</strong></a>(...)</dt><dd><tt><a href="#-time">time</a>() -> floating point number<br> + <br> +Return the current time in seconds since the Epoch.<br> +Fractions of a second may be present if the system clock provides them.</tt></dd></dl> +</td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/ranger.gui.widgets.process_manager.html b/doc/ranger.gui.widgets.process_manager.html new file mode 100644 index 00000000..6b74b162 --- /dev/null +++ b/doc/ranger.gui.widgets.process_manager.html @@ -0,0 +1,207 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module ranger.gui.widgets.process_manager</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>.process_manager</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/process_manager.py">/home/hut/work/ranger/ranger/gui/widgets/process_manager.py</a></font></td></tr></table> + <p><tt>The process manager allows you to modify what the loader is doing.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</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="curses.html">curses</a><br> +</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><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="builtins.html#object">builtins.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="ranger.gui.widgets.process_manager.html#DummyLoadObject">DummyLoadObject</a> +</font></dt><dt><font face="helvetica, arial"><a href="ranger.gui.widgets.process_manager.html#DummyLoader">DummyLoader</a> +</font></dt><dt><font face="helvetica, arial"><a href="ranger.gui.widgets.process_manager.html#KeyWrapper">KeyWrapper</a> +</font></dt></dl> +</dd> +<dt><font face="helvetica, arial"><a href="ranger.ext.accumulator.html#Accumulator">ranger.ext.accumulator.Accumulator</a>(<a href="builtins.html#object">builtins.object</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="ranger.gui.widgets.process_manager.html#ProcessManager">ProcessManager</a>(<a href="ranger.gui.widgets.html#Widget">ranger.gui.widgets.Widget</a>, <a href="ranger.ext.accumulator.html#Accumulator">ranger.ext.accumulator.Accumulator</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> +<dt><font face="helvetica, arial"><a href="ranger.gui.widgets.process_manager.html#ProcessManager">ProcessManager</a>(<a href="ranger.gui.widgets.html#Widget">ranger.gui.widgets.Widget</a>, <a href="ranger.ext.accumulator.html#Accumulator">ranger.ext.accumulator.Accumulator</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="DummyLoadObject">class <strong>DummyLoadObject</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="DummyLoadObject-__init__"><strong>__init__</strong></a>(self, txt)</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> +</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="DummyLoader">class <strong>DummyLoader</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="DummyLoader-__init__"><strong>__init__</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> +</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="KeyWrapper">class <strong>KeyWrapper</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%">Static methods defined here:<br> +<dl><dt><a name="KeyWrapper-move"><strong>move</strong></a>(relative<font color="#909090">=0</font>, absolute<font color="#909090">=None</font>)</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> +</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="ProcessManager">class <strong>ProcessManager</strong></a>(<a href="ranger.gui.widgets.html#Widget">ranger.gui.widgets.Widget</a>, <a href="ranger.ext.accumulator.html#Accumulator">ranger.ext.accumulator.Accumulator</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.process_manager.html#ProcessManager">ProcessManager</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="ranger.ext.accumulator.html#Accumulator">ranger.ext.accumulator.Accumulator</a></dd> +<dd><a href="builtins.html#object">builtins.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="ProcessManager-__init__"><strong>__init__</strong></a>(self, win)</dt></dl> + +<dl><dt><a name="ProcessManager-draw"><strong>draw</strong></a>(self)</dt></dl> + +<dl><dt><a name="ProcessManager-get_list"><strong>get_list</strong></a>(self)</dt></dl> + +<dl><dt><a name="ProcessManager-press"><strong>press</strong></a>(self, key)</dt></dl> + +<dl><dt><a name="ProcessManager-process_move"><strong>process_move</strong></a>(self, absolute, i<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="ProcessManager-process_remove"><strong>process_remove</strong></a>(self, i<font color="#909090">=None</font>)</dt></dl> + +<hr> +Methods inherited from <a href="ranger.gui.displayable.html#Displayable">ranger.gui.displayable.Displayable</a>:<br> +<dl><dt><a name="ProcessManager-__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> + +<dl><dt><a name="ProcessManager-__nonzero__"><strong>__nonzero__</strong></a>(self)</dt><dd><tt>Always True</tt></dd></dl> + +<dl><dt><a name="ProcessManager-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="ProcessManager-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="ProcessManager-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="ProcessManager-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="ProcessManager-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="ProcessManager-destroy"><strong>destroy</strong></a>(self)</dt><dd><tt>Called when the <a href="builtins.html#object">object</a> is destroyed.<br> +Override this!</tt></dd></dl> + +<dl><dt><a name="ProcessManager-finalize"><strong>finalize</strong></a>(self)</dt><dd><tt>Called after every displayable is done drawing.<br> +Override this!</tt></dd></dl> + +<dl><dt><a name="ProcessManager-poke"><strong>poke</strong></a>(self)</dt><dd><tt>Called before drawing, even if invisible</tt></dd></dl> + +<dl><dt><a name="ProcessManager-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> + +<hr> +Methods inherited from <a href="ranger.ext.accumulator.html#Accumulator">ranger.ext.accumulator.Accumulator</a>:<br> +<dl><dt><a name="ProcessManager-correct_pointer"><strong>correct_pointer</strong></a>(self)</dt></dl> + +<dl><dt><a name="ProcessManager-move"><strong>move</strong></a>(self, relative<font color="#909090">=0</font>, absolute<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="ProcessManager-move_to_obj"><strong>move_to_obj</strong></a>(self, arg, attr<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="ProcessManager-pointer_is_synced"><strong>pointer_is_synced</strong></a>(self)</dt></dl> + +<dl><dt><a name="ProcessManager-sync_index"><strong>sync_index</strong></a>(self, **kw)</dt></dl> + +</td></tr></table></td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/ranger.gui.widgets.statusbar.html b/doc/ranger.gui.widgets.statusbar.html new file mode 100644 index 00000000..9144105d --- /dev/null +++ b/doc/ranger.gui.widgets.statusbar.html @@ -0,0 +1,164 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module ranger.gui.widgets.statusbar</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>.statusbar</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/statusbar.py">/home/hut/work/ranger/ranger/gui/widgets/statusbar.py</a></font></td></tr></table> + <p><tt>The <a href="#StatusBar">StatusBar</a> displays information about the currently selected file<br> +in the same form as the "ls -l" command on the left side, and<br> +some additional info about the current directory on the right side.</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.statusbar.html#StatusBar">StatusBar</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="StatusBar">class <strong>StatusBar</strong></a>(<a href="ranger.gui.widgets.html#Widget">ranger.gui.widgets.Widget</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>The <a href="#StatusBar">StatusBar</a> displays information about the currently selected file<br> +in the same form as the "ls -l" command on the left side, and<br> +some additional info about the current directory on the right side.<br> </tt></td></tr> +<tr><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="ranger.gui.widgets.statusbar.html#StatusBar">StatusBar</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="StatusBar-__init__"><strong>__init__</strong></a>(self, win, filelist<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="StatusBar-draw"><strong>draw</strong></a>(self)</dt><dd><tt>Draw the statusbar</tt></dd></dl> + +<hr> +Data and other attributes defined here:<br> +<dl><dt><strong>groups</strong> = {}</dl> + +<dl><dt><strong>old_cf</strong> = None</dl> + +<dl><dt><strong>old_mtime</strong> = None</dl> + +<dl><dt><strong>old_wid</strong> = None</dl> + +<dl><dt><strong>override</strong> = None</dl> + +<dl><dt><strong>owners</strong> = {}</dl> + +<dl><dt><strong>result</strong> = None</dl> + +<dl><dt><strong>timeformat</strong> = '%Y-%m-%d %H:%M'</dl> + +<hr> +Methods inherited from <a href="ranger.gui.displayable.html#Displayable">ranger.gui.displayable.Displayable</a>:<br> +<dl><dt><a name="StatusBar-__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="StatusBar-__nonzero__"><strong>__nonzero__</strong></a>(self)</dt><dd><tt>Always True</tt></dd></dl> + +<dl><dt><a name="StatusBar-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="StatusBar-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="StatusBar-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="StatusBar-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="StatusBar-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="StatusBar-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="StatusBar-finalize"><strong>finalize</strong></a>(self)</dt><dd><tt>Called after every displayable is done drawing.<br> +Override this!</tt></dd></dl> + +<dl><dt><a name="StatusBar-poke"><strong>poke</strong></a>(self)</dt><dd><tt>Called before drawing, even if invisible</tt></dd></dl> + +<dl><dt><a name="StatusBar-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="StatusBar-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><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#eeaa77"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> + +<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt><a name="-getgrgid"><strong>getgrgid</strong></a>(...)</dt><dd><tt><a href="#-getgrgid">getgrgid</a>(id) -> tuple<br> +Return the group database entry for the given numeric group ID. If<br> +id is not valid, raise KeyError.</tt></dd></dl> + <dl><dt><a name="-getpwuid"><strong>getpwuid</strong></a>(...)</dt><dd><tt><a href="#-getpwuid">getpwuid</a>(uid) -> (pw_name,pw_passwd,pw_uid,<br> + pw_gid,pw_gecos,pw_dir,pw_shell)<br> +Return the password database entry for the given numeric user ID.<br> +See pwd.__doc__ for more on password database entries.</tt></dd></dl> + <dl><dt><a name="-getuid"><strong>getuid</strong></a>(...)</dt><dd><tt><a href="#-getuid">getuid</a>() -> uid<br> + <br> +Return the current process's user id.</tt></dd></dl> + <dl><dt><a name="-localtime"><strong>localtime</strong></a>(...)</dt><dd><tt><a href="#-localtime">localtime</a>([seconds]) -> (tm_year,tm_mon,tm_mday,tm_hour,tm_min,<br> + tm_sec,tm_wday,tm_yday,tm_isdst)<br> + <br> +Convert seconds since the Epoch to a time tuple expressing local time.<br> +When 'seconds' is not passed in, convert the current time instead.</tt></dd></dl> + <dl><dt><a name="-strftime"><strong>strftime</strong></a>(...)</dt><dd><tt><a href="#-strftime">strftime</a>(format[, tuple]) -> string<br> + <br> +Convert a time tuple to a string according to a format specification.<br> +See the library reference manual for formatting codes. When the time tuple<br> +is not present, current time as returned by <a href="#-localtime">localtime</a>() is used.</tt></dd></dl> +</td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/ranger.gui.widgets.titlebar.html b/doc/ranger.gui.widgets.titlebar.html new file mode 100644 index 00000000..c7052477 --- /dev/null +++ b/doc/ranger.gui.widgets.titlebar.html @@ -0,0 +1,325 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module ranger.gui.widgets.titlebar</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>.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> +<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="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> +<dt><font face="helvetica, arial"><a href="ranger.gui.widgets.titlebar.html#TitleBar">TitleBar</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="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> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="ranger.gui.widgets.titlebar.html#TitleBar">TitleBar</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="TitleBar-draw"><strong>draw</strong></a>(self)</dt></dl> + +<hr> +Data and other attributes defined here:<br> +<dl><dt><strong>old_cf</strong> = None</dl> + +<dl><dt><strong>old_keybuffer</strong> = None</dl> + +<dl><dt><strong>old_wid</strong> = None</dl> + +<dl><dt><strong>result</strong> = None</dl> + +<dl><dt><strong>throbber</strong> = ' '</dl> + +<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> + +<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-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-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> +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> +Override this!</tt></dd></dl> + +<dl><dt><a name="TitleBar-poke"><strong>poke</strong></a>(self)</dt><dd><tt>Called before drawing, even if invisible</tt></dd></dl> + +<dl><dt><a name="TitleBar-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="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> + +<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><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#eeaa77"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> + +<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt><a name="-floor"><strong>floor</strong></a>(...)</dt><dd><tt><a href="#-floor">floor</a>(x)<br> + <br> +Return the floor of x as an int.<br> +This is the largest integral value <= x.</tt></dd></dl> +</td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/ranger.html b/doc/ranger.html new file mode 100644 index 00000000..0fd5ba08 --- /dev/null +++ b/doc/ranger.html @@ -0,0 +1,70 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: package ranger</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>ranger</strong></big></big> (version 1.0.0)</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/__init__.py">/home/hut/work/ranger/ranger/__init__.py</a></font></td></tr></table> + <p><tt>Ranger - file browser for the unix terminal</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<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.actions.html">actions</a><br> +<a href="ranger.applications.html">applications</a><br> +<a href="ranger.colorschemes.html"><strong>colorschemes</strong> (package)</a><br> +</td><td width="25%" valign=top><a href="ranger.commands.html">commands</a><br> +<a href="ranger.container.html"><strong>container</strong> (package)</a><br> +<a href="ranger.defaults.html"><strong>defaults</strong> (package)</a><br> +</td><td width="25%" valign=top><a href="ranger.ext.html"><strong>ext</strong> (package)</a><br> +<a href="ranger.fm.html">fm</a><br> +<a href="ranger.fsobject.html"><strong>fsobject</strong> (package)</a><br> +</td><td width="25%" valign=top><a href="ranger.gui.html"><strong>gui</strong> (package)</a><br> +<a href="ranger.shared.html"><strong>shared</strong> (package)</a><br> +</td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#eeaa77"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> + +<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt><a name="-main"><strong>main</strong></a>()</dt><dd><tt>initialize objects and run the filemanager</tt></dd></dl> +</td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#55aa55"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> + +<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> +<td width="100%"><strong>CONFDIR</strong> = '/home/hut/.ranger'<br> +<strong>RANGERDIR</strong> = '/home/hut/work/ranger/ranger'<br> +<strong>USAGE</strong> = '%s [options] [path/filename]'<br> +<strong>__author__</strong> = 'hut'<br> +<strong>__copyright__</strong> = 'none'<br> +<strong>__credits__</strong> = 'hut'<br> +<strong>__email__</strong> = 'hut@lavabit.com'<br> +<strong>__license__</strong> = 'GPL'<br> +<strong>__maintainer__</strong> = 'hut'<br> +<strong>__version__</strong> = '1.0.0'</td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#7799ee"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Author</strong></big></font></td></tr> + +<tr><td bgcolor="#7799ee"><tt> </tt></td><td> </td> +<td width="100%">hut</td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#7799ee"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Credits</strong></big></font></td></tr> + +<tr><td bgcolor="#7799ee"><tt> </tt></td><td> </td> +<td width="100%">hut</td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/ranger.shared.html b/doc/ranger.shared.html new file mode 100644 index 00000000..225b3ade --- /dev/null +++ b/doc/ranger.shared.html @@ -0,0 +1,107 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: package ranger.shared</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>.shared</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/shared/__init__.py">/home/hut/work/ranger/ranger/shared/__init__.py</a></font></td></tr></table> + <p><tt>Shared objects contian singleton variables wich can be<br> +inherited, essentially acting like global variables.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<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.shared.mimetype.html">mimetype</a><br> +</td><td width="25%" valign=top><a href="ranger.shared.settings.html">settings</a><br> +</td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><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="builtins.html#object">builtins.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="ranger.shared.html#Awareness">Awareness</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="ranger.shared.html#EnvironmentAware">EnvironmentAware</a> +</font></dt><dt><font face="helvetica, arial"><a href="ranger.shared.html#FileManagerAware">FileManagerAware</a> +</font></dt></dl> +</dd> +</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="Awareness">class <strong>Awareness</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%">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> +</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="EnvironmentAware">class <strong>EnvironmentAware</strong></a>(<a href="ranger.shared.html#Awareness">Awareness</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.shared.html#EnvironmentAware">EnvironmentAware</a></dd> +<dd><a href="ranger.shared.html#Awareness">Awareness</a></dd> +<dd><a href="builtins.html#object">builtins.object</a></dd> +</dl> +<hr> +Data and other attributes defined here:<br> +<dl><dt><strong>env</strong> = None</dl> + +<hr> +Data descriptors inherited from <a href="ranger.shared.html#Awareness">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> +</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="FileManagerAware">class <strong>FileManagerAware</strong></a>(<a href="ranger.shared.html#Awareness">Awareness</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.shared.html#FileManagerAware">FileManagerAware</a></dd> +<dd><a href="ranger.shared.html#Awareness">Awareness</a></dd> +<dd><a href="builtins.html#object">builtins.object</a></dd> +</dl> +<hr> +Data and other attributes defined here:<br> +<dl><dt><strong>fm</strong> = None</dl> + +<hr> +Data descriptors inherited from <a href="ranger.shared.html#Awareness">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> +</td></tr></table></td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/ranger.shared.mimetype.html b/doc/ranger.shared.mimetype.html new file mode 100644 index 00000000..4ae8aabb --- /dev/null +++ b/doc/ranger.shared.mimetype.html @@ -0,0 +1,51 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module ranger.shared.mimetype</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.shared.html"><font color="#ffffff">shared</font></a>.mimetype</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/shared/mimetype.py">/home/hut/work/ranger/ranger/shared/mimetype.py</a></font></td></tr></table> + <p></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="builtins.html#object">builtins.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="ranger.shared.mimetype.html#MimeTypeAware">MimeTypeAware</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="MimeTypeAware">class <strong>MimeTypeAware</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="MimeTypeAware-__init__"><strong>__init__</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>mimetypes</strong> = {}</dl> + +</td></tr></table></td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/ranger.shared.settings.html b/doc/ranger.shared.settings.html new file mode 100644 index 00000000..ec661e76 --- /dev/null +++ b/doc/ranger.shared.settings.html @@ -0,0 +1,54 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module ranger.shared.settings</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.shared.html"><font color="#ffffff">shared</font></a>.settings</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/shared/settings.py">/home/hut/work/ranger/ranger/shared/settings.py</a></font></td></tr></table> + <p></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="builtins.html#object">builtins.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="ranger.shared.settings.html#SettingsAware">SettingsAware</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="SettingsAware">class <strong>SettingsAware</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%">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>settings</strong> = <ranger.ext.openstruct.OpenStruct object at 0x154e450></dl> + +</td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#55aa55"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> + +<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> +<td width="100%"><strong>ALLOWED_SETTINGS</strong> = ['show_hidden', 'scroll_offset', 'directories_first', 'sort', 'reverse', 'preview_files', 'max_history_size', 'colorscheme', 'collapse_preview', 'auto_load_preview', 'max_dirsize_for_autopreview', 'apps', 'keys']</td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/sys.html b/doc/sys.html new file mode 100644 index 00000000..b3de7023 --- /dev/null +++ b/doc/sys.html @@ -0,0 +1,244 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: built-in module sys</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>sys</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br>(built-in)<br><a href="http://docs.python.org/library/sys">Module Docs</a></font></td></tr></table> + <p><tt>This module provides access to some objects used or maintained by the<br> +interpreter and to functions that interact strongly with the interpreter.<br> + <br> +Dynamic objects:<br> + <br> +argv -- command line arguments; argv[0] is the script pathname if known<br> +path -- module search path; path[0] is the script directory, else ''<br> +modules -- dictionary of loaded modules<br> + <br> +displayhook -- called to show results in an interactive session<br> +excepthook -- called to handle any uncaught exception other than SystemExit<br> + To customize printing in an interactive session or to install a custom<br> + top-level exception handler, assign other functions to replace these.<br> + <br> +stdin -- standard input file object; used by input()<br> +stdout -- standard output file object; used by print()<br> +stderr -- standard error object; used for error messages<br> + By assigning other file objects (or objects that behave like files)<br> + to these, it is possible to redirect all of the interpreter's I/O.<br> + <br> +last_type -- type of last uncaught exception<br> +last_value -- value of last uncaught exception<br> +last_traceback -- traceback of last uncaught exception<br> + These three are only available in an interactive session after a<br> + traceback has been printed.<br> + <br> +Static objects:<br> + <br> +float_info -- a dict with information about the float implementation.<br> +int_info -- a struct sequence with information about the int implementation.<br> +maxsize -- the largest supported length of containers.<br> +maxunicode -- the largest supported character<br> +builtin_module_names -- tuple of module names built into this interpreter<br> +subversion -- subversion information of the build as tuple<br> +version -- the version of this interpreter as a string<br> +version_info -- version information as a named tuple<br> +hexversion -- version information encoded as a single integer<br> +copyright -- copyright notice pertaining to this interpreter<br> +platform -- platform identifier<br> +executable -- pathname of this Python interpreter<br> +prefix -- prefix used to find the Python library<br> +exec_prefix -- prefix used to find the machine-specific Python library<br> +float_repr_style -- string indicating the style of repr() output for floats<br> +__stdin__ -- the original stdin; don't touch!<br> +__stdout__ -- the original stdout; don't touch!<br> +__stderr__ -- the original stderr; don't touch!<br> +__displayhook__ -- the original displayhook; don't touch!<br> +__excepthook__ -- the original excepthook; don't touch!<br> + <br> +Functions:<br> + <br> +<a href="#-displayhook">displayhook</a>() -- print an object to the screen, and save it in builtins._<br> +<a href="#-excepthook">excepthook</a>() -- print an exception and its traceback to sys.stderr<br> +<a href="#-exc_info">exc_info</a>() -- return thread-safe information about the current exception<br> +<a href="#-exit">exit</a>() -- exit the interpreter by raising SystemExit<br> +<a href="#-getdlopenflags">getdlopenflags</a>() -- returns flags to be used for dlopen() calls<br> +<a href="#-getprofile">getprofile</a>() -- get the global profiling function<br> +<a href="#-getrefcount">getrefcount</a>() -- return the reference count for an object (plus one :-)<br> +<a href="#-getrecursionlimit">getrecursionlimit</a>() -- return the max recursion depth for the interpreter<br> +<a href="#-getsizeof">getsizeof</a>() -- return the size of an object in bytes<br> +<a href="#-gettrace">gettrace</a>() -- get the global debug tracing function<br> +<a href="#-setcheckinterval">setcheckinterval</a>() -- control how often the interpreter checks for events<br> +<a href="#-setdlopenflags">setdlopenflags</a>() -- set the flags to be used for dlopen() calls<br> +<a href="#-setprofile">setprofile</a>() -- set the global profiling function<br> +<a href="#-setrecursionlimit">setrecursionlimit</a>() -- set the max recursion depth for the interpreter<br> +<a href="#-settrace">settrace</a>() -- set the global debug tracing function</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#eeaa77"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> + +<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt><a name="-__displayhook__"><strong>__displayhook__</strong></a> = displayhook(...)</dt><dd><tt><a href="#-displayhook">displayhook</a>(object) -> None<br> + <br> +Print an object to sys.stdout and also save it in builtins.</tt></dd></dl> + <dl><dt><a name="-__excepthook__"><strong>__excepthook__</strong></a> = excepthook(...)</dt><dd><tt><a href="#-excepthook">excepthook</a>(exctype, value, traceback) -> None<br> + <br> +Handle an exception by displaying it with a traceback on sys.stderr.</tt></dd></dl> + <dl><dt><a name="-call_tracing"><strong>call_tracing</strong></a>(...)</dt><dd><tt><a href="#-call_tracing">call_tracing</a>(func, args) -> object<br> + <br> +Call func(*args), while tracing is enabled. The tracing state is<br> +saved, and restored afterwards. This is intended to be called from<br> +a debugger from a checkpoint, to recursively debug some other code.</tt></dd></dl> + <dl><dt><a name="-callstats"><strong>callstats</strong></a>(...)</dt><dd><tt><a href="#-callstats">callstats</a>() -> tuple of integers<br> + <br> +Return a tuple of function call statistics, if CALL_PROFILE was defined<br> +when Python was built. Otherwise, return None.<br> + <br> +When enabled, this function returns detailed, implementation-specific<br> +details about the number of function calls executed. The return value is<br> +a 11-tuple where the entries in the tuple are counts of:<br> +0. all function calls<br> +1. calls to PyFunction_Type objects<br> +2. PyFunction calls that do not create an argument tuple<br> +3. PyFunction calls that do not create an argument tuple<br> + and bypass PyEval_EvalCodeEx()<br> +4. PyMethod calls<br> +5. PyMethod calls on bound methods<br> +6. PyType calls<br> +7. PyCFunction calls<br> +8. generator calls<br> +9. All other calls<br> +10. Number of stack pops performed by call_function()</tt></dd></dl> + <dl><dt><a name="-displayhook"><strong>displayhook</strong></a>(...)</dt><dd><tt><a href="#-displayhook">displayhook</a>(object) -> None<br> + <br> +Print an object to sys.stdout and also save it in builtins.</tt></dd></dl> + <dl><dt><a name="-exc_info"><strong>exc_info</strong></a>(...)</dt><dd><tt><a href="#-exc_info">exc_info</a>() -> (type, value, traceback)<br> + <br> +Return information about the most recent exception caught by an except<br> +clause in the current stack frame or in an older stack frame.</tt></dd></dl> + <dl><dt><a name="-excepthook"><strong>excepthook</strong></a>(...)</dt><dd><tt><a href="#-excepthook">excepthook</a>(exctype, value, traceback) -> None<br> + <br> +Handle an exception by displaying it with a traceback on sys.stderr.</tt></dd></dl> + <dl><dt><a name="-exit"><strong>exit</strong></a>(...)</dt><dd><tt><a href="#-exit">exit</a>([status])<br> + <br> +Exit the interpreter by raising SystemExit(status).<br> +If the status is omitted or None, it defaults to zero (i.e., success).<br> +If the status is numeric, it will be used as the system exit status.<br> +If it is another kind of object, it will be printed and the system<br> +exit status will be one (i.e., failure).</tt></dd></dl> + <dl><dt><a name="-getcheckinterval"><strong>getcheckinterval</strong></a>(...)</dt><dd><tt><a href="#-getcheckinterval">getcheckinterval</a>() -> current check interval; see <a href="#-setcheckinterval">setcheckinterval</a>().</tt></dd></dl> + <dl><dt><a name="-getdefaultencoding"><strong>getdefaultencoding</strong></a>(...)</dt><dd><tt><a href="#-getdefaultencoding">getdefaultencoding</a>() -> string<br> + <br> +Return the current default string encoding used by the Unicode <br> +implementation.</tt></dd></dl> + <dl><dt><a name="-getdlopenflags"><strong>getdlopenflags</strong></a>(...)</dt><dd><tt><a href="#-getdlopenflags">getdlopenflags</a>() -> int<br> + <br> +Return the current value of the flags that are used for dlopen calls.<br> +The flag constants are defined in the ctypes and DLFCN modules.</tt></dd></dl> + <dl><dt><a name="-getfilesystemencoding"><strong>getfilesystemencoding</strong></a>(...)</dt><dd><tt><a href="#-getfilesystemencoding">getfilesystemencoding</a>() -> string<br> + <br> +Return the encoding used to convert Unicode filenames in<br> +operating system filenames.</tt></dd></dl> + <dl><dt><a name="-getprofile"><strong>getprofile</strong></a>(...)</dt><dd><tt><a href="#-getprofile">getprofile</a>()<br> + <br> +Return the profiling function set with sys.setprofile.<br> +See the profiler chapter in the library manual.</tt></dd></dl> + <dl><dt><a name="-getrecursionlimit"><strong>getrecursionlimit</strong></a>(...)</dt><dd><tt><a href="#-getrecursionlimit">getrecursionlimit</a>()<br> + <br> +Return the current value of the recursion limit, the maximum depth<br> +of the Python interpreter stack. This limit prevents infinite<br> +recursion from causing an overflow of the C stack and crashing Python.</tt></dd></dl> + <dl><dt><a name="-getrefcount"><strong>getrefcount</strong></a>(...)</dt><dd><tt><a href="#-getrefcount">getrefcount</a>(object) -> integer<br> + <br> +Return the reference count of object. The count returned is generally<br> +one higher than you might expect, because it includes the (temporary)<br> +reference as an argument to <a href="#-getrefcount">getrefcount</a>().</tt></dd></dl> + <dl><dt><a name="-getsizeof"><strong>getsizeof</strong></a>(...)</dt><dd><tt><a href="#-getsizeof">getsizeof</a>(object, default) -> int<br> + <br> +Return the size of object in bytes.</tt></dd></dl> + <dl><dt><a name="-gettrace"><strong>gettrace</strong></a>(...)</dt><dd><tt><a href="#-gettrace">gettrace</a>()<br> + <br> +Return the global debug tracing function set with sys.settrace.<br> +See the debugger chapter in the library manual.</tt></dd></dl> + <dl><dt><a name="-intern"><strong>intern</strong></a>(...)</dt><dd><tt><a href="#-intern">intern</a>(string) -> string<br> + <br> +``Intern'' the given string. This enters the string in the (global)<br> +table of interned strings whose purpose is to speed up dictionary lookups.<br> +Return the string itself or the previously interned string object with the<br> +same value.</tt></dd></dl> + <dl><dt><a name="-setcheckinterval"><strong>setcheckinterval</strong></a>(...)</dt><dd><tt><a href="#-setcheckinterval">setcheckinterval</a>(n)<br> + <br> +Tell the Python interpreter to check for asynchronous events every<br> +n instructions. This also affects how often thread switches occur.</tt></dd></dl> + <dl><dt><a name="-setdlopenflags"><strong>setdlopenflags</strong></a>(...)</dt><dd><tt><a href="#-setdlopenflags">setdlopenflags</a>(n) -> None<br> + <br> +Set the flags used by the interpreter for dlopen calls, such as when the<br> +interpreter loads extension modules. Among other things, this will enable<br> +a lazy resolving of symbols when importing a module, if called as<br> +sys.<a href="#-setdlopenflags">setdlopenflags</a>(0). To share symbols across extension modules, call as<br> +sys.<a href="#-setdlopenflags">setdlopenflags</a>(ctypes.RTLD_GLOBAL). Symbolic names for the flag modules<br> +can be either found in the ctypes module, or in the DLFCN module. If DLFCN<br> +is not available, it can be generated from /usr/include/dlfcn.h using the<br> +h2py script.</tt></dd></dl> + <dl><dt><a name="-setfilesystemencoding"><strong>setfilesystemencoding</strong></a>(...)</dt><dd><tt><a href="#-setfilesystemencoding">setfilesystemencoding</a>(string) -> None<br> + <br> +Set the encoding used to convert Unicode filenames in<br> +operating system filenames.</tt></dd></dl> + <dl><dt><a name="-setprofile"><strong>setprofile</strong></a>(...)</dt><dd><tt><a href="#-setprofile">setprofile</a>(function)<br> + <br> +Set the profiling function. It will be called on each function call<br> +and return. See the profiler chapter in the library manual.</tt></dd></dl> + <dl><dt><a name="-setrecursionlimit"><strong>setrecursionlimit</strong></a>(...)</dt><dd><tt><a href="#-setrecursionlimit">setrecursionlimit</a>(n)<br> + <br> +Set the maximum depth of the Python interpreter stack to n. This<br> +limit prevents infinite recursion from causing an overflow of the C<br> +stack and crashing Python. The highest possible limit is platform-<br> +dependent.</tt></dd></dl> + <dl><dt><a name="-settrace"><strong>settrace</strong></a>(...)</dt><dd><tt><a href="#-settrace">settrace</a>(function)<br> + <br> +Set the global debug tracing function. It will be called on each<br> +function call. See the debugger chapter in the library manual.</tt></dd></dl> +</td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#55aa55"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> + +<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> +<td width="100%"><strong>__stderr__</strong> = <_io.TextIOWrapper name='<stderr>' encoding='UTF-8'><br> +<strong>__stdin__</strong> = <_io.TextIOWrapper name='<stdin>' encoding='UTF-8'><br> +<strong>__stdout__</strong> = <_io.TextIOWrapper name='<stdout>' encoding='UTF-8'><br> +<strong>api_version</strong> = 1013<br> +<strong>argv</strong> = ['./make_doc.py']<br> +<strong>builtin_module_names</strong> = ('__main__', '_ast', '_codecs', '_functools', '_io', '_locale', '_sre', '_symtable', '_thread', '_warnings', '_weakref', 'builtins', 'errno', 'gc', 'imp', 'marshal', 'posix', 'pwd', 'signal', 'sys', ...)<br> +<strong>byteorder</strong> = 'little'<br> +<strong>copyright</strong> = 'Copyright (c) 2001-2009 Python Software Foundati...ematisch Centrum, Amsterdam.<font color="#c040c0">\n</font>All Rights Reserved.'<br> +<strong>dont_write_bytecode</strong> = False<br> +<strong>exec_prefix</strong> = '/usr'<br> +<strong>executable</strong> = '/usr/bin/python3'<br> +<strong>flags</strong> = sys.flags(debug=0, division_warning=0, inspect=0...ignore_environment=0, verbose=0, bytes_warning=0)<br> +<strong>float_info</strong> = sys.floatinfo(max=1.7976931348623157e+308, max_e...epsilon=2.220446049250313e-16, radix=2, rounds=1)<br> +<strong>float_repr_style</strong> = 'short'<br> +<strong>hexversion</strong> = 50397680<br> +<strong>int_info</strong> = sys.int_info(bits_per_digit=30, sizeof_digit=4)<br> +<strong>maxsize</strong> = 9223372036854775807<br> +<strong>maxunicode</strong> = 1114111<br> +<strong>meta_path</strong> = []<br> +<strong>modules</strong> = {'__future__': <module '__future__' from '/usr/lib/python3.1/__future__.py'>, '__init__': <module '__init__' from '/home/hut/.ranger/__init__.py'>, '__main__': <module '__main__' from './make_doc.py'>, '_abcoll': <module '_abcoll' from '/usr/lib/python3.1/_abcoll.py'>, '_bisect': <module '_bisect' from '/usr/lib/python3.1/lib-dynload/_bisect.so'>, '_codecs': <module '_codecs' (built-in)>, '_collections': <module '_collections' from '/usr/lib/python3.1/lib-dynload/_collections.so'>, '_curses': <module '_curses' from '/usr/lib/python3.1/lib-dynload/_curses.so'>, '_functools': <module '_functools' (built-in)>, '_heapq': <module '_heapq' from '/usr/lib/python3.1/lib-dynload/_heapq.so'>, ...}<br> +<strong>path</strong> = ['/home/hut/.ranger', '/home/hut/work/ranger', '/usr/lib/python31.zip', '/usr/lib/python3.1', '/usr/lib/python3.1/plat-linux2', '/usr/lib/python3.1/lib-dynload', '/usr/lib/python3.1/site-packages', '/home/hut/.ranger']<br> +<strong>path_hooks</strong> = [<class 'zipimport.zipimporter'>]<br> +<strong>path_importer_cache</strong> = {'.': None, './make_doc.py': <imp.NullImporter object at 0x7f327d9e39f0>, '/home/hut/.ranger': None, '/home/hut/.ranger/colorschemes': None, '/home/hut/work/ranger': None, '/home/hut/work/ranger/ranger': None, '/home/hut/work/ranger/ranger/colorschemes': None, '/home/hut/work/ranger/ranger/container': None, '/home/hut/work/ranger/ranger/defaults': None, '/home/hut/work/ranger/ranger/ext': None, ...}<br> +<strong>platform</strong> = 'linux2'<br> +<strong>prefix</strong> = '/usr'<br> +<strong>stderr</strong> = <_io.TextIOWrapper name='<stderr>' encoding='UTF-8'><br> +<strong>stdin</strong> = <_io.TextIOWrapper name='<stdin>' encoding='UTF-8'><br> +<strong>stdout</strong> = <_io.TextIOWrapper name='<stdout>' encoding='UTF-8'><br> +<strong>subversion</strong> = ('CPython', 'tags/r311', '74480')<br> +<strong>version</strong> = '3.1.1 (r311:74480, Aug 27 2009, 04:56:37) <font color="#c040c0">\n</font>[GCC 4.4.1]'<br> +<strong>version_info</strong> = sys.version_info(major=3, minor=1, micro=1, releaselevel='final', serial=0)<br> +<strong>warnoptions</strong> = []</td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/test.html b/doc/test.html new file mode 100644 index 00000000..5d239e76 --- /dev/null +++ b/doc/test.html @@ -0,0 +1,34 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: package test</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>test</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/test/__init__.py">/home/hut/work/ranger/test/__init__.py</a></font></td></tr></table> + <p></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<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="test.tc_colorscheme.html">tc_colorscheme</a><br> +<a href="test.tc_directory.html">tc_directory</a><br> +</td><td width="25%" valign=top><a href="test.tc_displayable.html">tc_displayable</a><br> +<a href="test.tc_history.html">tc_history</a><br> +</td><td width="25%" valign=top><a href="test.tc_ui.html">tc_ui</a><br> +<a href="test.test.html">test</a><br> +</td><td width="25%" valign=top></td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#55aa55"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> + +<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> +<td width="100%"><strong>__all__</strong> = ['tc_history', 'tc_directory', 'tc_ui', 'tc_history', 'tc_ui', 'tc_displayable', 'tc_colorscheme', 'tc_directory', 'tc_colorscheme', 'tc_displayable']</td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/test.tc_colorscheme.html b/doc/test.tc_colorscheme.html new file mode 100644 index 00000000..fbd73399 --- /dev/null +++ b/doc/test.tc_colorscheme.html @@ -0,0 +1,298 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module test.tc_colorscheme</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="test.html"><font color="#ffffff">test</font></a>.tc_colorscheme</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/test/tc_colorscheme.py">/home/hut/work/ranger/test/tc_colorscheme.py</a></font></td></tr></table> + <p></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</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="random.html">random</a><br> +</td><td width="25%" valign=top><a href="ranger.html">ranger</a><br> +</td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><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="unittest.html#TestCase">unittest.TestCase</a>(<a href="builtins.html#object">builtins.object</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="test.tc_colorscheme.html#Test">Test</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="Test">class <strong>Test</strong></a>(<a href="unittest.html#TestCase">unittest.TestCase</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="test.tc_colorscheme.html#Test">Test</a></dd> +<dd><a href="unittest.html#TestCase">unittest.TestCase</a></dd> +<dd><a href="builtins.html#object">builtins.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="Test-setUp"><strong>setUp</strong></a>(self)</dt></dl> + +<dl><dt><a name="Test-test_colorschemes"><strong>test_colorschemes</strong></a>(self)</dt></dl> + +<hr> +Methods inherited from <a href="unittest.html#TestCase">unittest.TestCase</a>:<br> +<dl><dt><a name="Test-__call__"><strong>__call__</strong></a>(self, *args, **kwds)</dt></dl> + +<dl><dt><a name="Test-__eq__"><strong>__eq__</strong></a>(self, other)</dt></dl> + +<dl><dt><a name="Test-__hash__"><strong>__hash__</strong></a>(self)</dt></dl> + +<dl><dt><a name="Test-__init__"><strong>__init__</strong></a>(self, methodName<font color="#909090">='runTest'</font>)</dt><dd><tt>Create an instance of the class that will use the named test<br> +method when executed. Raises a ValueError if the instance does<br> +not have a method with the specified name.</tt></dd></dl> + +<dl><dt><a name="Test-__ne__"><strong>__ne__</strong></a>(self, other)</dt></dl> + +<dl><dt><a name="Test-__repr__"><strong>__repr__</strong></a>(self)</dt></dl> + +<dl><dt><a name="Test-__str__"><strong>__str__</strong></a>(self)</dt></dl> + +<dl><dt><a name="Test-addCleanup"><strong>addCleanup</strong></a>(self, function, *args, **kwargs)</dt><dd><tt>Add a function, with arguments, to be called when the test is<br> +completed. Functions added are called on a LIFO basis and are<br> +called after tearDown on test failure or success.<br> + <br> +Cleanup items are called even if setUp fails (unlike tearDown).</tt></dd></dl> + +<dl><dt><a name="Test-addTypeEqualityFunc"><strong>addTypeEqualityFunc</strong></a>(self, typeobj, function)</dt><dd><tt>Add a type specific assertEqual style function to compare a type.<br> + <br> +This method is for use by <a href="unittest.html#TestCase">TestCase</a> subclasses that need to register<br> +their own type equality functions to provide nicer error messages.<br> + <br> +Args:<br> + typeobj: The data type to call this function on when both values<br> + are of the same type in <a href="#Test-assertEqual">assertEqual</a>().<br> + function: The callable taking two arguments and an optional<br> + msg= argument that raises self.<strong>failureException</strong> with a<br> + useful error message when the two arguments are not equal.</tt></dd></dl> + +<dl><dt><a name="Test-assertAlmostEqual"><strong>assertAlmostEqual</strong></a>(self, first, second, *, places<font color="#909090">=7</font>, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are unequal as determined by their<br> +difference rounded to the given number of decimal places<br> +(default 7) and comparing to zero.<br> + <br> +Note that decimal places (from zero) are usually not the same<br> +as significant digits (measured from the most signficant digit).</tt></dd></dl> + +<dl><dt><a name="Test-assertAlmostEquals"><strong>assertAlmostEquals</strong></a> = assertAlmostEqual(self, first, second, *, places<font color="#909090">=7</font>, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are unequal as determined by their<br> +difference rounded to the given number of decimal places<br> +(default 7) and comparing to zero.<br> + <br> +Note that decimal places (from zero) are usually not the same<br> +as significant digits (measured from the most signficant digit).</tt></dd></dl> + +<dl><dt><a name="Test-assertDictContainsSubset"><strong>assertDictContainsSubset</strong></a>(self, expected, actual, msg<font color="#909090">=None</font>)</dt><dd><tt>Checks whether actual is a superset of expected.</tt></dd></dl> + +<dl><dt><a name="Test-assertDictEqual"><strong>assertDictEqual</strong></a>(self, d1, d2, msg<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="Test-assertEqual"><strong>assertEqual</strong></a>(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are unequal as determined by the '=='<br> +operator.</tt></dd></dl> + +<dl><dt><a name="Test-assertEquals"><strong>assertEquals</strong></a> = assertEqual(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are unequal as determined by the '=='<br> +operator.</tt></dd></dl> + +<dl><dt><a name="Test-assertFalse"><strong>assertFalse</strong></a>(self, expr, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail the test if the expression is true.</tt></dd></dl> + +<dl><dt><a name="Test-assertGreater"><strong>assertGreater</strong></a>(self, a, b, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#Test-assertTrue">assertTrue</a>(a > b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="Test-assertGreaterEqual"><strong>assertGreaterEqual</strong></a>(self, a, b, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#Test-assertTrue">assertTrue</a>(a >= b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="Test-assertIn"><strong>assertIn</strong></a>(self, member, container, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#Test-assertTrue">assertTrue</a>(a in b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="Test-assertIs"><strong>assertIs</strong></a>(self, expr1, expr2, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#Test-assertTrue">assertTrue</a>(a is b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="Test-assertIsNone"><strong>assertIsNone</strong></a>(self, obj, msg<font color="#909090">=None</font>)</dt><dd><tt>Same as <a href="#Test-assertTrue">assertTrue</a>(obj is None), with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="Test-assertIsNot"><strong>assertIsNot</strong></a>(self, expr1, expr2, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#Test-assertTrue">assertTrue</a>(a is not b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="Test-assertIsNotNone"><strong>assertIsNotNone</strong></a>(self, obj, msg<font color="#909090">=None</font>)</dt><dd><tt>Included for symmetry with assertIsNone.</tt></dd></dl> + +<dl><dt><a name="Test-assertLess"><strong>assertLess</strong></a>(self, a, b, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#Test-assertTrue">assertTrue</a>(a < b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="Test-assertLessEqual"><strong>assertLessEqual</strong></a>(self, a, b, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#Test-assertTrue">assertTrue</a>(a <= b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="Test-assertListEqual"><strong>assertListEqual</strong></a>(self, list1, list2, msg<font color="#909090">=None</font>)</dt><dd><tt>A list-specific equality assertion.<br> + <br> +Args:<br> + list1: The first list to compare.<br> + list2: The second list to compare.<br> + msg: Optional message to use on failure instead of a list of<br> + differences.</tt></dd></dl> + +<dl><dt><a name="Test-assertMultiLineEqual"><strong>assertMultiLineEqual</strong></a>(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Assert that two multi-line strings are equal.</tt></dd></dl> + +<dl><dt><a name="Test-assertNotAlmostEqual"><strong>assertNotAlmostEqual</strong></a>(self, first, second, *, places<font color="#909090">=7</font>, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are equal as determined by their<br> +difference rounded to the given number of decimal places<br> +(default 7) and comparing to zero.<br> + <br> +Note that decimal places (from zero) are usually not the same<br> +as significant digits (measured from the most signficant digit).</tt></dd></dl> + +<dl><dt><a name="Test-assertNotAlmostEquals"><strong>assertNotAlmostEquals</strong></a> = assertNotAlmostEqual(self, first, second, *, places<font color="#909090">=7</font>, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are equal as determined by their<br> +difference rounded to the given number of decimal places<br> +(default 7) and comparing to zero.<br> + <br> +Note that decimal places (from zero) are usually not the same<br> +as significant digits (measured from the most signficant digit).</tt></dd></dl> + +<dl><dt><a name="Test-assertNotEqual"><strong>assertNotEqual</strong></a>(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are equal as determined by the '=='<br> +operator.</tt></dd></dl> + +<dl><dt><a name="Test-assertNotEquals"><strong>assertNotEquals</strong></a> = assertNotEqual(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are equal as determined by the '=='<br> +operator.</tt></dd></dl> + +<dl><dt><a name="Test-assertNotIn"><strong>assertNotIn</strong></a>(self, member, container, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#Test-assertTrue">assertTrue</a>(a not in b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="Test-assertRaises"><strong>assertRaises</strong></a>(self, excClass, callableObj<font color="#909090">=None</font>, *args, **kwargs)</dt><dd><tt>Fail unless an exception of class excClass is thrown<br> +by callableObj when invoked with arguments args and keyword<br> +arguments kwargs. If a different type of exception is<br> +thrown, it will not be caught, and the test case will be<br> +deemed to have suffered an error, exactly as for an<br> +unexpected exception.<br> + <br> +If called with callableObj omitted or None, will return a<br> +context object used like this::<br> + <br> + with <a href="#Test-assertRaises">assertRaises</a>(some_error_class):<br> + do_something()</tt></dd></dl> + +<dl><dt><a name="Test-assertRaisesRegexp"><strong>assertRaisesRegexp</strong></a>(self, expected_exception, expected_regexp, callable_obj<font color="#909090">=None</font>, *args, **kwargs)</dt><dd><tt>Asserts that the message in a raised exception matches a regexp.<br> + <br> +Args:<br> + expected_exception: Exception class expected to be raised.<br> + expected_regexp: Regexp (re pattern object or string) expected<br> + to be found in error message.<br> + callable_obj: Function to be called.<br> + args: Extra args.<br> + kwargs: Extra kwargs.</tt></dd></dl> + +<dl><dt><a name="Test-assertRegexpMatches"><strong>assertRegexpMatches</strong></a>(self, text, expected_regex, msg<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="Test-assertSameElements"><strong>assertSameElements</strong></a>(self, expected_seq, actual_seq, msg<font color="#909090">=None</font>)</dt><dd><tt>An unordered sequence specific comparison.<br> + <br> +Raises with an error message listing which elements of expected_seq<br> +are missing from actual_seq and vice versa if any.</tt></dd></dl> + +<dl><dt><a name="Test-assertSequenceEqual"><strong>assertSequenceEqual</strong></a>(self, seq1, seq2, msg<font color="#909090">=None</font>, seq_type<font color="#909090">=None</font>)</dt><dd><tt>An equality assertion for ordered sequences (like lists and tuples).<br> + <br> +For the purposes of this function, a valid orderd sequence type is one<br> +which can be indexed, has a length, and has an equality operator.<br> + <br> +Args:<br> + seq1: The first sequence to compare.<br> + seq2: The second sequence to compare.<br> + seq_type: The expected datatype of the sequences, or None if no<br> + datatype should be enforced.<br> + msg: Optional message to use on failure instead of a list of<br> + differences.</tt></dd></dl> + +<dl><dt><a name="Test-assertSetEqual"><strong>assertSetEqual</strong></a>(self, set1, set2, msg<font color="#909090">=None</font>)</dt><dd><tt>A set-specific equality assertion.<br> + <br> +Args:<br> + set1: The first set to compare.<br> + set2: The second set to compare.<br> + msg: Optional message to use on failure instead of a list of<br> + differences.<br> + <br> +For more general containership equality, assertSameElements will work<br> +with things other than sets. This uses ducktyping to support<br> +different types of sets, and is optimized for sets specifically<br> +(parameters must support a difference method).</tt></dd></dl> + +<dl><dt><a name="Test-assertTrue"><strong>assertTrue</strong></a>(self, expr, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail the test unless the expression is true.</tt></dd></dl> + +<dl><dt><a name="Test-assertTupleEqual"><strong>assertTupleEqual</strong></a>(self, tuple1, tuple2, msg<font color="#909090">=None</font>)</dt><dd><tt>A tuple-specific equality assertion.<br> + <br> +Args:<br> + tuple1: The first tuple to compare.<br> + tuple2: The second tuple to compare.<br> + msg: Optional message to use on failure instead of a list of<br> + differences.</tt></dd></dl> + +<dl><dt><a name="Test-assert_"><strong>assert_</strong></a> = assertTrue(self, expr, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail the test unless the expression is true.</tt></dd></dl> + +<dl><dt><a name="Test-countTestCases"><strong>countTestCases</strong></a>(self)</dt></dl> + +<dl><dt><a name="Test-debug"><strong>debug</strong></a>(self)</dt><dd><tt>Run the test without collecting errors in a TestResult</tt></dd></dl> + +<dl><dt><a name="Test-defaultTestResult"><strong>defaultTestResult</strong></a>(self)</dt></dl> + +<dl><dt><a name="Test-doCleanups"><strong>doCleanups</strong></a>(self)</dt><dd><tt>Execute all cleanup functions. Normally called for you after<br> +tearDown.</tt></dd></dl> + +<dl><dt><a name="Test-fail"><strong>fail</strong></a>(self, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail immediately, with the given message.</tt></dd></dl> + +<dl><dt><a name="Test-failIf"><strong>failIf</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="Test-failIfAlmostEqual"><strong>failIfAlmostEqual</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="Test-failIfEqual"><strong>failIfEqual</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="Test-failUnless"><strong>failUnless</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="Test-failUnlessAlmostEqual"><strong>failUnlessAlmostEqual</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="Test-failUnlessEqual"><strong>failUnlessEqual</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="Test-failUnlessRaises"><strong>failUnlessRaises</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="Test-id"><strong>id</strong></a>(self)</dt></dl> + +<dl><dt><a name="Test-run"><strong>run</strong></a>(self, result<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="Test-shortDescription"><strong>shortDescription</strong></a>(self)</dt><dd><tt>Returns both the test method name and first line of its docstring.<br> + <br> +If no docstring is given, only returns the method name.<br> + <br> +This method overrides unittest.<a href="unittest.html#TestCase">TestCase</a>.<a href="#Test-shortDescription">shortDescription</a>(), which<br> +only returns the first line of the docstring, obscuring the name<br> +of the test upon failure.</tt></dd></dl> + +<dl><dt><a name="Test-skipTest"><strong>skipTest</strong></a>(self, reason)</dt><dd><tt>Skip this test.</tt></dd></dl> + +<dl><dt><a name="Test-tearDown"><strong>tearDown</strong></a>(self)</dt><dd><tt>Hook method for deconstructing the test fixture after testing it.</tt></dd></dl> + +<hr> +Data descriptors inherited from <a href="unittest.html#TestCase">unittest.TestCase</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="unittest.html#TestCase">unittest.TestCase</a>:<br> +<dl><dt><strong>failureException</strong> = <class 'AssertionError'><dd><tt>Assertion failed.</tt></dl> + +<dl><dt><strong>longMessage</strong> = False</dl> + +</td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#55aa55"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> + +<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> +<td width="100%"><strong>CONTEXT_KEYS</strong> = ['reset', 'error', 'in_display', 'in_statusbar', 'in_titlebar', 'in_console', 'in_notify', 'in_pman', 'directory', 'file', 'hostname', 'executable', 'media', 'link', 'video', 'audio', 'image', 'media', 'document', 'container', ...]</td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/test.tc_directory.html b/doc/test.tc_directory.html new file mode 100644 index 00000000..0c6fe0b1 --- /dev/null +++ b/doc/test.tc_directory.html @@ -0,0 +1,306 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module test.tc_directory</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="test.html"><font color="#ffffff">test</font></a>.tc_directory</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/test/tc_directory.py">/home/hut/work/ranger/test/tc_directory.py</a></font></td></tr></table> + <p></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</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.fsobject.html">ranger.fsobject</a><br> +</td><td width="25%" valign=top><a href="unittest.html">unittest</a><br> +</td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><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="unittest.html#TestCase">unittest.TestCase</a>(<a href="builtins.html#object">builtins.object</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="test.tc_directory.html#Test1">Test1</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="Test1">class <strong>Test1</strong></a>(<a href="unittest.html#TestCase">unittest.TestCase</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="test.tc_directory.html#Test1">Test1</a></dd> +<dd><a href="unittest.html#TestCase">unittest.TestCase</a></dd> +<dd><a href="builtins.html#object">builtins.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="Test1-test_after_content_loaded"><strong>test_after_content_loaded</strong></a>(self)</dt></dl> + +<dl><dt><a name="Test1-test_initial_condition"><strong>test_initial_condition</strong></a>(self)</dt></dl> + +<dl><dt><a name="Test1-test_load_if_outdated"><strong>test_load_if_outdated</strong></a>(self)</dt></dl> + +<dl><dt><a name="Test1-test_nonexistant_dir"><strong>test_nonexistant_dir</strong></a>(self)</dt></dl> + +<hr> +Methods inherited from <a href="unittest.html#TestCase">unittest.TestCase</a>:<br> +<dl><dt><a name="Test1-__call__"><strong>__call__</strong></a>(self, *args, **kwds)</dt></dl> + +<dl><dt><a name="Test1-__eq__"><strong>__eq__</strong></a>(self, other)</dt></dl> + +<dl><dt><a name="Test1-__hash__"><strong>__hash__</strong></a>(self)</dt></dl> + +<dl><dt><a name="Test1-__init__"><strong>__init__</strong></a>(self, methodName<font color="#909090">='runTest'</font>)</dt><dd><tt>Create an instance of the class that will use the named test<br> +method when executed. Raises a ValueError if the instance does<br> +not have a method with the specified name.</tt></dd></dl> + +<dl><dt><a name="Test1-__ne__"><strong>__ne__</strong></a>(self, other)</dt></dl> + +<dl><dt><a name="Test1-__repr__"><strong>__repr__</strong></a>(self)</dt></dl> + +<dl><dt><a name="Test1-__str__"><strong>__str__</strong></a>(self)</dt></dl> + +<dl><dt><a name="Test1-addCleanup"><strong>addCleanup</strong></a>(self, function, *args, **kwargs)</dt><dd><tt>Add a function, with arguments, to be called when the test is<br> +completed. Functions added are called on a LIFO basis and are<br> +called after tearDown on test failure or success.<br> + <br> +Cleanup items are called even if setUp fails (unlike tearDown).</tt></dd></dl> + +<dl><dt><a name="Test1-addTypeEqualityFunc"><strong>addTypeEqualityFunc</strong></a>(self, typeobj, function)</dt><dd><tt>Add a type specific assertEqual style function to compare a type.<br> + <br> +This method is for use by <a href="unittest.html#TestCase">TestCase</a> subclasses that need to register<br> +their own type equality functions to provide nicer error messages.<br> + <br> +Args:<br> + typeobj: The data type to call this function on when both values<br> + are of the same type in <a href="#Test1-assertEqual">assertEqual</a>().<br> + function: The callable taking two arguments and an optional<br> + msg= argument that raises self.<strong>failureException</strong> with a<br> + useful error message when the two arguments are not equal.</tt></dd></dl> + +<dl><dt><a name="Test1-assertAlmostEqual"><strong>assertAlmostEqual</strong></a>(self, first, second, *, places<font color="#909090">=7</font>, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are unequal as determined by their<br> +difference rounded to the given number of decimal places<br> +(default 7) and comparing to zero.<br> + <br> +Note that decimal places (from zero) are usually not the same<br> +as significant digits (measured from the most signficant digit).</tt></dd></dl> + +<dl><dt><a name="Test1-assertAlmostEquals"><strong>assertAlmostEquals</strong></a> = assertAlmostEqual(self, first, second, *, places<font color="#909090">=7</font>, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are unequal as determined by their<br> +difference rounded to the given number of decimal places<br> +(default 7) and comparing to zero.<br> + <br> +Note that decimal places (from zero) are usually not the same<br> +as significant digits (measured from the most signficant digit).</tt></dd></dl> + +<dl><dt><a name="Test1-assertDictContainsSubset"><strong>assertDictContainsSubset</strong></a>(self, expected, actual, msg<font color="#909090">=None</font>)</dt><dd><tt>Checks whether actual is a superset of expected.</tt></dd></dl> + +<dl><dt><a name="Test1-assertDictEqual"><strong>assertDictEqual</strong></a>(self, d1, d2, msg<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="Test1-assertEqual"><strong>assertEqual</strong></a>(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are unequal as determined by the '=='<br> +operator.</tt></dd></dl> + +<dl><dt><a name="Test1-assertEquals"><strong>assertEquals</strong></a> = assertEqual(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are unequal as determined by the '=='<br> +operator.</tt></dd></dl> + +<dl><dt><a name="Test1-assertFalse"><strong>assertFalse</strong></a>(self, expr, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail the test if the expression is true.</tt></dd></dl> + +<dl><dt><a name="Test1-assertGreater"><strong>assertGreater</strong></a>(self, a, b, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#Test1-assertTrue">assertTrue</a>(a > b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="Test1-assertGreaterEqual"><strong>assertGreaterEqual</strong></a>(self, a, b, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#Test1-assertTrue">assertTrue</a>(a >= b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="Test1-assertIn"><strong>assertIn</strong></a>(self, member, container, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#Test1-assertTrue">assertTrue</a>(a in b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="Test1-assertIs"><strong>assertIs</strong></a>(self, expr1, expr2, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#Test1-assertTrue">assertTrue</a>(a is b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="Test1-assertIsNone"><strong>assertIsNone</strong></a>(self, obj, msg<font color="#909090">=None</font>)</dt><dd><tt>Same as <a href="#Test1-assertTrue">assertTrue</a>(obj is None), with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="Test1-assertIsNot"><strong>assertIsNot</strong></a>(self, expr1, expr2, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#Test1-assertTrue">assertTrue</a>(a is not b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="Test1-assertIsNotNone"><strong>assertIsNotNone</strong></a>(self, obj, msg<font color="#909090">=None</font>)</dt><dd><tt>Included for symmetry with assertIsNone.</tt></dd></dl> + +<dl><dt><a name="Test1-assertLess"><strong>assertLess</strong></a>(self, a, b, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#Test1-assertTrue">assertTrue</a>(a < b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="Test1-assertLessEqual"><strong>assertLessEqual</strong></a>(self, a, b, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#Test1-assertTrue">assertTrue</a>(a <= b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="Test1-assertListEqual"><strong>assertListEqual</strong></a>(self, list1, list2, msg<font color="#909090">=None</font>)</dt><dd><tt>A list-specific equality assertion.<br> + <br> +Args:<br> + list1: The first list to compare.<br> + list2: The second list to compare.<br> + msg: Optional message to use on failure instead of a list of<br> + differences.</tt></dd></dl> + +<dl><dt><a name="Test1-assertMultiLineEqual"><strong>assertMultiLineEqual</strong></a>(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Assert that two multi-line strings are equal.</tt></dd></dl> + +<dl><dt><a name="Test1-assertNotAlmostEqual"><strong>assertNotAlmostEqual</strong></a>(self, first, second, *, places<font color="#909090">=7</font>, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are equal as determined by their<br> +difference rounded to the given number of decimal places<br> +(default 7) and comparing to zero.<br> + <br> +Note that decimal places (from zero) are usually not the same<br> +as significant digits (measured from the most signficant digit).</tt></dd></dl> + +<dl><dt><a name="Test1-assertNotAlmostEquals"><strong>assertNotAlmostEquals</strong></a> = assertNotAlmostEqual(self, first, second, *, places<font color="#909090">=7</font>, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are equal as determined by their<br> +difference rounded to the given number of decimal places<br> +(default 7) and comparing to zero.<br> + <br> +Note that decimal places (from zero) are usually not the same<br> +as significant digits (measured from the most signficant digit).</tt></dd></dl> + +<dl><dt><a name="Test1-assertNotEqual"><strong>assertNotEqual</strong></a>(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are equal as determined by the '=='<br> +operator.</tt></dd></dl> + +<dl><dt><a name="Test1-assertNotEquals"><strong>assertNotEquals</strong></a> = assertNotEqual(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are equal as determined by the '=='<br> +operator.</tt></dd></dl> + +<dl><dt><a name="Test1-assertNotIn"><strong>assertNotIn</strong></a>(self, member, container, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#Test1-assertTrue">assertTrue</a>(a not in b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="Test1-assertRaises"><strong>assertRaises</strong></a>(self, excClass, callableObj<font color="#909090">=None</font>, *args, **kwargs)</dt><dd><tt>Fail unless an exception of class excClass is thrown<br> +by callableObj when invoked with arguments args and keyword<br> +arguments kwargs. If a different type of exception is<br> +thrown, it will not be caught, and the test case will be<br> +deemed to have suffered an error, exactly as for an<br> +unexpected exception.<br> + <br> +If called with callableObj omitted or None, will return a<br> +context object used like this::<br> + <br> + with <a href="#Test1-assertRaises">assertRaises</a>(some_error_class):<br> + do_something()</tt></dd></dl> + +<dl><dt><a name="Test1-assertRaisesRegexp"><strong>assertRaisesRegexp</strong></a>(self, expected_exception, expected_regexp, callable_obj<font color="#909090">=None</font>, *args, **kwargs)</dt><dd><tt>Asserts that the message in a raised exception matches a regexp.<br> + <br> +Args:<br> + expected_exception: Exception class expected to be raised.<br> + expected_regexp: Regexp (re pattern object or string) expected<br> + to be found in error message.<br> + callable_obj: Function to be called.<br> + args: Extra args.<br> + kwargs: Extra kwargs.</tt></dd></dl> + +<dl><dt><a name="Test1-assertRegexpMatches"><strong>assertRegexpMatches</strong></a>(self, text, expected_regex, msg<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="Test1-assertSameElements"><strong>assertSameElements</strong></a>(self, expected_seq, actual_seq, msg<font color="#909090">=None</font>)</dt><dd><tt>An unordered sequence specific comparison.<br> + <br> +Raises with an error message listing which elements of expected_seq<br> +are missing from actual_seq and vice versa if any.</tt></dd></dl> + +<dl><dt><a name="Test1-assertSequenceEqual"><strong>assertSequenceEqual</strong></a>(self, seq1, seq2, msg<font color="#909090">=None</font>, seq_type<font color="#909090">=None</font>)</dt><dd><tt>An equality assertion for ordered sequences (like lists and tuples).<br> + <br> +For the purposes of this function, a valid orderd sequence type is one<br> +which can be indexed, has a length, and has an equality operator.<br> + <br> +Args:<br> + seq1: The first sequence to compare.<br> + seq2: The second sequence to compare.<br> + seq_type: The expected datatype of the sequences, or None if no<br> + datatype should be enforced.<br> + msg: Optional message to use on failure instead of a list of<br> + differences.</tt></dd></dl> + +<dl><dt><a name="Test1-assertSetEqual"><strong>assertSetEqual</strong></a>(self, set1, set2, msg<font color="#909090">=None</font>)</dt><dd><tt>A set-specific equality assertion.<br> + <br> +Args:<br> + set1: The first set to compare.<br> + set2: The second set to compare.<br> + msg: Optional message to use on failure instead of a list of<br> + differences.<br> + <br> +For more general containership equality, assertSameElements will work<br> +with things other than sets. This uses ducktyping to support<br> +different types of sets, and is optimized for sets specifically<br> +(parameters must support a difference method).</tt></dd></dl> + +<dl><dt><a name="Test1-assertTrue"><strong>assertTrue</strong></a>(self, expr, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail the test unless the expression is true.</tt></dd></dl> + +<dl><dt><a name="Test1-assertTupleEqual"><strong>assertTupleEqual</strong></a>(self, tuple1, tuple2, msg<font color="#909090">=None</font>)</dt><dd><tt>A tuple-specific equality assertion.<br> + <br> +Args:<br> + tuple1: The first tuple to compare.<br> + tuple2: The second tuple to compare.<br> + msg: Optional message to use on failure instead of a list of<br> + differences.</tt></dd></dl> + +<dl><dt><a name="Test1-assert_"><strong>assert_</strong></a> = assertTrue(self, expr, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail the test unless the expression is true.</tt></dd></dl> + +<dl><dt><a name="Test1-countTestCases"><strong>countTestCases</strong></a>(self)</dt></dl> + +<dl><dt><a name="Test1-debug"><strong>debug</strong></a>(self)</dt><dd><tt>Run the test without collecting errors in a TestResult</tt></dd></dl> + +<dl><dt><a name="Test1-defaultTestResult"><strong>defaultTestResult</strong></a>(self)</dt></dl> + +<dl><dt><a name="Test1-doCleanups"><strong>doCleanups</strong></a>(self)</dt><dd><tt>Execute all cleanup functions. Normally called for you after<br> +tearDown.</tt></dd></dl> + +<dl><dt><a name="Test1-fail"><strong>fail</strong></a>(self, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail immediately, with the given message.</tt></dd></dl> + +<dl><dt><a name="Test1-failIf"><strong>failIf</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="Test1-failIfAlmostEqual"><strong>failIfAlmostEqual</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="Test1-failIfEqual"><strong>failIfEqual</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="Test1-failUnless"><strong>failUnless</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="Test1-failUnlessAlmostEqual"><strong>failUnlessAlmostEqual</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="Test1-failUnlessEqual"><strong>failUnlessEqual</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="Test1-failUnlessRaises"><strong>failUnlessRaises</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="Test1-id"><strong>id</strong></a>(self)</dt></dl> + +<dl><dt><a name="Test1-run"><strong>run</strong></a>(self, result<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="Test1-setUp"><strong>setUp</strong></a>(self)</dt><dd><tt>Hook method for setting up the test fixture before exercising it.</tt></dd></dl> + +<dl><dt><a name="Test1-shortDescription"><strong>shortDescription</strong></a>(self)</dt><dd><tt>Returns both the test method name and first line of its docstring.<br> + <br> +If no docstring is given, only returns the method name.<br> + <br> +This method overrides unittest.<a href="unittest.html#TestCase">TestCase</a>.<a href="#Test1-shortDescription">shortDescription</a>(), which<br> +only returns the first line of the docstring, obscuring the name<br> +of the test upon failure.</tt></dd></dl> + +<dl><dt><a name="Test1-skipTest"><strong>skipTest</strong></a>(self, reason)</dt><dd><tt>Skip this test.</tt></dd></dl> + +<dl><dt><a name="Test1-tearDown"><strong>tearDown</strong></a>(self)</dt><dd><tt>Hook method for deconstructing the test fixture after testing it.</tt></dd></dl> + +<hr> +Data descriptors inherited from <a href="unittest.html#TestCase">unittest.TestCase</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="unittest.html#TestCase">unittest.TestCase</a>:<br> +<dl><dt><strong>failureException</strong> = <class 'AssertionError'><dd><tt>Assertion failed.</tt></dl> + +<dl><dt><strong>longMessage</strong> = False</dl> + +</td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#55aa55"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> + +<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> +<td width="100%"><strong>NONEXISTANT_DIR</strong> = '/home/hut/work/ranger/test/testdir/nonexistant'<br> +<strong>TESTDIR</strong> = '/home/hut/work/ranger/test/testdir'<br> +<strong>TESTFILE</strong> = '/home/hut/work/ranger/test/testdir/testfile5234148'</td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/test.tc_displayable.html b/doc/test.tc_displayable.html new file mode 100644 index 00000000..a1ebcf89 --- /dev/null +++ b/doc/test.tc_displayable.html @@ -0,0 +1,551 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module test.tc_displayable</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="test.html"><font color="#ffffff">test</font></a>.tc_displayable</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/test/tc_displayable.py">/home/hut/work/ranger/test/tc_displayable.py</a></font></td></tr></table> + <p></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</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="curses.html">curses</a><br> +</td><td width="25%" valign=top><a href="unittest.html">unittest</a><br> +</td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><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="unittest.html#TestCase">unittest.TestCase</a>(<a href="builtins.html#object">builtins.object</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="test.tc_displayable.html#TestDisplayable">TestDisplayable</a> +</font></dt><dt><font face="helvetica, arial"><a href="test.tc_displayable.html#TestDisplayableContainer">TestDisplayableContainer</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="TestDisplayable">class <strong>TestDisplayable</strong></a>(<a href="unittest.html#TestCase">unittest.TestCase</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="test.tc_displayable.html#TestDisplayable">TestDisplayable</a></dd> +<dd><a href="unittest.html#TestCase">unittest.TestCase</a></dd> +<dd><a href="builtins.html#object">builtins.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="TestDisplayable-setUp"><strong>setUp</strong></a>(self)</dt></dl> + +<dl><dt><a name="TestDisplayable-tearDown"><strong>tearDown</strong></a>(self)</dt></dl> + +<dl><dt><a name="TestDisplayable-test_boundaries"><strong>test_boundaries</strong></a>(self)</dt></dl> + +<dl><dt><a name="TestDisplayable-test_colorscheme"><strong>test_colorscheme</strong></a>(self)</dt></dl> + +<hr> +Methods inherited from <a href="unittest.html#TestCase">unittest.TestCase</a>:<br> +<dl><dt><a name="TestDisplayable-__call__"><strong>__call__</strong></a>(self, *args, **kwds)</dt></dl> + +<dl><dt><a name="TestDisplayable-__eq__"><strong>__eq__</strong></a>(self, other)</dt></dl> + +<dl><dt><a name="TestDisplayable-__hash__"><strong>__hash__</strong></a>(self)</dt></dl> + +<dl><dt><a name="TestDisplayable-__init__"><strong>__init__</strong></a>(self, methodName<font color="#909090">='runTest'</font>)</dt><dd><tt>Create an instance of the class that will use the named test<br> +method when executed. Raises a ValueError if the instance does<br> +not have a method with the specified name.</tt></dd></dl> + +<dl><dt><a name="TestDisplayable-__ne__"><strong>__ne__</strong></a>(self, other)</dt></dl> + +<dl><dt><a name="TestDisplayable-__repr__"><strong>__repr__</strong></a>(self)</dt></dl> + +<dl><dt><a name="TestDisplayable-__str__"><strong>__str__</strong></a>(self)</dt></dl> + +<dl><dt><a name="TestDisplayable-addCleanup"><strong>addCleanup</strong></a>(self, function, *args, **kwargs)</dt><dd><tt>Add a function, with arguments, to be called when the test is<br> +completed. Functions added are called on a LIFO basis and are<br> +called after tearDown on test failure or success.<br> + <br> +Cleanup items are called even if setUp fails (unlike tearDown).</tt></dd></dl> + +<dl><dt><a name="TestDisplayable-addTypeEqualityFunc"><strong>addTypeEqualityFunc</strong></a>(self, typeobj, function)</dt><dd><tt>Add a type specific assertEqual style function to compare a type.<br> + <br> +This method is for use by <a href="unittest.html#TestCase">TestCase</a> subclasses that need to register<br> +their own type equality functions to provide nicer error messages.<br> + <br> +Args:<br> + typeobj: The data type to call this function on when both values<br> + are of the same type in <a href="#TestDisplayable-assertEqual">assertEqual</a>().<br> + function: The callable taking two arguments and an optional<br> + msg= argument that raises self.<strong>failureException</strong> with a<br> + useful error message when the two arguments are not equal.</tt></dd></dl> + +<dl><dt><a name="TestDisplayable-assertAlmostEqual"><strong>assertAlmostEqual</strong></a>(self, first, second, *, places<font color="#909090">=7</font>, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are unequal as determined by their<br> +difference rounded to the given number of decimal places<br> +(default 7) and comparing to zero.<br> + <br> +Note that decimal places (from zero) are usually not the same<br> +as significant digits (measured from the most signficant digit).</tt></dd></dl> + +<dl><dt><a name="TestDisplayable-assertAlmostEquals"><strong>assertAlmostEquals</strong></a> = assertAlmostEqual(self, first, second, *, places<font color="#909090">=7</font>, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are unequal as determined by their<br> +difference rounded to the given number of decimal places<br> +(default 7) and comparing to zero.<br> + <br> +Note that decimal places (from zero) are usually not the same<br> +as significant digits (measured from the most signficant digit).</tt></dd></dl> + +<dl><dt><a name="TestDisplayable-assertDictContainsSubset"><strong>assertDictContainsSubset</strong></a>(self, expected, actual, msg<font color="#909090">=None</font>)</dt><dd><tt>Checks whether actual is a superset of expected.</tt></dd></dl> + +<dl><dt><a name="TestDisplayable-assertDictEqual"><strong>assertDictEqual</strong></a>(self, d1, d2, msg<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="TestDisplayable-assertEqual"><strong>assertEqual</strong></a>(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are unequal as determined by the '=='<br> +operator.</tt></dd></dl> + +<dl><dt><a name="TestDisplayable-assertEquals"><strong>assertEquals</strong></a> = assertEqual(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are unequal as determined by the '=='<br> +operator.</tt></dd></dl> + +<dl><dt><a name="TestDisplayable-assertFalse"><strong>assertFalse</strong></a>(self, expr, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail the test if the expression is true.</tt></dd></dl> + +<dl><dt><a name="TestDisplayable-assertGreater"><strong>assertGreater</strong></a>(self, a, b, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#TestDisplayable-assertTrue">assertTrue</a>(a > b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="TestDisplayable-assertGreaterEqual"><strong>assertGreaterEqual</strong></a>(self, a, b, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#TestDisplayable-assertTrue">assertTrue</a>(a >= b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="TestDisplayable-assertIn"><strong>assertIn</strong></a>(self, member, container, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#TestDisplayable-assertTrue">assertTrue</a>(a in b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="TestDisplayable-assertIs"><strong>assertIs</strong></a>(self, expr1, expr2, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#TestDisplayable-assertTrue">assertTrue</a>(a is b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="TestDisplayable-assertIsNone"><strong>assertIsNone</strong></a>(self, obj, msg<font color="#909090">=None</font>)</dt><dd><tt>Same as <a href="#TestDisplayable-assertTrue">assertTrue</a>(obj is None), with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="TestDisplayable-assertIsNot"><strong>assertIsNot</strong></a>(self, expr1, expr2, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#TestDisplayable-assertTrue">assertTrue</a>(a is not b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="TestDisplayable-assertIsNotNone"><strong>assertIsNotNone</strong></a>(self, obj, msg<font color="#909090">=None</font>)</dt><dd><tt>Included for symmetry with assertIsNone.</tt></dd></dl> + +<dl><dt><a name="TestDisplayable-assertLess"><strong>assertLess</strong></a>(self, a, b, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#TestDisplayable-assertTrue">assertTrue</a>(a < b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="TestDisplayable-assertLessEqual"><strong>assertLessEqual</strong></a>(self, a, b, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#TestDisplayable-assertTrue">assertTrue</a>(a <= b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="TestDisplayable-assertListEqual"><strong>assertListEqual</strong></a>(self, list1, list2, msg<font color="#909090">=None</font>)</dt><dd><tt>A list-specific equality assertion.<br> + <br> +Args:<br> + list1: The first list to compare.<br> + list2: The second list to compare.<br> + msg: Optional message to use on failure instead of a list of<br> + differences.</tt></dd></dl> + +<dl><dt><a name="TestDisplayable-assertMultiLineEqual"><strong>assertMultiLineEqual</strong></a>(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Assert that two multi-line strings are equal.</tt></dd></dl> + +<dl><dt><a name="TestDisplayable-assertNotAlmostEqual"><strong>assertNotAlmostEqual</strong></a>(self, first, second, *, places<font color="#909090">=7</font>, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are equal as determined by their<br> +difference rounded to the given number of decimal places<br> +(default 7) and comparing to zero.<br> + <br> +Note that decimal places (from zero) are usually not the same<br> +as significant digits (measured from the most signficant digit).</tt></dd></dl> + +<dl><dt><a name="TestDisplayable-assertNotAlmostEquals"><strong>assertNotAlmostEquals</strong></a> = assertNotAlmostEqual(self, first, second, *, places<font color="#909090">=7</font>, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are equal as determined by their<br> +difference rounded to the given number of decimal places<br> +(default 7) and comparing to zero.<br> + <br> +Note that decimal places (from zero) are usually not the same<br> +as significant digits (measured from the most signficant digit).</tt></dd></dl> + +<dl><dt><a name="TestDisplayable-assertNotEqual"><strong>assertNotEqual</strong></a>(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are equal as determined by the '=='<br> +operator.</tt></dd></dl> + +<dl><dt><a name="TestDisplayable-assertNotEquals"><strong>assertNotEquals</strong></a> = assertNotEqual(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are equal as determined by the '=='<br> +operator.</tt></dd></dl> + +<dl><dt><a name="TestDisplayable-assertNotIn"><strong>assertNotIn</strong></a>(self, member, container, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#TestDisplayable-assertTrue">assertTrue</a>(a not in b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="TestDisplayable-assertRaises"><strong>assertRaises</strong></a>(self, excClass, callableObj<font color="#909090">=None</font>, *args, **kwargs)</dt><dd><tt>Fail unless an exception of class excClass is thrown<br> +by callableObj when invoked with arguments args and keyword<br> +arguments kwargs. If a different type of exception is<br> +thrown, it will not be caught, and the test case will be<br> +deemed to have suffered an error, exactly as for an<br> +unexpected exception.<br> + <br> +If called with callableObj omitted or None, will return a<br> +context object used like this::<br> + <br> + with <a href="#TestDisplayable-assertRaises">assertRaises</a>(some_error_class):<br> + do_something()</tt></dd></dl> + +<dl><dt><a name="TestDisplayable-assertRaisesRegexp"><strong>assertRaisesRegexp</strong></a>(self, expected_exception, expected_regexp, callable_obj<font color="#909090">=None</font>, *args, **kwargs)</dt><dd><tt>Asserts that the message in a raised exception matches a regexp.<br> + <br> +Args:<br> + expected_exception: Exception class expected to be raised.<br> + expected_regexp: Regexp (re pattern object or string) expected<br> + to be found in error message.<br> + callable_obj: Function to be called.<br> + args: Extra args.<br> + kwargs: Extra kwargs.</tt></dd></dl> + +<dl><dt><a name="TestDisplayable-assertRegexpMatches"><strong>assertRegexpMatches</strong></a>(self, text, expected_regex, msg<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="TestDisplayable-assertSameElements"><strong>assertSameElements</strong></a>(self, expected_seq, actual_seq, msg<font color="#909090">=None</font>)</dt><dd><tt>An unordered sequence specific comparison.<br> + <br> +Raises with an error message listing which elements of expected_seq<br> +are missing from actual_seq and vice versa if any.</tt></dd></dl> + +<dl><dt><a name="TestDisplayable-assertSequenceEqual"><strong>assertSequenceEqual</strong></a>(self, seq1, seq2, msg<font color="#909090">=None</font>, seq_type<font color="#909090">=None</font>)</dt><dd><tt>An equality assertion for ordered sequences (like lists and tuples).<br> + <br> +For the purposes of this function, a valid orderd sequence type is one<br> +which can be indexed, has a length, and has an equality operator.<br> + <br> +Args:<br> + seq1: The first sequence to compare.<br> + seq2: The second sequence to compare.<br> + seq_type: The expected datatype of the sequences, or None if no<br> + datatype should be enforced.<br> + msg: Optional message to use on failure instead of a list of<br> + differences.</tt></dd></dl> + +<dl><dt><a name="TestDisplayable-assertSetEqual"><strong>assertSetEqual</strong></a>(self, set1, set2, msg<font color="#909090">=None</font>)</dt><dd><tt>A set-specific equality assertion.<br> + <br> +Args:<br> + set1: The first set to compare.<br> + set2: The second set to compare.<br> + msg: Optional message to use on failure instead of a list of<br> + differences.<br> + <br> +For more general containership equality, assertSameElements will work<br> +with things other than sets. This uses ducktyping to support<br> +different types of sets, and is optimized for sets specifically<br> +(parameters must support a difference method).</tt></dd></dl> + +<dl><dt><a name="TestDisplayable-assertTrue"><strong>assertTrue</strong></a>(self, expr, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail the test unless the expression is true.</tt></dd></dl> + +<dl><dt><a name="TestDisplayable-assertTupleEqual"><strong>assertTupleEqual</strong></a>(self, tuple1, tuple2, msg<font color="#909090">=None</font>)</dt><dd><tt>A tuple-specific equality assertion.<br> + <br> +Args:<br> + tuple1: The first tuple to compare.<br> + tuple2: The second tuple to compare.<br> + msg: Optional message to use on failure instead of a list of<br> + differences.</tt></dd></dl> + +<dl><dt><a name="TestDisplayable-assert_"><strong>assert_</strong></a> = assertTrue(self, expr, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail the test unless the expression is true.</tt></dd></dl> + +<dl><dt><a name="TestDisplayable-countTestCases"><strong>countTestCases</strong></a>(self)</dt></dl> + +<dl><dt><a name="TestDisplayable-debug"><strong>debug</strong></a>(self)</dt><dd><tt>Run the test without collecting errors in a TestResult</tt></dd></dl> + +<dl><dt><a name="TestDisplayable-defaultTestResult"><strong>defaultTestResult</strong></a>(self)</dt></dl> + +<dl><dt><a name="TestDisplayable-doCleanups"><strong>doCleanups</strong></a>(self)</dt><dd><tt>Execute all cleanup functions. Normally called for you after<br> +tearDown.</tt></dd></dl> + +<dl><dt><a name="TestDisplayable-fail"><strong>fail</strong></a>(self, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail immediately, with the given message.</tt></dd></dl> + +<dl><dt><a name="TestDisplayable-failIf"><strong>failIf</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="TestDisplayable-failIfAlmostEqual"><strong>failIfAlmostEqual</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="TestDisplayable-failIfEqual"><strong>failIfEqual</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="TestDisplayable-failUnless"><strong>failUnless</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="TestDisplayable-failUnlessAlmostEqual"><strong>failUnlessAlmostEqual</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="TestDisplayable-failUnlessEqual"><strong>failUnlessEqual</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="TestDisplayable-failUnlessRaises"><strong>failUnlessRaises</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="TestDisplayable-id"><strong>id</strong></a>(self)</dt></dl> + +<dl><dt><a name="TestDisplayable-run"><strong>run</strong></a>(self, result<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="TestDisplayable-shortDescription"><strong>shortDescription</strong></a>(self)</dt><dd><tt>Returns both the test method name and first line of its docstring.<br> + <br> +If no docstring is given, only returns the method name.<br> + <br> +This method overrides unittest.<a href="unittest.html#TestCase">TestCase</a>.<a href="#TestDisplayable-shortDescription">shortDescription</a>(), which<br> +only returns the first line of the docstring, obscuring the name<br> +of the test upon failure.</tt></dd></dl> + +<dl><dt><a name="TestDisplayable-skipTest"><strong>skipTest</strong></a>(self, reason)</dt><dd><tt>Skip this test.</tt></dd></dl> + +<hr> +Data descriptors inherited from <a href="unittest.html#TestCase">unittest.TestCase</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="unittest.html#TestCase">unittest.TestCase</a>:<br> +<dl><dt><strong>failureException</strong> = <class 'AssertionError'><dd><tt>Assertion failed.</tt></dl> + +<dl><dt><strong>longMessage</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="TestDisplayableContainer">class <strong>TestDisplayableContainer</strong></a>(<a href="unittest.html#TestCase">unittest.TestCase</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="test.tc_displayable.html#TestDisplayableContainer">TestDisplayableContainer</a></dd> +<dd><a href="unittest.html#TestCase">unittest.TestCase</a></dd> +<dd><a href="builtins.html#object">builtins.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="TestDisplayableContainer-setUp"><strong>setUp</strong></a>(self)</dt></dl> + +<dl><dt><a name="TestDisplayableContainer-tearDown"><strong>tearDown</strong></a>(self)</dt></dl> + +<dl><dt><a name="TestDisplayableContainer-test_click"><strong>test_click</strong></a>(self)</dt></dl> + +<dl><dt><a name="TestDisplayableContainer-test_container"><strong>test_container</strong></a>(self)</dt></dl> + +<dl><dt><a name="TestDisplayableContainer-test_focused_object"><strong>test_focused_object</strong></a>(self)</dt></dl> + +<hr> +Methods inherited from <a href="unittest.html#TestCase">unittest.TestCase</a>:<br> +<dl><dt><a name="TestDisplayableContainer-__call__"><strong>__call__</strong></a>(self, *args, **kwds)</dt></dl> + +<dl><dt><a name="TestDisplayableContainer-__eq__"><strong>__eq__</strong></a>(self, other)</dt></dl> + +<dl><dt><a name="TestDisplayableContainer-__hash__"><strong>__hash__</strong></a>(self)</dt></dl> + +<dl><dt><a name="TestDisplayableContainer-__init__"><strong>__init__</strong></a>(self, methodName<font color="#909090">='runTest'</font>)</dt><dd><tt>Create an instance of the class that will use the named test<br> +method when executed. Raises a ValueError if the instance does<br> +not have a method with the specified name.</tt></dd></dl> + +<dl><dt><a name="TestDisplayableContainer-__ne__"><strong>__ne__</strong></a>(self, other)</dt></dl> + +<dl><dt><a name="TestDisplayableContainer-__repr__"><strong>__repr__</strong></a>(self)</dt></dl> + +<dl><dt><a name="TestDisplayableContainer-__str__"><strong>__str__</strong></a>(self)</dt></dl> + +<dl><dt><a name="TestDisplayableContainer-addCleanup"><strong>addCleanup</strong></a>(self, function, *args, **kwargs)</dt><dd><tt>Add a function, with arguments, to be called when the test is<br> +completed. Functions added are called on a LIFO basis and are<br> +called after tearDown on test failure or success.<br> + <br> +Cleanup items are called even if setUp fails (unlike tearDown).</tt></dd></dl> + +<dl><dt><a name="TestDisplayableContainer-addTypeEqualityFunc"><strong>addTypeEqualityFunc</strong></a>(self, typeobj, function)</dt><dd><tt>Add a type specific assertEqual style function to compare a type.<br> + <br> +This method is for use by <a href="unittest.html#TestCase">TestCase</a> subclasses that need to register<br> +their own type equality functions to provide nicer error messages.<br> + <br> +Args:<br> + typeobj: The data type to call this function on when both values<br> + are of the same type in <a href="#TestDisplayableContainer-assertEqual">assertEqual</a>().<br> + function: The callable taking two arguments and an optional<br> + msg= argument that raises self.<strong>failureException</strong> with a<br> + useful error message when the two arguments are not equal.</tt></dd></dl> + +<dl><dt><a name="TestDisplayableContainer-assertAlmostEqual"><strong>assertAlmostEqual</strong></a>(self, first, second, *, places<font color="#909090">=7</font>, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are unequal as determined by their<br> +difference rounded to the given number of decimal places<br> +(default 7) and comparing to zero.<br> + <br> +Note that decimal places (from zero) are usually not the same<br> +as significant digits (measured from the most signficant digit).</tt></dd></dl> + +<dl><dt><a name="TestDisplayableContainer-assertAlmostEquals"><strong>assertAlmostEquals</strong></a> = assertAlmostEqual(self, first, second, *, places<font color="#909090">=7</font>, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are unequal as determined by their<br> +difference rounded to the given number of decimal places<br> +(default 7) and comparing to zero.<br> + <br> +Note that decimal places (from zero) are usually not the same<br> +as significant digits (measured from the most signficant digit).</tt></dd></dl> + +<dl><dt><a name="TestDisplayableContainer-assertDictContainsSubset"><strong>assertDictContainsSubset</strong></a>(self, expected, actual, msg<font color="#909090">=None</font>)</dt><dd><tt>Checks whether actual is a superset of expected.</tt></dd></dl> + +<dl><dt><a name="TestDisplayableContainer-assertDictEqual"><strong>assertDictEqual</strong></a>(self, d1, d2, msg<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="TestDisplayableContainer-assertEqual"><strong>assertEqual</strong></a>(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are unequal as determined by the '=='<br> +operator.</tt></dd></dl> + +<dl><dt><a name="TestDisplayableContainer-assertEquals"><strong>assertEquals</strong></a> = assertEqual(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are unequal as determined by the '=='<br> +operator.</tt></dd></dl> + +<dl><dt><a name="TestDisplayableContainer-assertFalse"><strong>assertFalse</strong></a>(self, expr, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail the test if the expression is true.</tt></dd></dl> + +<dl><dt><a name="TestDisplayableContainer-assertGreater"><strong>assertGreater</strong></a>(self, a, b, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#TestDisplayableContainer-assertTrue">assertTrue</a>(a > b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="TestDisplayableContainer-assertGreaterEqual"><strong>assertGreaterEqual</strong></a>(self, a, b, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#TestDisplayableContainer-assertTrue">assertTrue</a>(a >= b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="TestDisplayableContainer-assertIn"><strong>assertIn</strong></a>(self, member, container, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#TestDisplayableContainer-assertTrue">assertTrue</a>(a in b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="TestDisplayableContainer-assertIs"><strong>assertIs</strong></a>(self, expr1, expr2, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#TestDisplayableContainer-assertTrue">assertTrue</a>(a is b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="TestDisplayableContainer-assertIsNone"><strong>assertIsNone</strong></a>(self, obj, msg<font color="#909090">=None</font>)</dt><dd><tt>Same as <a href="#TestDisplayableContainer-assertTrue">assertTrue</a>(obj is None), with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="TestDisplayableContainer-assertIsNot"><strong>assertIsNot</strong></a>(self, expr1, expr2, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#TestDisplayableContainer-assertTrue">assertTrue</a>(a is not b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="TestDisplayableContainer-assertIsNotNone"><strong>assertIsNotNone</strong></a>(self, obj, msg<font color="#909090">=None</font>)</dt><dd><tt>Included for symmetry with assertIsNone.</tt></dd></dl> + +<dl><dt><a name="TestDisplayableContainer-assertLess"><strong>assertLess</strong></a>(self, a, b, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#TestDisplayableContainer-assertTrue">assertTrue</a>(a < b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="TestDisplayableContainer-assertLessEqual"><strong>assertLessEqual</strong></a>(self, a, b, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#TestDisplayableContainer-assertTrue">assertTrue</a>(a <= b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="TestDisplayableContainer-assertListEqual"><strong>assertListEqual</strong></a>(self, list1, list2, msg<font color="#909090">=None</font>)</dt><dd><tt>A list-specific equality assertion.<br> + <br> +Args:<br> + list1: The first list to compare.<br> + list2: The second list to compare.<br> + msg: Optional message to use on failure instead of a list of<br> + differences.</tt></dd></dl> + +<dl><dt><a name="TestDisplayableContainer-assertMultiLineEqual"><strong>assertMultiLineEqual</strong></a>(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Assert that two multi-line strings are equal.</tt></dd></dl> + +<dl><dt><a name="TestDisplayableContainer-assertNotAlmostEqual"><strong>assertNotAlmostEqual</strong></a>(self, first, second, *, places<font color="#909090">=7</font>, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are equal as determined by their<br> +difference rounded to the given number of decimal places<br> +(default 7) and comparing to zero.<br> + <br> +Note that decimal places (from zero) are usually not the same<br> +as significant digits (measured from the most signficant digit).</tt></dd></dl> + +<dl><dt><a name="TestDisplayableContainer-assertNotAlmostEquals"><strong>assertNotAlmostEquals</strong></a> = assertNotAlmostEqual(self, first, second, *, places<font color="#909090">=7</font>, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are equal as determined by their<br> +difference rounded to the given number of decimal places<br> +(default 7) and comparing to zero.<br> + <br> +Note that decimal places (from zero) are usually not the same<br> +as significant digits (measured from the most signficant digit).</tt></dd></dl> + +<dl><dt><a name="TestDisplayableContainer-assertNotEqual"><strong>assertNotEqual</strong></a>(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are equal as determined by the '=='<br> +operator.</tt></dd></dl> + +<dl><dt><a name="TestDisplayableContainer-assertNotEquals"><strong>assertNotEquals</strong></a> = assertNotEqual(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are equal as determined by the '=='<br> +operator.</tt></dd></dl> + +<dl><dt><a name="TestDisplayableContainer-assertNotIn"><strong>assertNotIn</strong></a>(self, member, container, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#TestDisplayableContainer-assertTrue">assertTrue</a>(a not in b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="TestDisplayableContainer-assertRaises"><strong>assertRaises</strong></a>(self, excClass, callableObj<font color="#909090">=None</font>, *args, **kwargs)</dt><dd><tt>Fail unless an exception of class excClass is thrown<br> +by callableObj when invoked with arguments args and keyword<br> +arguments kwargs. If a different type of exception is<br> +thrown, it will not be caught, and the test case will be<br> +deemed to have suffered an error, exactly as for an<br> +unexpected exception.<br> + <br> +If called with callableObj omitted or None, will return a<br> +context object used like this::<br> + <br> + with <a href="#TestDisplayableContainer-assertRaises">assertRaises</a>(some_error_class):<br> + do_something()</tt></dd></dl> + +<dl><dt><a name="TestDisplayableContainer-assertRaisesRegexp"><strong>assertRaisesRegexp</strong></a>(self, expected_exception, expected_regexp, callable_obj<font color="#909090">=None</font>, *args, **kwargs)</dt><dd><tt>Asserts that the message in a raised exception matches a regexp.<br> + <br> +Args:<br> + expected_exception: Exception class expected to be raised.<br> + expected_regexp: Regexp (re pattern object or string) expected<br> + to be found in error message.<br> + callable_obj: Function to be called.<br> + args: Extra args.<br> + kwargs: Extra kwargs.</tt></dd></dl> + +<dl><dt><a name="TestDisplayableContainer-assertRegexpMatches"><strong>assertRegexpMatches</strong></a>(self, text, expected_regex, msg<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="TestDisplayableContainer-assertSameElements"><strong>assertSameElements</strong></a>(self, expected_seq, actual_seq, msg<font color="#909090">=None</font>)</dt><dd><tt>An unordered sequence specific comparison.<br> + <br> +Raises with an error message listing which elements of expected_seq<br> +are missing from actual_seq and vice versa if any.</tt></dd></dl> + +<dl><dt><a name="TestDisplayableContainer-assertSequenceEqual"><strong>assertSequenceEqual</strong></a>(self, seq1, seq2, msg<font color="#909090">=None</font>, seq_type<font color="#909090">=None</font>)</dt><dd><tt>An equality assertion for ordered sequences (like lists and tuples).<br> + <br> +For the purposes of this function, a valid orderd sequence type is one<br> +which can be indexed, has a length, and has an equality operator.<br> + <br> +Args:<br> + seq1: The first sequence to compare.<br> + seq2: The second sequence to compare.<br> + seq_type: The expected datatype of the sequences, or None if no<br> + datatype should be enforced.<br> + msg: Optional message to use on failure instead of a list of<br> + differences.</tt></dd></dl> + +<dl><dt><a name="TestDisplayableContainer-assertSetEqual"><strong>assertSetEqual</strong></a>(self, set1, set2, msg<font color="#909090">=None</font>)</dt><dd><tt>A set-specific equality assertion.<br> + <br> +Args:<br> + set1: The first set to compare.<br> + set2: The second set to compare.<br> + msg: Optional message to use on failure instead of a list of<br> + differences.<br> + <br> +For more general containership equality, assertSameElements will work<br> +with things other than sets. This uses ducktyping to support<br> +different types of sets, and is optimized for sets specifically<br> +(parameters must support a difference method).</tt></dd></dl> + +<dl><dt><a name="TestDisplayableContainer-assertTrue"><strong>assertTrue</strong></a>(self, expr, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail the test unless the expression is true.</tt></dd></dl> + +<dl><dt><a name="TestDisplayableContainer-assertTupleEqual"><strong>assertTupleEqual</strong></a>(self, tuple1, tuple2, msg<font color="#909090">=None</font>)</dt><dd><tt>A tuple-specific equality assertion.<br> + <br> +Args:<br> + tuple1: The first tuple to compare.<br> + tuple2: The second tuple to compare.<br> + msg: Optional message to use on failure instead of a list of<br> + differences.</tt></dd></dl> + +<dl><dt><a name="TestDisplayableContainer-assert_"><strong>assert_</strong></a> = assertTrue(self, expr, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail the test unless the expression is true.</tt></dd></dl> + +<dl><dt><a name="TestDisplayableContainer-countTestCases"><strong>countTestCases</strong></a>(self)</dt></dl> + +<dl><dt><a name="TestDisplayableContainer-debug"><strong>debug</strong></a>(self)</dt><dd><tt>Run the test without collecting errors in a TestResult</tt></dd></dl> + +<dl><dt><a name="TestDisplayableContainer-defaultTestResult"><strong>defaultTestResult</strong></a>(self)</dt></dl> + +<dl><dt><a name="TestDisplayableContainer-doCleanups"><strong>doCleanups</strong></a>(self)</dt><dd><tt>Execute all cleanup functions. Normally called for you after<br> +tearDown.</tt></dd></dl> + +<dl><dt><a name="TestDisplayableContainer-fail"><strong>fail</strong></a>(self, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail immediately, with the given message.</tt></dd></dl> + +<dl><dt><a name="TestDisplayableContainer-failIf"><strong>failIf</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="TestDisplayableContainer-failIfAlmostEqual"><strong>failIfAlmostEqual</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="TestDisplayableContainer-failIfEqual"><strong>failIfEqual</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="TestDisplayableContainer-failUnless"><strong>failUnless</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="TestDisplayableContainer-failUnlessAlmostEqual"><strong>failUnlessAlmostEqual</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="TestDisplayableContainer-failUnlessEqual"><strong>failUnlessEqual</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="TestDisplayableContainer-failUnlessRaises"><strong>failUnlessRaises</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="TestDisplayableContainer-id"><strong>id</strong></a>(self)</dt></dl> + +<dl><dt><a name="TestDisplayableContainer-run"><strong>run</strong></a>(self, result<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="TestDisplayableContainer-shortDescription"><strong>shortDescription</strong></a>(self)</dt><dd><tt>Returns both the test method name and first line of its docstring.<br> + <br> +If no docstring is given, only returns the method name.<br> + <br> +This method overrides unittest.<a href="unittest.html#TestCase">TestCase</a>.<a href="#TestDisplayableContainer-shortDescription">shortDescription</a>(), which<br> +only returns the first line of the docstring, obscuring the name<br> +of the test upon failure.</tt></dd></dl> + +<dl><dt><a name="TestDisplayableContainer-skipTest"><strong>skipTest</strong></a>(self, reason)</dt><dd><tt>Skip this test.</tt></dd></dl> + +<hr> +Data descriptors inherited from <a href="unittest.html#TestCase">unittest.TestCase</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="unittest.html#TestCase">unittest.TestCase</a>:<br> +<dl><dt><strong>failureException</strong> = <class 'AssertionError'><dd><tt>Assertion failed.</tt></dl> + +<dl><dt><strong>longMessage</strong> = False</dl> + +</td></tr></table></td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/test.tc_history.html b/doc/test.tc_history.html new file mode 100644 index 00000000..59b42a9b --- /dev/null +++ b/doc/test.tc_history.html @@ -0,0 +1,290 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module test.tc_history</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="test.html"><font color="#ffffff">test</font></a>.tc_history</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/test/tc_history.py">/home/hut/work/ranger/test/tc_history.py</a></font></td></tr></table> + <p></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</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="unittest.html">unittest</a><br> +</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><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="unittest.html#TestCase">unittest.TestCase</a>(<a href="builtins.html#object">builtins.object</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="test.tc_history.html#Test">Test</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="Test">class <strong>Test</strong></a>(<a href="unittest.html#TestCase">unittest.TestCase</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="test.tc_history.html#Test">Test</a></dd> +<dd><a href="unittest.html#TestCase">unittest.TestCase</a></dd> +<dd><a href="builtins.html#object">builtins.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="Test-test_history"><strong>test_history</strong></a>(self)</dt></dl> + +<hr> +Methods inherited from <a href="unittest.html#TestCase">unittest.TestCase</a>:<br> +<dl><dt><a name="Test-__call__"><strong>__call__</strong></a>(self, *args, **kwds)</dt></dl> + +<dl><dt><a name="Test-__eq__"><strong>__eq__</strong></a>(self, other)</dt></dl> + +<dl><dt><a name="Test-__hash__"><strong>__hash__</strong></a>(self)</dt></dl> + +<dl><dt><a name="Test-__init__"><strong>__init__</strong></a>(self, methodName<font color="#909090">='runTest'</font>)</dt><dd><tt>Create an instance of the class that will use the named test<br> +method when executed. Raises a ValueError if the instance does<br> +not have a method with the specified name.</tt></dd></dl> + +<dl><dt><a name="Test-__ne__"><strong>__ne__</strong></a>(self, other)</dt></dl> + +<dl><dt><a name="Test-__repr__"><strong>__repr__</strong></a>(self)</dt></dl> + +<dl><dt><a name="Test-__str__"><strong>__str__</strong></a>(self)</dt></dl> + +<dl><dt><a name="Test-addCleanup"><strong>addCleanup</strong></a>(self, function, *args, **kwargs)</dt><dd><tt>Add a function, with arguments, to be called when the test is<br> +completed. Functions added are called on a LIFO basis and are<br> +called after tearDown on test failure or success.<br> + <br> +Cleanup items are called even if setUp fails (unlike tearDown).</tt></dd></dl> + +<dl><dt><a name="Test-addTypeEqualityFunc"><strong>addTypeEqualityFunc</strong></a>(self, typeobj, function)</dt><dd><tt>Add a type specific assertEqual style function to compare a type.<br> + <br> +This method is for use by <a href="unittest.html#TestCase">TestCase</a> subclasses that need to register<br> +their own type equality functions to provide nicer error messages.<br> + <br> +Args:<br> + typeobj: The data type to call this function on when both values<br> + are of the same type in <a href="#Test-assertEqual">assertEqual</a>().<br> + function: The callable taking two arguments and an optional<br> + msg= argument that raises self.<strong>failureException</strong> with a<br> + useful error message when the two arguments are not equal.</tt></dd></dl> + +<dl><dt><a name="Test-assertAlmostEqual"><strong>assertAlmostEqual</strong></a>(self, first, second, *, places<font color="#909090">=7</font>, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are unequal as determined by their<br> +difference rounded to the given number of decimal places<br> +(default 7) and comparing to zero.<br> + <br> +Note that decimal places (from zero) are usually not the same<br> +as significant digits (measured from the most signficant digit).</tt></dd></dl> + +<dl><dt><a name="Test-assertAlmostEquals"><strong>assertAlmostEquals</strong></a> = assertAlmostEqual(self, first, second, *, places<font color="#909090">=7</font>, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are unequal as determined by their<br> +difference rounded to the given number of decimal places<br> +(default 7) and comparing to zero.<br> + <br> +Note that decimal places (from zero) are usually not the same<br> +as significant digits (measured from the most signficant digit).</tt></dd></dl> + +<dl><dt><a name="Test-assertDictContainsSubset"><strong>assertDictContainsSubset</strong></a>(self, expected, actual, msg<font color="#909090">=None</font>)</dt><dd><tt>Checks whether actual is a superset of expected.</tt></dd></dl> + +<dl><dt><a name="Test-assertDictEqual"><strong>assertDictEqual</strong></a>(self, d1, d2, msg<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="Test-assertEqual"><strong>assertEqual</strong></a>(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are unequal as determined by the '=='<br> +operator.</tt></dd></dl> + +<dl><dt><a name="Test-assertEquals"><strong>assertEquals</strong></a> = assertEqual(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are unequal as determined by the '=='<br> +operator.</tt></dd></dl> + +<dl><dt><a name="Test-assertFalse"><strong>assertFalse</strong></a>(self, expr, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail the test if the expression is true.</tt></dd></dl> + +<dl><dt><a name="Test-assertGreater"><strong>assertGreater</strong></a>(self, a, b, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#Test-assertTrue">assertTrue</a>(a > b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="Test-assertGreaterEqual"><strong>assertGreaterEqual</strong></a>(self, a, b, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#Test-assertTrue">assertTrue</a>(a >= b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="Test-assertIn"><strong>assertIn</strong></a>(self, member, container, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#Test-assertTrue">assertTrue</a>(a in b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="Test-assertIs"><strong>assertIs</strong></a>(self, expr1, expr2, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#Test-assertTrue">assertTrue</a>(a is b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="Test-assertIsNone"><strong>assertIsNone</strong></a>(self, obj, msg<font color="#909090">=None</font>)</dt><dd><tt>Same as <a href="#Test-assertTrue">assertTrue</a>(obj is None), with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="Test-assertIsNot"><strong>assertIsNot</strong></a>(self, expr1, expr2, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#Test-assertTrue">assertTrue</a>(a is not b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="Test-assertIsNotNone"><strong>assertIsNotNone</strong></a>(self, obj, msg<font color="#909090">=None</font>)</dt><dd><tt>Included for symmetry with assertIsNone.</tt></dd></dl> + +<dl><dt><a name="Test-assertLess"><strong>assertLess</strong></a>(self, a, b, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#Test-assertTrue">assertTrue</a>(a < b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="Test-assertLessEqual"><strong>assertLessEqual</strong></a>(self, a, b, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#Test-assertTrue">assertTrue</a>(a <= b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="Test-assertListEqual"><strong>assertListEqual</strong></a>(self, list1, list2, msg<font color="#909090">=None</font>)</dt><dd><tt>A list-specific equality assertion.<br> + <br> +Args:<br> + list1: The first list to compare.<br> + list2: The second list to compare.<br> + msg: Optional message to use on failure instead of a list of<br> + differences.</tt></dd></dl> + +<dl><dt><a name="Test-assertMultiLineEqual"><strong>assertMultiLineEqual</strong></a>(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Assert that two multi-line strings are equal.</tt></dd></dl> + +<dl><dt><a name="Test-assertNotAlmostEqual"><strong>assertNotAlmostEqual</strong></a>(self, first, second, *, places<font color="#909090">=7</font>, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are equal as determined by their<br> +difference rounded to the given number of decimal places<br> +(default 7) and comparing to zero.<br> + <br> +Note that decimal places (from zero) are usually not the same<br> +as significant digits (measured from the most signficant digit).</tt></dd></dl> + +<dl><dt><a name="Test-assertNotAlmostEquals"><strong>assertNotAlmostEquals</strong></a> = assertNotAlmostEqual(self, first, second, *, places<font color="#909090">=7</font>, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are equal as determined by their<br> +difference rounded to the given number of decimal places<br> +(default 7) and comparing to zero.<br> + <br> +Note that decimal places (from zero) are usually not the same<br> +as significant digits (measured from the most signficant digit).</tt></dd></dl> + +<dl><dt><a name="Test-assertNotEqual"><strong>assertNotEqual</strong></a>(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are equal as determined by the '=='<br> +operator.</tt></dd></dl> + +<dl><dt><a name="Test-assertNotEquals"><strong>assertNotEquals</strong></a> = assertNotEqual(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are equal as determined by the '=='<br> +operator.</tt></dd></dl> + +<dl><dt><a name="Test-assertNotIn"><strong>assertNotIn</strong></a>(self, member, container, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#Test-assertTrue">assertTrue</a>(a not in b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="Test-assertRaises"><strong>assertRaises</strong></a>(self, excClass, callableObj<font color="#909090">=None</font>, *args, **kwargs)</dt><dd><tt>Fail unless an exception of class excClass is thrown<br> +by callableObj when invoked with arguments args and keyword<br> +arguments kwargs. If a different type of exception is<br> +thrown, it will not be caught, and the test case will be<br> +deemed to have suffered an error, exactly as for an<br> +unexpected exception.<br> + <br> +If called with callableObj omitted or None, will return a<br> +context object used like this::<br> + <br> + with <a href="#Test-assertRaises">assertRaises</a>(some_error_class):<br> + do_something()</tt></dd></dl> + +<dl><dt><a name="Test-assertRaisesRegexp"><strong>assertRaisesRegexp</strong></a>(self, expected_exception, expected_regexp, callable_obj<font color="#909090">=None</font>, *args, **kwargs)</dt><dd><tt>Asserts that the message in a raised exception matches a regexp.<br> + <br> +Args:<br> + expected_exception: Exception class expected to be raised.<br> + expected_regexp: Regexp (re pattern object or string) expected<br> + to be found in error message.<br> + callable_obj: Function to be called.<br> + args: Extra args.<br> + kwargs: Extra kwargs.</tt></dd></dl> + +<dl><dt><a name="Test-assertRegexpMatches"><strong>assertRegexpMatches</strong></a>(self, text, expected_regex, msg<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="Test-assertSameElements"><strong>assertSameElements</strong></a>(self, expected_seq, actual_seq, msg<font color="#909090">=None</font>)</dt><dd><tt>An unordered sequence specific comparison.<br> + <br> +Raises with an error message listing which elements of expected_seq<br> +are missing from actual_seq and vice versa if any.</tt></dd></dl> + +<dl><dt><a name="Test-assertSequenceEqual"><strong>assertSequenceEqual</strong></a>(self, seq1, seq2, msg<font color="#909090">=None</font>, seq_type<font color="#909090">=None</font>)</dt><dd><tt>An equality assertion for ordered sequences (like lists and tuples).<br> + <br> +For the purposes of this function, a valid orderd sequence type is one<br> +which can be indexed, has a length, and has an equality operator.<br> + <br> +Args:<br> + seq1: The first sequence to compare.<br> + seq2: The second sequence to compare.<br> + seq_type: The expected datatype of the sequences, or None if no<br> + datatype should be enforced.<br> + msg: Optional message to use on failure instead of a list of<br> + differences.</tt></dd></dl> + +<dl><dt><a name="Test-assertSetEqual"><strong>assertSetEqual</strong></a>(self, set1, set2, msg<font color="#909090">=None</font>)</dt><dd><tt>A set-specific equality assertion.<br> + <br> +Args:<br> + set1: The first set to compare.<br> + set2: The second set to compare.<br> + msg: Optional message to use on failure instead of a list of<br> + differences.<br> + <br> +For more general containership equality, assertSameElements will work<br> +with things other than sets. This uses ducktyping to support<br> +different types of sets, and is optimized for sets specifically<br> +(parameters must support a difference method).</tt></dd></dl> + +<dl><dt><a name="Test-assertTrue"><strong>assertTrue</strong></a>(self, expr, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail the test unless the expression is true.</tt></dd></dl> + +<dl><dt><a name="Test-assertTupleEqual"><strong>assertTupleEqual</strong></a>(self, tuple1, tuple2, msg<font color="#909090">=None</font>)</dt><dd><tt>A tuple-specific equality assertion.<br> + <br> +Args:<br> + tuple1: The first tuple to compare.<br> + tuple2: The second tuple to compare.<br> + msg: Optional message to use on failure instead of a list of<br> + differences.</tt></dd></dl> + +<dl><dt><a name="Test-assert_"><strong>assert_</strong></a> = assertTrue(self, expr, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail the test unless the expression is true.</tt></dd></dl> + +<dl><dt><a name="Test-countTestCases"><strong>countTestCases</strong></a>(self)</dt></dl> + +<dl><dt><a name="Test-debug"><strong>debug</strong></a>(self)</dt><dd><tt>Run the test without collecting errors in a TestResult</tt></dd></dl> + +<dl><dt><a name="Test-defaultTestResult"><strong>defaultTestResult</strong></a>(self)</dt></dl> + +<dl><dt><a name="Test-doCleanups"><strong>doCleanups</strong></a>(self)</dt><dd><tt>Execute all cleanup functions. Normally called for you after<br> +tearDown.</tt></dd></dl> + +<dl><dt><a name="Test-fail"><strong>fail</strong></a>(self, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail immediately, with the given message.</tt></dd></dl> + +<dl><dt><a name="Test-failIf"><strong>failIf</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="Test-failIfAlmostEqual"><strong>failIfAlmostEqual</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="Test-failIfEqual"><strong>failIfEqual</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="Test-failUnless"><strong>failUnless</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="Test-failUnlessAlmostEqual"><strong>failUnlessAlmostEqual</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="Test-failUnlessEqual"><strong>failUnlessEqual</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="Test-failUnlessRaises"><strong>failUnlessRaises</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="Test-id"><strong>id</strong></a>(self)</dt></dl> + +<dl><dt><a name="Test-run"><strong>run</strong></a>(self, result<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="Test-setUp"><strong>setUp</strong></a>(self)</dt><dd><tt>Hook method for setting up the test fixture before exercising it.</tt></dd></dl> + +<dl><dt><a name="Test-shortDescription"><strong>shortDescription</strong></a>(self)</dt><dd><tt>Returns both the test method name and first line of its docstring.<br> + <br> +If no docstring is given, only returns the method name.<br> + <br> +This method overrides unittest.<a href="unittest.html#TestCase">TestCase</a>.<a href="#Test-shortDescription">shortDescription</a>(), which<br> +only returns the first line of the docstring, obscuring the name<br> +of the test upon failure.</tt></dd></dl> + +<dl><dt><a name="Test-skipTest"><strong>skipTest</strong></a>(self, reason)</dt><dd><tt>Skip this test.</tt></dd></dl> + +<dl><dt><a name="Test-tearDown"><strong>tearDown</strong></a>(self)</dt><dd><tt>Hook method for deconstructing the test fixture after testing it.</tt></dd></dl> + +<hr> +Data descriptors inherited from <a href="unittest.html#TestCase">unittest.TestCase</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="unittest.html#TestCase">unittest.TestCase</a>:<br> +<dl><dt><strong>failureException</strong> = <class 'AssertionError'><dd><tt>Assertion failed.</tt></dl> + +<dl><dt><strong>longMessage</strong> = False</dl> + +</td></tr></table></td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/test.tc_ui.html b/doc/test.tc_ui.html new file mode 100644 index 00000000..fcea943d --- /dev/null +++ b/doc/test.tc_ui.html @@ -0,0 +1,294 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module test.tc_ui</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="test.html"><font color="#ffffff">test</font></a>.tc_ui</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/test/tc_ui.py">/home/hut/work/ranger/test/tc_ui.py</a></font></td></tr></table> + <p></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</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="curses.html">curses</a><br> +</td><td width="25%" valign=top><a href="ranger.gui.ui.html">ranger.gui.ui</a><br> +</td><td width="25%" valign=top><a href="unittest.html">unittest</a><br> +</td><td width="25%" valign=top></td></tr></table></td></tr></table><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="unittest.html#TestCase">unittest.TestCase</a>(<a href="builtins.html#object">builtins.object</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="test.tc_ui.html#Test">Test</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="Test">class <strong>Test</strong></a>(<a href="unittest.html#TestCase">unittest.TestCase</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="test.tc_ui.html#Test">Test</a></dd> +<dd><a href="unittest.html#TestCase">unittest.TestCase</a></dd> +<dd><a href="builtins.html#object">builtins.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="Test-setUp"><strong>setUp</strong></a>(self)</dt></dl> + +<dl><dt><a name="Test-tearDown"><strong>tearDown</strong></a>(self)</dt></dl> + +<dl><dt><a name="Test-test_passing"><strong>test_passing</strong></a>(self)</dt></dl> + +<dl><dt><a name="Test-test_scrolling"><strong>test_scrolling</strong></a>(self)</dt></dl> + +<hr> +Methods inherited from <a href="unittest.html#TestCase">unittest.TestCase</a>:<br> +<dl><dt><a name="Test-__call__"><strong>__call__</strong></a>(self, *args, **kwds)</dt></dl> + +<dl><dt><a name="Test-__eq__"><strong>__eq__</strong></a>(self, other)</dt></dl> + +<dl><dt><a name="Test-__hash__"><strong>__hash__</strong></a>(self)</dt></dl> + +<dl><dt><a name="Test-__init__"><strong>__init__</strong></a>(self, methodName<font color="#909090">='runTest'</font>)</dt><dd><tt>Create an instance of the class that will use the named test<br> +method when executed. Raises a ValueError if the instance does<br> +not have a method with the specified name.</tt></dd></dl> + +<dl><dt><a name="Test-__ne__"><strong>__ne__</strong></a>(self, other)</dt></dl> + +<dl><dt><a name="Test-__repr__"><strong>__repr__</strong></a>(self)</dt></dl> + +<dl><dt><a name="Test-__str__"><strong>__str__</strong></a>(self)</dt></dl> + +<dl><dt><a name="Test-addCleanup"><strong>addCleanup</strong></a>(self, function, *args, **kwargs)</dt><dd><tt>Add a function, with arguments, to be called when the test is<br> +completed. Functions added are called on a LIFO basis and are<br> +called after tearDown on test failure or success.<br> + <br> +Cleanup items are called even if setUp fails (unlike tearDown).</tt></dd></dl> + +<dl><dt><a name="Test-addTypeEqualityFunc"><strong>addTypeEqualityFunc</strong></a>(self, typeobj, function)</dt><dd><tt>Add a type specific assertEqual style function to compare a type.<br> + <br> +This method is for use by <a href="unittest.html#TestCase">TestCase</a> subclasses that need to register<br> +their own type equality functions to provide nicer error messages.<br> + <br> +Args:<br> + typeobj: The data type to call this function on when both values<br> + are of the same type in <a href="#Test-assertEqual">assertEqual</a>().<br> + function: The callable taking two arguments and an optional<br> + msg= argument that raises self.<strong>failureException</strong> with a<br> + useful error message when the two arguments are not equal.</tt></dd></dl> + +<dl><dt><a name="Test-assertAlmostEqual"><strong>assertAlmostEqual</strong></a>(self, first, second, *, places<font color="#909090">=7</font>, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are unequal as determined by their<br> +difference rounded to the given number of decimal places<br> +(default 7) and comparing to zero.<br> + <br> +Note that decimal places (from zero) are usually not the same<br> +as significant digits (measured from the most signficant digit).</tt></dd></dl> + +<dl><dt><a name="Test-assertAlmostEquals"><strong>assertAlmostEquals</strong></a> = assertAlmostEqual(self, first, second, *, places<font color="#909090">=7</font>, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are unequal as determined by their<br> +difference rounded to the given number of decimal places<br> +(default 7) and comparing to zero.<br> + <br> +Note that decimal places (from zero) are usually not the same<br> +as significant digits (measured from the most signficant digit).</tt></dd></dl> + +<dl><dt><a name="Test-assertDictContainsSubset"><strong>assertDictContainsSubset</strong></a>(self, expected, actual, msg<font color="#909090">=None</font>)</dt><dd><tt>Checks whether actual is a superset of expected.</tt></dd></dl> + +<dl><dt><a name="Test-assertDictEqual"><strong>assertDictEqual</strong></a>(self, d1, d2, msg<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="Test-assertEqual"><strong>assertEqual</strong></a>(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are unequal as determined by the '=='<br> +operator.</tt></dd></dl> + +<dl><dt><a name="Test-assertEquals"><strong>assertEquals</strong></a> = assertEqual(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are unequal as determined by the '=='<br> +operator.</tt></dd></dl> + +<dl><dt><a name="Test-assertFalse"><strong>assertFalse</strong></a>(self, expr, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail the test if the expression is true.</tt></dd></dl> + +<dl><dt><a name="Test-assertGreater"><strong>assertGreater</strong></a>(self, a, b, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#Test-assertTrue">assertTrue</a>(a > b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="Test-assertGreaterEqual"><strong>assertGreaterEqual</strong></a>(self, a, b, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#Test-assertTrue">assertTrue</a>(a >= b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="Test-assertIn"><strong>assertIn</strong></a>(self, member, container, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#Test-assertTrue">assertTrue</a>(a in b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="Test-assertIs"><strong>assertIs</strong></a>(self, expr1, expr2, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#Test-assertTrue">assertTrue</a>(a is b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="Test-assertIsNone"><strong>assertIsNone</strong></a>(self, obj, msg<font color="#909090">=None</font>)</dt><dd><tt>Same as <a href="#Test-assertTrue">assertTrue</a>(obj is None), with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="Test-assertIsNot"><strong>assertIsNot</strong></a>(self, expr1, expr2, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#Test-assertTrue">assertTrue</a>(a is not b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="Test-assertIsNotNone"><strong>assertIsNotNone</strong></a>(self, obj, msg<font color="#909090">=None</font>)</dt><dd><tt>Included for symmetry with assertIsNone.</tt></dd></dl> + +<dl><dt><a name="Test-assertLess"><strong>assertLess</strong></a>(self, a, b, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#Test-assertTrue">assertTrue</a>(a < b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="Test-assertLessEqual"><strong>assertLessEqual</strong></a>(self, a, b, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#Test-assertTrue">assertTrue</a>(a <= b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="Test-assertListEqual"><strong>assertListEqual</strong></a>(self, list1, list2, msg<font color="#909090">=None</font>)</dt><dd><tt>A list-specific equality assertion.<br> + <br> +Args:<br> + list1: The first list to compare.<br> + list2: The second list to compare.<br> + msg: Optional message to use on failure instead of a list of<br> + differences.</tt></dd></dl> + +<dl><dt><a name="Test-assertMultiLineEqual"><strong>assertMultiLineEqual</strong></a>(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Assert that two multi-line strings are equal.</tt></dd></dl> + +<dl><dt><a name="Test-assertNotAlmostEqual"><strong>assertNotAlmostEqual</strong></a>(self, first, second, *, places<font color="#909090">=7</font>, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are equal as determined by their<br> +difference rounded to the given number of decimal places<br> +(default 7) and comparing to zero.<br> + <br> +Note that decimal places (from zero) are usually not the same<br> +as significant digits (measured from the most signficant digit).</tt></dd></dl> + +<dl><dt><a name="Test-assertNotAlmostEquals"><strong>assertNotAlmostEquals</strong></a> = assertNotAlmostEqual(self, first, second, *, places<font color="#909090">=7</font>, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are equal as determined by their<br> +difference rounded to the given number of decimal places<br> +(default 7) and comparing to zero.<br> + <br> +Note that decimal places (from zero) are usually not the same<br> +as significant digits (measured from the most signficant digit).</tt></dd></dl> + +<dl><dt><a name="Test-assertNotEqual"><strong>assertNotEqual</strong></a>(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are equal as determined by the '=='<br> +operator.</tt></dd></dl> + +<dl><dt><a name="Test-assertNotEquals"><strong>assertNotEquals</strong></a> = assertNotEqual(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are equal as determined by the '=='<br> +operator.</tt></dd></dl> + +<dl><dt><a name="Test-assertNotIn"><strong>assertNotIn</strong></a>(self, member, container, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#Test-assertTrue">assertTrue</a>(a not in b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="Test-assertRaises"><strong>assertRaises</strong></a>(self, excClass, callableObj<font color="#909090">=None</font>, *args, **kwargs)</dt><dd><tt>Fail unless an exception of class excClass is thrown<br> +by callableObj when invoked with arguments args and keyword<br> +arguments kwargs. If a different type of exception is<br> +thrown, it will not be caught, and the test case will be<br> +deemed to have suffered an error, exactly as for an<br> +unexpected exception.<br> + <br> +If called with callableObj omitted or None, will return a<br> +context object used like this::<br> + <br> + with <a href="#Test-assertRaises">assertRaises</a>(some_error_class):<br> + do_something()</tt></dd></dl> + +<dl><dt><a name="Test-assertRaisesRegexp"><strong>assertRaisesRegexp</strong></a>(self, expected_exception, expected_regexp, callable_obj<font color="#909090">=None</font>, *args, **kwargs)</dt><dd><tt>Asserts that the message in a raised exception matches a regexp.<br> + <br> +Args:<br> + expected_exception: Exception class expected to be raised.<br> + expected_regexp: Regexp (re pattern object or string) expected<br> + to be found in error message.<br> + callable_obj: Function to be called.<br> + args: Extra args.<br> + kwargs: Extra kwargs.</tt></dd></dl> + +<dl><dt><a name="Test-assertRegexpMatches"><strong>assertRegexpMatches</strong></a>(self, text, expected_regex, msg<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="Test-assertSameElements"><strong>assertSameElements</strong></a>(self, expected_seq, actual_seq, msg<font color="#909090">=None</font>)</dt><dd><tt>An unordered sequence specific comparison.<br> + <br> +Raises with an error message listing which elements of expected_seq<br> +are missing from actual_seq and vice versa if any.</tt></dd></dl> + +<dl><dt><a name="Test-assertSequenceEqual"><strong>assertSequenceEqual</strong></a>(self, seq1, seq2, msg<font color="#909090">=None</font>, seq_type<font color="#909090">=None</font>)</dt><dd><tt>An equality assertion for ordered sequences (like lists and tuples).<br> + <br> +For the purposes of this function, a valid orderd sequence type is one<br> +which can be indexed, has a length, and has an equality operator.<br> + <br> +Args:<br> + seq1: The first sequence to compare.<br> + seq2: The second sequence to compare.<br> + seq_type: The expected datatype of the sequences, or None if no<br> + datatype should be enforced.<br> + msg: Optional message to use on failure instead of a list of<br> + differences.</tt></dd></dl> + +<dl><dt><a name="Test-assertSetEqual"><strong>assertSetEqual</strong></a>(self, set1, set2, msg<font color="#909090">=None</font>)</dt><dd><tt>A set-specific equality assertion.<br> + <br> +Args:<br> + set1: The first set to compare.<br> + set2: The second set to compare.<br> + msg: Optional message to use on failure instead of a list of<br> + differences.<br> + <br> +For more general containership equality, assertSameElements will work<br> +with things other than sets. This uses ducktyping to support<br> +different types of sets, and is optimized for sets specifically<br> +(parameters must support a difference method).</tt></dd></dl> + +<dl><dt><a name="Test-assertTrue"><strong>assertTrue</strong></a>(self, expr, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail the test unless the expression is true.</tt></dd></dl> + +<dl><dt><a name="Test-assertTupleEqual"><strong>assertTupleEqual</strong></a>(self, tuple1, tuple2, msg<font color="#909090">=None</font>)</dt><dd><tt>A tuple-specific equality assertion.<br> + <br> +Args:<br> + tuple1: The first tuple to compare.<br> + tuple2: The second tuple to compare.<br> + msg: Optional message to use on failure instead of a list of<br> + differences.</tt></dd></dl> + +<dl><dt><a name="Test-assert_"><strong>assert_</strong></a> = assertTrue(self, expr, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail the test unless the expression is true.</tt></dd></dl> + +<dl><dt><a name="Test-countTestCases"><strong>countTestCases</strong></a>(self)</dt></dl> + +<dl><dt><a name="Test-debug"><strong>debug</strong></a>(self)</dt><dd><tt>Run the test without collecting errors in a TestResult</tt></dd></dl> + +<dl><dt><a name="Test-defaultTestResult"><strong>defaultTestResult</strong></a>(self)</dt></dl> + +<dl><dt><a name="Test-doCleanups"><strong>doCleanups</strong></a>(self)</dt><dd><tt>Execute all cleanup functions. Normally called for you after<br> +tearDown.</tt></dd></dl> + +<dl><dt><a name="Test-fail"><strong>fail</strong></a>(self, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail immediately, with the given message.</tt></dd></dl> + +<dl><dt><a name="Test-failIf"><strong>failIf</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="Test-failIfAlmostEqual"><strong>failIfAlmostEqual</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="Test-failIfEqual"><strong>failIfEqual</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="Test-failUnless"><strong>failUnless</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="Test-failUnlessAlmostEqual"><strong>failUnlessAlmostEqual</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="Test-failUnlessEqual"><strong>failUnlessEqual</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="Test-failUnlessRaises"><strong>failUnlessRaises</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="Test-id"><strong>id</strong></a>(self)</dt></dl> + +<dl><dt><a name="Test-run"><strong>run</strong></a>(self, result<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="Test-shortDescription"><strong>shortDescription</strong></a>(self)</dt><dd><tt>Returns both the test method name and first line of its docstring.<br> + <br> +If no docstring is given, only returns the method name.<br> + <br> +This method overrides unittest.<a href="unittest.html#TestCase">TestCase</a>.<a href="#Test-shortDescription">shortDescription</a>(), which<br> +only returns the first line of the docstring, obscuring the name<br> +of the test upon failure.</tt></dd></dl> + +<dl><dt><a name="Test-skipTest"><strong>skipTest</strong></a>(self, reason)</dt><dd><tt>Skip this test.</tt></dd></dl> + +<hr> +Data descriptors inherited from <a href="unittest.html#TestCase">unittest.TestCase</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="unittest.html#TestCase">unittest.TestCase</a>:<br> +<dl><dt><strong>failureException</strong> = <class 'AssertionError'><dd><tt>Assertion failed.</tt></dl> + +<dl><dt><strong>longMessage</strong> = False</dl> + +</td></tr></table></td></tr></table> +</body></html> \ No newline at end of file diff --git a/doc/test.test.html b/doc/test.test.html new file mode 100644 index 00000000..f463fa8b --- /dev/null +++ b/doc/test.test.html @@ -0,0 +1,14 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module test.test</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="test.html"><font color="#ffffff">test</font></a>.test</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/test/test.py">/home/hut/work/ranger/test/test.py</a></font></td></tr></table> + <p><tt>Workaround to allow running single test cases directly</tt></p> + +</body></html> \ No newline at end of file |