<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html><head><title>Python: module ranger.container.bookmarks</title> </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/ranger/ranger/container/bookmarks.py">/home/hut/ranger/ranger/container/bookmarks.py</a></font></td></tr></table> <p><tt># Copyright (c) 2009, 2010 hut <hut@lavabit.com><br> #<br> # Permission to use, copy, modify, and/or distribute this software for any<br> # purpose with or without fee is hereby granted, provided that the above<br> # copyright notice and this permission notice appear in all copies.<br> #<br> # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES<br> # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF<br> # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR<br> # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES<br> # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN<br> # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF<br> # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</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="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="__builtin__.html#object">__builtin__.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="__builtin__.html#object">__builtin__.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="__builtin__.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">=<type '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-__iter__"><strong>__iter__</strong></a>(self)</dt></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 key '</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 0xec7430></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>