Class e.p.p.w.p.c.ControlRibbon(VBox):

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

Control ribbon widget for the player. It displays a list of actions and keeps track of the selected one.
Instance Variablesbuttonshorizontal box containing the control buttons (type: elisa.plugins.pigment.widgets.box.HBox )
captiontext displaying the meaning of the selected action (type: elisa.plugins.pigment.graph.text.Text )
selected_controlcontrol currently selected (type: Control )
animatedimplicit animation object linked to the ribbon (type: pgm.timing.implicit.AnimatedObject )
Line # Kind Name Docs
143 Method __init__ Set the default styles for the widget. Subclasses should override and
207 Method clean Undocumented
236 Method controls Undocumented
239 Method add_control Append a control to the ribbon. As a visual representation of the
307 Method remove_control Remove a Control from the ribbon. All signals connected to
332 Method is_visible Is the control ribbon shown or not to the user.
343 Method hide Hide the control ribbon using a smooth fade out.
349 Method show Show the control ribbon using a smooth fade in.
360 Method select_next_control Select the next control in the list of controls that were added to
377 Method select_previous_control Select the previous control in the list of controls that were added to
215 Method _update_caption Undocumented
221 Method _control_clicked Undocumented
226 Method _control_pressed Undocumented
231 Method _control_released Undocumented
396 Class Method _demo_widget Meant to be overidden by inheriting widgets for widget creation and

Inherited from VBox:

Line # Kind Name Docs
412 Method _layout Undocumented

Inherited from Box (via VBox):

Line # Kind Name Docs
160 Method pack_start Add widget to the box packed after any other widget packed using
177 Method pack_end Add widget to the box packed after any other widget packed using
194 Method remove Undocumented
211 Method pop Undocumented
234 Method __len__ Undocumented
237 Method __contains__ Undocumented
265 Method spacing__get Undocumented
268 Method spacing__set Undocumented
274 Method alignment__get Undocumented
277 Method alignment__set Undocumented
102 Method _update_style_properties Update the widget's appearence basing on the properties set.
117 Method _queue_layout Undocumented
127 Method _resized_callback Undocumented
130 Method _repositioned_callback Undocumented
133 Method _child_resized_callback Undocumented
136 Method _child_changed_callback Undocumented
145 Method _disconnect_child Undocumented
225 Method _remove_packed_child Undocumented
248 Method _insert_new_child Undocumented
287 Method _prelayout_children Compute the size of children packed with expand set to True and the

Inherited from Widget (via VBox, Box):

Line # Kind Name Docs
135 Method state__get The present state of the widget
139 Method state__set Set the state of the widget and emit the "state-changed" signal if
156 Method do_state_changed Default 'state-changed' handler
163 Method style__get The present style
167 Method style__set Set the present style, after binding it to the widget and subscribing
187 Method do_style_set Default 'style-set' signal handler
209 Method get_parent Get the parent, if exists.
217 Method get_children Get the list of direct children.
225 Method get_root Get the root of the widget's tree hierarchy
236 Method get_descendants Get the list of nodes in the subtree
250 Method focus__get Whether the widget has focus
254 Method focus__set Set or unset the focus on the widget and emit the 'focus' signal.
282 Method focus_child__get Get the child with focus
290 Method do_key_press_event Default 'key-press-event' signal handler.
353 Class Method demo Create a demo widget, put it on a canvas and show it in a viewport.
92 Method _init_styles Undocumented
183 Method _style_property_changed Undocumented
302 Method _do_real_key_press_event Undocumented
306 Class Method _demo_create_viewport Undocumented
313 Class Method _on_demo_delete Undocumented
332 Class Method _set_demo_widget_defaults Undocumented

Inherited from Group (via VBox, Box, Widget):

Line # Kind Name Docs
82 Method canvas__set Undocumented
102 Method canvas__get Undocumented
107 Method layer__set Undocumented
120 Method layer__get Undocumented
128 Method add Undocumented
176 Method empty Undocumented
189 Method __iter__ Undocumented
192 Method update_absolute_x Undocumented
199 Method update_absolute_y Undocumented
206 Method update_absolute_z Undocumented
213 Method update_absolute_position Undocumented
220 Method update_absolute_width Undocumented
229 Method update_absolute_height Undocumented
238 Method update_absolute_size Undocumented
247 Method update_absolute_visible Undocumented
252 Method update_absolute_opacity Undocumented
258 Method regenerate Undocumented
262 Method absolute_width__get Undocumented
265 Method absolute_width__set Undocumented
270 Method absolute_height__get Undocumented
273 Method absolute_height__set Undocumented
278 Method absolute_x__get Undocumented
281 Method absolute_x__set Undocumented
287 Method absolute_y__get Undocumented
290 Method absolute_y__set Undocumented
296 Method absolute_z__get Undocumented
299 Method absolute_z__set Undocumented
150 Method _proxy_child_signal_scrolled Undocumented
154 Method _proxy_child_signal Undocumented
158 Method _proxy_child_signal_with_pressure Undocumented

Inherited from Node (via VBox, Box, Widget, Group):

Line # Kind Name Docs
37 Method parent__set Undocumented
57 Method parent__get Undocumented
62 Method x__get Undocumented
68 Method x__set Undocumented
84 Method y__get Undocumented
90 Method y__set Undocumented
107 Method z__get Undocumented
113 Method z__set Undocumented
130 Method position__get Undocumented
136 Method position__set Undocumented
160 Method width__get Undocumented
166 Method width__set Undocumented
184 Method height__get Undocumented
190 Method height__set Undocumented
210 Method size__get Undocumented
216 Method size__set Undocumented
236 Method visible__get Undocumented
242 Method visible__set Undocumented
260 Method opacity__get Undocumented
266 Method opacity__set Undocumented
def __init__(self):
Set the default styles for the widget. Subclasses should override and call "self._update_style_properties()" after calling this base class constructor.
def clean(self):
Undocumented
def _update_caption(self):
Undocumented
def _control_clicked(self, notifier, x, y, z, button, time, pressure, control):
Undocumented
def _control_pressed(self, notifier, x, y, z, button, time, pressure, control):
Undocumented
def _control_released(self, notifier, x, y, z, button, time, control):
Undocumented
@property
def controls(self):
Undocumented
def add_control(self, control):

Append a control to the ribbon. As a visual representation of the control a button will be added to the ribbon. The ribbon's buttons are of type elisa.plugins.poblesec.widgets.player.button.Button and constantly reflect their associated control.

The buttons are forced to be visually square.
Parameterscontrolcontrol to be added to the ribbon (type: Control )
def remove_control(self, control):
Remove a Control from the ribbon. All signals connected to its button are also disconnected and the widget is removed from the buttons hbox.
Parameterscontrolcontrol to be added to the ribbon (type: Control )
@property
def is_visible(self):
Is the control ribbon shown or not to the user. Note: this is not named "visible" to avoid interfering with the Pigment Graph dark magic.
Returnswhether or not the ribbon is visible (type: bool )
def hide(self):
Hide the control ribbon using a smooth fade out.
def show(self):
Show the control ribbon using a smooth fade in.
def select_next_control(self):
Select the next control in the list of controls that were added to the ribbon. They are sorted from first added to last added.
def select_previous_control(self):
Select the previous control in the list of controls that were added to the ribbon. They are sorted from first added to last added.
@classmethod
def _demo_widget(cls, *args, **kwargs):
Meant to be overidden by inheriting widgets for widget creation and setup at demo time.
Returnselisa.plugins.pigment.widgets.Widget
API Documentation for Elisa Media Center, generated by pydoctor at 2008-10-13 19:16:17.