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 /doc/ranger.container.bookmarks.html | |
| parent | 4e01caf19cfbc798862e6b8b2dbd77328c8f99a2 (diff) | |
| download | ranger-f07bb12fc5c59430e995a64956b36331ce3629b9.tar.gz | |
updated pydoc pages
Diffstat (limited to 'doc/ranger.container.bookmarks.html')
| -rw-r--r-- | doc/ranger.container.bookmarks.html | 173 |
1 files changed, 173 insertions, 0 deletions
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 |