Class e.p.p.w.p.c.Control(gobject.GObject):

Part of elisa.plugins.poblesec.widgets.player.control_ribbon View In Hierarchy

Known subclasses: elisa.plugins.poblesec.slideshow_controls.RotationControl, elisa.plugins.poblesec.slideshow_controls.ShowNextControl, elisa.plugins.poblesec.slideshow_controls.ShowPreviousControl, elisa.plugins.poblesec.videoplayer_controls.MultiCaptionControl, elisa.plugins.poblesec.videoplayer_controls.PlayPauseControl, elisa.plugins.poblesec.videoplayer_controls.SkipNextControl, elisa.plugins.poblesec.videoplayer_controls.SkipPreviousControl, elisa.plugins.poblesec.videoplayer_controls.StopControl, elisa.plugins.poblesec.videoplayer_controls.VolumeDownControl, elisa.plugins.poblesec.videoplayer_controls.VolumeUpControl

An abstract class for controls acting on an object. On top of encapsulating the code that performs the operation in its activate method it also embeds graphical and textual representations of what it does. These representations can be used to attach the control to GUI elements such as buttons, labels, menus, etc.

Signals:

Instance Variablesslaveobject that the control will act on when activated (type: object )
glyphsdictionary of image resources indexed by states that graphically represent what the control does (type: dictionary of states: str )
captionlabel that represents what the control does (type: str )
Line # Kind Name Docs
62 Method __init__ Constructor.
77 Method caption__set Undocumented
81 Method caption__get Undocumented
86 Method glyphs__set Undocumented
90 Method glyphs__get Undocumented
95 Method activate Activating the action runs the action code attached to the control.
106 Method pre_activate Code run prior to control activation.
117 Method de_pre_activate Code run after control activation.
def __init__(self, controlled_object):
Constructor.
Parameterscontrolled_objectobject that the control will act on when activated (type: object )
def caption__set(self, caption):
Undocumented
def caption__get(self):
Undocumented
def glyphs__set(self, glyphs):
Undocumented
def glyphs__get(self):
Undocumented
def activate(self):
Activating the action runs the action code attached to the control. For example it can be the code executed when a button is clicked.

Control implementations have to override this method.

Returns (type: elisa.core.utils.defer.Deferred )
def pre_activate(self):
Code run prior to control activation. For example it can be the code executed when a button is pressed.

Control implementations have to override this method.

Returns (type: elisa.core.utils.defer.Deferred )
def de_pre_activate(self):
Code run after control activation. For example it can be the code executed when a button is released.

Control implementations have to override this method.

Returns (type: elisa.core.utils.defer.Deferred )
API Documentation for Elisa Media Center, generated by pydoctor at 2009-02-16 19:15:05.