From f07bb12fc5c59430e995a64956b36331ce3629b9 Mon Sep 17 00:00:00 2001 From: hut Date: Fri, 25 Dec 2009 21:55:04 +0100 Subject: updated pydoc pages --- doc/ranger.fsobject.directory.html | 344 +++++++++++++++++++++++++++++++++++++ 1 file changed, 344 insertions(+) create mode 100644 doc/ranger.fsobject.directory.html (limited to 'doc/ranger.fsobject.directory.html') 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 @@ + +Python: module ranger.fsobject.directory + + + + + +
 
+ 
ranger.fsobject.directory		index
/home/hut/work/ranger/ranger/fsobject/directory.py
+

+

+ + + + + +
 
+Modules
       
ranger
+

+ + + + + +
 
+Classes
       
+
builtins.Exception(builtins.BaseException) +
+
+
NoDirectoryGiven +
+
+
ranger.ext.accumulator.Accumulator(builtins.object) +
+
+
Directory(ranger.fsobject.fsobject.FileSystemObject, ranger.ext.accumulator.Accumulator, ranger.shared.settings.SettingsAware) +
+
+
ranger.fsobject.fsobject.FileSystemObject(ranger.shared.mimetype.MimeTypeAware, ranger.shared.FileManagerAware) +
+
+
Directory(ranger.fsobject.fsobject.FileSystemObject, ranger.ext.accumulator.Accumulator, ranger.shared.settings.SettingsAware) +
+
+
ranger.shared.settings.SettingsAware(builtins.object) +
+
+
Directory(ranger.fsobject.fsobject.FileSystemObject, ranger.ext.accumulator.Accumulator, ranger.shared.settings.SettingsAware) +
+
+
+

+ + + + + +
 
+class Directory(ranger.fsobject.fsobject.FileSystemObject, ranger.ext.accumulator.Accumulator, ranger.shared.settings.SettingsAware)
    
Method resolution order:
+
Directory
+
ranger.fsobject.fsobject.FileSystemObject
+
ranger.shared.mimetype.MimeTypeAware
+
ranger.shared.FileManagerAware
+
ranger.shared.Awareness
+
ranger.ext.accumulator.Accumulator
+
ranger.shared.settings.SettingsAware
+
builtins.object
+
+
+Methods defined here:
+
__eq__(self, other)
Check for equality of the directories paths
+ +
__getitem__(self, key)
Get the file by its index
+ +
__hash__(self)
+ +
__init__(self, path)
+ +
__len__(self)
The number of containing files
+ +
__neq__(self, other)
Check for inequality of the directories paths
+ +
__nonzero__(self)
Always True
+ +
correct_pointer(self)
Make sure the pointer is in the valid range
+ +
empty(self)
Is the directory empty?
+ +
get_list(self)
+ +
get_selection(self)
READ ONLY
+ +
load_bit_by_bit(self)
Returns a generator which load a part of the directory
+in each iteration.
+ +
load_content(self, schedule=None)
Loads the contents of the directory. Use this sparingly since
+it takes rather long.
+ +
load_content_if_outdated(self, *a, **k)
Load the contents of the directory if it's
+outdated or not done yet
+ +
load_content_once(self, *a, **k)
Load the contents of the directory if not done yet
+ +
mark_all(self, val)
+ +
mark_item(self, item, val)
+ +
move_to_obj(self, arg)
+ +
search(self, arg, direction=1)
Search for a regular expression
+ +
sort(self)
Sort the containing files
+ +
sort_if_outdated(self)
Sort the containing files if they are outdated
+ +
toggle_all_marks(self)
+ +
toggle_mark(self, item)
+ +
unload(self)
+ +
+Data and other attributes defined here:
+
enterable = False
+ +
filenames = None
+ +
files = None
+ +
filter = None
+ +
load_generator = None
+ +
loading = False
+ +
marked_items = None
+ +
old_directories_first = None
+ +
old_reverse = None
+ +
old_show_hidden = None
+ +
old_sort = None
+ +
scroll_begin = 0
+ +
scroll_offset = 0
+ +
sort_dict = {'basename': <function sort_by_basename at 0x154a408>, 'mtime': <function <lambda> at 0x1569518>, 'size': <function <lambda> at 0x1569490>, 'type': <function <lambda> at 0x15695a0>}
+ +
+Methods inherited from ranger.fsobject.fsobject.FileSystemObject:
+
__str__(self)
returns a string containing the absolute path
+ +
get_description(self)
+ +
get_permission_string(self)
+ +
go(self)
enter the directory if the filemanager is running
+ +
is_older_than(self, seconds)
returns whether this object wasn't use()d in the last n seconds
+ +
load(self)
reads useful information about the filesystem-object from the
+filesystem and caches it for later use
+ +
load_if_outdated(self)
Calls load() if the currently cached information is outdated
+or nonexistant.
+ +
load_once(self)
calls load() if it has not been called at least once yet
+ +
mark(self, boolean)
+ +
set_mimetype(self)
assign attributes such as self.video according to the mimetype
+ +
use(self)
mark the filesystem-object as used at the current time
+ +
+Data and other attributes inherited from ranger.fsobject.fsobject.FileSystemObject:
+
accessible = False
+ +
audio = False
+ +
basename = None
+ +
basename_lower = None
+ +
container = False
+ +
content_loaded = False
+ +
dirname = None
+ +
document = False
+ +
exists = False
+ +
extension = None
+ +
force_load = False
+ +
image = False
+ +
infostring = None
+ +
islink = False
+ +
last_used = None
+ +
loaded = False
+ +
marked = False
+ +
media = False
+ +
mimetype_tuple = ()
+ +
path = None
+ +
permissions = None
+ +
readlink = None
+ +
runnable = False
+ +
size = 0
+ +
stat = None
+ +
stopped = False
+ +
tagged = False
+ +
type = 'unknown'
+ +
video = False
+ +
+Data descriptors inherited from ranger.shared.mimetype.MimeTypeAware:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+Data and other attributes inherited from ranger.shared.mimetype.MimeTypeAware:
+
mimetypes = {}
+ +
+Data and other attributes inherited from ranger.shared.FileManagerAware:
+
fm = None
+ +
+Methods inherited from ranger.ext.accumulator.Accumulator:
+
move(self, relative=0, absolute=None)
+ +
pointer_is_synced(self)
+ +
sync_index(self, **kw)
+ +
+Data and other attributes inherited from ranger.shared.settings.SettingsAware:
+
settings = <ranger.ext.openstruct.OpenStruct object at 0x154e450>
+ +

+ + + + + +
 
+class NoDirectoryGiven(builtins.Exception)
    
Method resolution order:
+
NoDirectoryGiven
+
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
+
+

+ + + + + +
 
+Functions
       
sort_by_basename(path)
returns path.basename (for sorting)
+
sort_by_directory(path)
returns 0 if path is a directory, otherwise 1 (for sorting)
+

+ + + + + +
 
+Data
       BAD_INFO = None
+ \ No newline at end of file -- cgit 1.4.1-2-gfad0