From 94cb60a6bde75a385c6ad9afbae2c8e738fdc0a0 Mon Sep 17 00:00:00 2001 From: hut Date: Fri, 25 Dec 2009 21:55:36 +0100 Subject: moved pydoc pages to doc/pydoc --- doc/ranger.container.bookmarks.html | 173 ------------------------------------ 1 file changed, 173 deletions(-) delete mode 100644 doc/ranger.container.bookmarks.html (limited to 'doc/ranger.container.bookmarks.html') diff --git a/doc/ranger.container.bookmarks.html b/doc/ranger.container.bookmarks.html deleted file mode 100644 index 699524c4..00000000 --- a/doc/ranger.container.bookmarks.html +++ /dev/null @@ -1,173 +0,0 @@ - -Python: module ranger.container.bookmarks - - - - - -
 
- 
ranger.container.bookmarks		index
/home/hut/work/ranger/ranger/container/bookmarks.py
-

-

- - - - - -
 
-Modules
       
os
-		re
-		string
-

- - - - - -
 
-Classes
       
-
builtins.Exception(builtins.BaseException) -
-
-
NonexistantBookmark -
-
-
builtins.object -
-
-
Bookmarks -
-
-
-

- - - - - - - -
 
-class Bookmarks(builtins.object)
   Bookmarks is a container which associates keys with bookmarks.
- 
-A key is a string with: len(key) == 1 and key in ALLOWED_KEYS.
- 
-A bookmark is an object with: bookmark == bookmarktype(str(instance))
-Which is true for str or FileSystemObject. This condition is required
-so bookmark-objects can be saved to and loaded from a file.
- 
-Optionally, a bookmark.go() method is used for entering a bookmark.
 
 Methods defined here:
-
__contains__(self, key)
Test whether a bookmark-key is defined
- -
__getitem__(self, key)
Get the bookmark associated with the key
- -
__init__(self, bookmarkfile, bookmarktype=<class 'str'>, autosave=False)
<bookmarkfile> specifies the path to the file where
-bookmarks are saved in.
- -
__setitem__(self, key, value)
Bookmark <value> to the key <key>.
-key is expected to be a 1-character string and element of ALLOWED_KEYS.
-value is expected to be a filesystemobject.
- -
delete(self, key)
Delete the bookmark with the given key
- -
enter(self, key)
Enter the bookmark with the given key.
-Requires the bookmark instance to have a go() method.
- -
load(self)
Load the bookmarks from path/bookmarks
- -
remember(self, value)
Bookmarks <value> to the keys ` and '
- -
save(self)
Save the bookmarks to the bookmarkfile.
-This is done automatically after every modification if autosave is True.
- -
update(self)
Update the bookmarks from the bookmark file.
-Useful if two instances are running which define different bookmarks.
- -
update_if_outdated(self)
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables (if defined)
-
-
__weakref__
-
list of weak references to the object (if defined)
-
-
-Data and other attributes defined here:
-
autosave = True
- -
last_mtime = None
- -
load_pattern = <_sre.SRE_Pattern object at 0x15161a0>
- -

- - - - - -
 
-class NonexistantBookmark(builtins.Exception)
    
Method resolution order:
-
NonexistantBookmark
-
builtins.Exception
-
builtins.BaseException
-
builtins.object
-
-
-Data descriptors defined here:
-
__weakref__
-
list of weak references to the object (if defined)
-
-
-Methods inherited from builtins.Exception:
-
__init__(...)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
- -
-Data and other attributes inherited from builtins.Exception:
-
__new__ = <built-in method __new__ of type object at 0x7f327d94a120>
T.__new__(S, ...) -> a new object with type S, a subtype of T
- -
-Methods inherited from builtins.BaseException:
-
__delattr__(...)
x.__delattr__('name') <==> del x.name
- -
__getattribute__(...)
x.__getattribute__('name') <==> x.name
- -
__reduce__(...)
- -
__repr__(...)
x.__repr__() <==> repr(x)
- -
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
- -
__setstate__(...)
- -
__str__(...)
x.__str__() <==> str(x)
- -
with_traceback(...)
Exception.with_traceback(tb) --
-set self.__traceback__ to tb and return self.
- -
-Data descriptors inherited from builtins.BaseException:
-
__cause__
-
exception cause
-
-
__context__
-
exception context
-
-
__dict__
-
-
__traceback__
-
-
args
-
-

- - - - - -
 
-Data
       ALLOWED_KEYS = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789`'"
- \ No newline at end of file -- cgit 1.4.1-2-gfad0