ranger.gui.displayable
index
/home/hut/work/ranger/ranger/gui/displayable.py

 
Classes
       
builtins.Exception(builtins.BaseException)
OutOfBoundsException
ranger.shared.EnvironmentAware(ranger.shared.Awareness)
Displayable(ranger.shared.EnvironmentAware, ranger.shared.FileManagerAware, ranger.shared.settings.SettingsAware)
DisplayableContainer
ranger.shared.FileManagerAware(ranger.shared.Awareness)
Displayable(ranger.shared.EnvironmentAware, ranger.shared.FileManagerAware, ranger.shared.settings.SettingsAware)
DisplayableContainer
ranger.shared.settings.SettingsAware(builtins.object)
Displayable(ranger.shared.EnvironmentAware, ranger.shared.FileManagerAware, ranger.shared.settings.SettingsAware)
DisplayableContainer

 
class Displayable(ranger.shared.EnvironmentAware, ranger.shared.FileManagerAware, ranger.shared.settings.SettingsAware)
    
Method resolution order:
Displayable
ranger.shared.EnvironmentAware
ranger.shared.FileManagerAware
ranger.shared.Awareness
ranger.shared.settings.SettingsAware
builtins.object

Methods defined here:
__contains__(self, item)
Is item inside the boundaries?
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
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
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!
finalize(self)
Called after every displayable is done drawing.
Override this!
poke(self)
Called before drawing, even if invisible
press(self, key)
Called when a key is pressed and self.focused is True.
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

Data and other attributes inherited from ranger.shared.FileManagerAware:
fm = None

Data descriptors inherited from ranger.shared.Awareness:
__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.settings.SettingsAware:
settings = <ranger.ext.openstruct.OpenStruct object at 0x154e450>

 
class DisplayableContainer(Displayable)
    
Method resolution order:
DisplayableContainer
Displayable
ranger.shared.EnvironmentAware
ranger.shared.FileManagerAware
ranger.shared.Awareness
ranger.shared.settings.SettingsAware
builtins.object

Methods defined here:
__init__(self, win, env=None, fm=None, settings=None)
add_obj(self, *objs)
click(self, event)
Recursively called on objects in container
destroy(self)
Recursively called on objects in container
draw(self)
Recursively called on visible objects in container
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

Methods inherited from 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.
__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
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
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

Data and other attributes inherited from ranger.shared.FileManagerAware:
fm = None

Data descriptors inherited from ranger.shared.Awareness:
__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.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__(...)
__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
       
combine(seq, tup)
Add seq and tup. Ensures that the result is a tuple.