From 4c13e1f2d85483e026d79ab05da9f1e8e4b45293 Mon Sep 17 00:00:00 2001 From: hut Date: Sat, 2 Jan 2010 00:10:49 +0100 Subject: updated pydoc documentation --- doc/pydoc/ranger.gui.displayable.html | 224 ++++++++++++++++------------------ 1 file changed, 102 insertions(+), 122 deletions(-) (limited to 'doc/pydoc/ranger.gui.displayable.html') diff --git a/doc/pydoc/ranger.gui.displayable.html b/doc/pydoc/ranger.gui.displayable.html index a581fbeb..cbe29b2c 100644 --- a/doc/pydoc/ranger.gui.displayable.html +++ b/doc/pydoc/ranger.gui.displayable.html @@ -12,22 +12,24 @@

+ + + + +
 
+Modules
       
_curses
+

+
 
Classes
       
-
builtins.Exception(builtins.BaseException) +
ranger.gui.curses_shortcuts.CursesShortcuts(ranger.shared.settings.SettingsAware)
-
OutOfBoundsException -
-
-
ranger.shared.EnvironmentAware(ranger.shared.Awareness) -
-
-
Displayable(ranger.shared.EnvironmentAware, ranger.shared.FileManagerAware, ranger.shared.settings.SettingsAware) +
Displayable(ranger.shared.EnvironmentAware, ranger.shared.FileManagerAware, ranger.gui.curses_shortcuts.CursesShortcuts)
DisplayableContainer @@ -35,10 +37,10 @@
-
ranger.shared.FileManagerAware(ranger.shared.Awareness) +
ranger.shared.EnvironmentAware(ranger.shared.Awareness)
-
Displayable(ranger.shared.EnvironmentAware, ranger.shared.FileManagerAware, ranger.shared.settings.SettingsAware) +
Displayable(ranger.shared.EnvironmentAware, ranger.shared.FileManagerAware, ranger.gui.curses_shortcuts.CursesShortcuts)
DisplayableContainer @@ -46,10 +48,10 @@
-
ranger.shared.settings.SettingsAware(builtins.object) +
ranger.shared.FileManagerAware(ranger.shared.Awareness)
-
Displayable(ranger.shared.EnvironmentAware, ranger.shared.FileManagerAware, ranger.shared.settings.SettingsAware) +
Displayable(ranger.shared.EnvironmentAware, ranger.shared.FileManagerAware, ranger.gui.curses_shortcuts.CursesShortcuts)
DisplayableContainer @@ -62,14 +64,48 @@ +class Displayable(ranger.shared.EnvironmentAware, ranger.shared.FileManagerAware, ranger.gui.curses_shortcuts.CursesShortcuts) - + + +
 
-class Displayable(ranger.shared.EnvironmentAware, ranger.shared.FileManagerAware, ranger.shared.settings.SettingsAware)
    
   Displayables are objects which are displayed on the screen.
+ 
+This is just the abstract class, defining basic operations
+such as resizing, printing, changing colors.
+Subclasses of displayable can extend these methods:
+ 
+draw() -- draw the object. Is only called if visible.
+poke() -- is called just before draw(), even if not visible.
+finalize() -- called after all objects finished drawing.
+click(event) -- called with a MouseEvent. This is called on all
+        visible objects under the mouse, until one returns True.
+press(key) -- called after a key press on focused objects.
+destroy() -- called before destroying the displayable object
+ 
+Additionally, there are these methods:
+ 
+__contains__(item) -- is the item (y, x) inside the widget?
+ 
+These attributes are set:
+ 
+Modifiable:
+        focused -- Focused objects receive press() calls.
+        visible -- Visible objects receive draw() and finalize() calls
+        need_redraw -- Should the widget be redrawn? This variable may
+                be set at various places in the script and should eventually be
+                handled (and unset) in the draw() method.
+ 
+Read-Only: (i.e. reccomended not to change manually)
+        win -- the own curses window object
+        parent -- the parent (DisplayableContainer) object or None
+        x, y, wid, hei -- absolute coordinates and boundaries
+        settings, fm, env -- inherited shared variables
 
 
Method resolution order:
Displayable
ranger.shared.EnvironmentAware
ranger.shared.FileManagerAware
ranger.shared.Awareness
+
ranger.gui.curses_shortcuts.CursesShortcuts
ranger.shared.settings.SettingsAware
builtins.object
@@ -82,22 +118,20 @@ item can be an iterable like [y, x] or&n
__nonzero__(self)
Always True
+
__str__(self)
+
click(self, event)
Called when a mouse key is pressed and self.focused is True.
Override this!
-
color(self, keylist=None, *keys)
Change the colors from now on.
- -
color_at(self, y, x, wid, keylist=None, *keys)
Change the colors at the specified position
- -
color_reset(self)
Change the colors to the default colors
- -
contains_point(self, y, x)
Test if the point lies within the boundaries of this object
+
contains_point(self, y, x)
Test whether the point (with absolute coordinates) lies
+within the boundaries of this object.
destroy(self)
Called when the object is destroyed.
Override this!
-
draw(self)
Draw displayable.  Called on every main iteration if the object
-is visible.  Override this!
+
draw(self)
Draw the object. Called on every main iteration if visible.
+Containers should call draw() on their contained objects here.
+Override this!
finalize(self)
Called after every displayable is done drawing.
Override this!
@@ -109,16 +143,6 @@ Override this!
resize(self, y, x, hei=None, wid=None)
Resize the widget
-
-Data and other attributes defined here:
-
colorscheme = None
- -
focused = False
- -
visible = True
- -
win = None
-
Data and other attributes inherited from ranger.shared.EnvironmentAware:
env = None
@@ -135,9 +159,21 @@ Data descriptors inherited from ranger.sh
__weakref__
list of weak references to the object (if defined)
+
+Methods inherited from ranger.gui.curses_shortcuts.CursesShortcuts:
+
addnstr(self, *args)
+ +
addstr(self, *args)
+ +
color(self, keylist=None, *keys)
Change the colors from now on.
+ +
color_at(self, y, x, wid, keylist=None, *keys)
Change the colors at the specified position
+ +
color_reset(self)
Change the colors to the default colors
+
Data and other attributes inherited from ranger.shared.settings.SettingsAware:
-
settings = <ranger.ext.openstruct.OpenStruct object at 0x154e450>
+
settings = <ranger.ext.openstruct.OpenStruct object at 0x7f20a718ad90>

@@ -145,13 +181,29 @@ Data and other attributes inherited from class DisplayableContainer(Displayable) - + + +
    
   DisplayableContainers are Displayables which contain other Displayables.
+ 
+This is also an abstract class. The methods draw, poke, finalize,
+click, press and destroy are extended here and will recursively
+call the function on all contained objects.
+ 
+New methods:
+ 
+add_child(object) -- add the object to the container.
+remove_child(object) -- remove the object from the container.
+ 
+New attributes:
+ 
+container -- a list with all contained objects (rw)
 
 
Method resolution order:
DisplayableContainer
Displayable
ranger.shared.EnvironmentAware
ranger.shared.FileManagerAware
ranger.shared.Awareness
+
ranger.gui.curses_shortcuts.CursesShortcuts
ranger.shared.settings.SettingsAware
builtins.object
@@ -159,7 +211,7 @@ Data and other attributes inherited from __init__(self, win, env=None, fm=None, settings=None) -
add_obj(self, *objs)
+
add_child(self, obj)
Add the objects to the container.
click(self, event)
Recursively called on objects in container
@@ -169,15 +221,11 @@ Methods defined here:
finalize(self)
Recursively called on visible objects in container
-
get_focused_obj(self)
Finds a focused displayable object in the container.
-
poke(self)
Recursively called on objects in container
press(self, key)
Recursively called on objects in container
-
-Data and other attributes defined here:
-
container = None
+
remove_child(self, obj)
Remove the object from the container.
Methods inherited from Displayable:
@@ -186,26 +234,13 @@ item can be an iterable like [y, x] or&n
__nonzero__(self)
Always True
-
color(self, keylist=None, *keys)
Change the colors from now on.
- -
color_at(self, y, x, wid, keylist=None, *keys)
Change the colors at the specified position
+
__str__(self)
-
color_reset(self)
Change the colors to the default colors
- -
contains_point(self, y, x)
Test if the point lies within the boundaries of this object
+
contains_point(self, y, x)
Test whether the point (with absolute coordinates) lies
+within the boundaries of this object.
resize(self, y, x, hei=None, wid=None)
Resize the widget
-
-Data and other attributes inherited from Displayable:
-
colorscheme = None
- -
focused = False
- -
visible = True
- -
win = None
-
Data and other attributes inherited from ranger.shared.EnvironmentAware:
env = None
@@ -223,75 +258,20 @@ Data descriptors inherited from ranger.sh
list of weak references to the object (if defined)
-Data and other attributes inherited from ranger.shared.settings.SettingsAware:
-
settings = <ranger.ext.openstruct.OpenStruct object at 0x154e450>
- -

- - - - - -
 
-class OutOfBoundsException(builtins.Exception)
    
Method resolution order:
-
OutOfBoundsException
-
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__(...)
+Methods inherited from ranger.gui.curses_shortcuts.CursesShortcuts:
+
addnstr(self, *args)
-
__repr__(...)
x.__repr__() <==> repr(x)
+
addstr(self, *args)
-
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
- -
__setstate__(...)
+
color(self, keylist=None, *keys)
Change the colors from now on.
-
__str__(...)
x.__str__() <==> str(x)
+
color_at(self, y, x, wid, keylist=None, *keys)
Change the colors at the specified position
-
with_traceback(...)
Exception.with_traceback(tb) --
-set self.__traceback__ to tb and return self.
+
color_reset(self)
Change the colors to the default colors
-Data descriptors inherited from builtins.BaseException:
-
__cause__
-
exception cause
-
-
__context__
-
exception context
-
-
__dict__
-
-
__traceback__
-
-
args
-
-

- - - - - -
 
-Functions
       
combine(seq, tup)
Add seq and tup. Ensures that the result is a tuple.
-
+Data and other attributes inherited from ranger.shared.settings.SettingsAware:
+

settings = <ranger.ext.openstruct.OpenStruct object at 0x7f20a718ad90>
+ + \ No newline at end of file -- cgit 1.4.1-2-gfad0