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.widgets.titlebar.html | 233 +++-------------------------- 1 file changed, 23 insertions(+), 210 deletions(-) (limited to 'doc/pydoc/ranger.gui.widgets.titlebar.html') diff --git a/doc/pydoc/ranger.gui.widgets.titlebar.html b/doc/pydoc/ranger.gui.widgets.titlebar.html index c7052477..fc12df2a 100644 --- a/doc/pydoc/ranger.gui.widgets.titlebar.html +++ b/doc/pydoc/ranger.gui.widgets.titlebar.html @@ -9,8 +9,9 @@  
ranger.gui.widgets.titlebar
index
/home/hut/work/ranger/ranger/gui/widgets/titlebar.py
-

The TitleBar widget displays the current path and some other useful
-information.

+

The titlebar is the widget at the top, giving you broad orientation.

+It displays the current path among other things.

@@ -19,19 +20,6 @@ information.

       
-
builtins.list(builtins.object) -
-
-
BarSide -
-
-
builtins.object -
-
-
Bar -
ColoredString -
-
ranger.gui.widgets.Widget(ranger.gui.displayable.Displayable)
@@ -43,181 +31,6 @@ information.

- - -
 
-class Bar(builtins.object)
    Methods defined here:
-
__init__(self)
- -
add(self, *a, **kw)
- -
addright(self, *a, **kw)
- -
combine(self)
- -
fill_gap(self, char, wid, gapwidth=False)
- -
fixedsize(self)
- -
shrink_by_cutting(self, wid)
- -
shrink_by_removing(self, wid)
- -
sumsize(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:
-
gap = None
- -
left = None
- -
right = None
- -

- - - - - -
 
-class BarSide(builtins.list)
    
Method resolution order:
-
BarSide
-
builtins.list
-
builtins.object
-
-
-Methods defined here:
-
add(self, string, *lst, **kw)
- -
fixedsize(self)
- -
nonfixed_items(self)
- -
sumsize(self)
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables (if defined)
-
-
__weakref__
-
list of weak references to the object (if defined)
-
-
-Methods inherited from builtins.list:
-
__add__(...)
x.__add__(y) <==> x+y
- -
__contains__(...)
x.__contains__(y) <==> y in x
- -
__delitem__(...)
x.__delitem__(y) <==> del x[y]
- -
__eq__(...)
x.__eq__(y) <==> x==y
- -
__ge__(...)
x.__ge__(y) <==> x>=y
- -
__getattribute__(...)
x.__getattribute__('name') <==> x.name
- -
__getitem__(...)
x.__getitem__(y) <==> x[y]
- -
__gt__(...)
x.__gt__(y) <==> x>y
- -
__iadd__(...)
x.__iadd__(y) <==> x+=y
- -
__imul__(...)
x.__imul__(y) <==> x*=y
- -
__init__(...)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
- -
__iter__(...)
x.__iter__() <==> iter(x)
- -
__le__(...)
x.__le__(y) <==> x<=y
- -
__len__(...)
x.__len__() <==> len(x)
- -
__lt__(...)
x.__lt__(y) <==> x<y
- -
__mul__(...)
x.__mul__(n) <==> x*n
- -
__ne__(...)
x.__ne__(y) <==> x!=y
- -
__repr__(...)
x.__repr__() <==> repr(x)
- -
__reversed__(...)
L.__reversed__() -- return a reverse iterator over the list
- -
__rmul__(...)
x.__rmul__(n) <==> n*x
- -
__setitem__(...)
x.__setitem__(i, y) <==> x[i]=y
- -
__sizeof__(...)
L.__sizeof__() -- size of L in memory, in bytes
- -
append(...)
L.append(object) -- append object to end
- -
count(...)
L.count(value) -> integer -- return number of occurrences of value
- -
extend(...)
L.extend(iterable) -- extend list by appending elements from the iterable
- -
index(...)
L.index(value, [start, [stop]]) -> integer -- return first index of value.
-Raises ValueError if the value is not present.
- -
insert(...)
L.insert(index, object) -- insert object before index
- -
pop(...)
L.pop([index]) -> item -- remove and return item at index (default last).
-Raises IndexError if list is empty or index is out of range.
- -
remove(...)
L.remove(value) -- remove first occurrence of value.
-Raises ValueError if the value is not present.
- -
reverse(...)
L.reverse() -- reverse *IN PLACE*
- -
sort(...)
L.sort(key=None, reverse=False) -- stable sort *IN PLACE*
- -
-Data and other attributes inherited from builtins.list:
-
__hash__ = None
- -
__new__ = <built-in method __new__ of type object at 0x7f327d9523a0>
T.__new__(S, ...) -> a new object with type S, a subtype of T
- -

- - - - - -
 
-class ColoredString(builtins.object)
    Methods defined here:
-
__init__(self, string, *lst)
- -
__len__(self)
- -
__str__(self)
- -
cut_off(self, n)
- -
cut_off_to(self, n)
- -
-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:
-
fixed = False
- -

- - - @@ -228,6 +41,7 @@ Data and other attributes defined here:
ranger.shared.EnvironmentAware
ranger.shared.FileManagerAware
ranger.shared.Awareness
+
ranger.gui.curses_shortcuts.CursesShortcuts
ranger.shared.settings.SettingsAware
builtins.object
@@ -250,24 +64,21 @@ Data and other attributes defined here:

Methods inherited from ranger.gui.displayable.Displayable:
__contains__(self, item)
Is item inside the boundaries?
-item can be an iterable like [y, x] or an object with x and y methods.
+item can be an iterable like [y, x] or an object with x and y methods.
__init__(self, win, env=None, fm=None, settings=None)
__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
+
contains_point(self, y, x)
Test whether the point (with absolute coordinates) lies
+within the boundaries of this object.
-
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
- -
destroy(self)
Called when the object is destroyed.
+
destroy(self)
Called when the object is destroyed.
Override this!
finalize(self)
Called after every displayable is done drawing.
@@ -280,16 +91,6 @@ Override this!
resize(self, y, x, hei=None, wid=None)
Resize the widget
-
-Data and other attributes inherited from ranger.gui.displayable.Displayable:
-
colorscheme = None
- -
focused = False
- -
visible = True
- -
win = None
-
Data and other attributes inherited from ranger.shared.EnvironmentAware:
env = None
@@ -306,9 +107,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>
 
class TitleBar(ranger.gui.widgets.Widget)
    

-- cgit 1.4.1-2-gfad0