Class e.p.p.p.PlayerOsd(Widget):

Part of elisa.plugins.poblesec.player_video View In Hierarchy

Known subclasses: elisa.plugins.poblesec.slideshow.player.PlayerOsd

On screen display widget for the player.

Signals:

Line # Kind Name Docs
240 Method __init__ Set the default styles for the widget. Subclasses should override and
288 Method update_style_properties Update the widget's appearence basing on the properties set.
316 Method hide Hide the OSD.
329 Method show Show the OSD. Optionally show ribbon controls, mouse controls and
367 Method is_shown Is the control ribbon shown or not to the user.

Inherited from Widget:

Line # Kind Name Docs
185 Method set_name Set the name of the widget and potentially update its style if name
196 Method state__get The present state of the widget
200 Method state__set Set the state of the widget and emit the "state-changed" signal if
217 Method do_state_changed Default 'state-changed' signal handler
222 Method style__get The present style
226 Method style__set Set the present style, after binding it to the widget and subscribing
252 Method do_style_set Default 'style-set' signal handler
383 Method get_parent Get the parent, if exists.
391 Method get_children Get the list of direct children.
399 Method get_root Get the root of the widget's tree hierarchy
410 Method get_descendants Get the list of nodes in the subtree
447 Method focus__get Whether the widget has focus
451 Method focus__set Set the focus state on the widget emitting the 'focus' signal on the
488 Method focus_child__get Get the child with focus
494 Method do_key_press_event Default 'key-press-event' signal handler.
509 Method clean Undocumented
562 Class Method demo Create a demo widget, put it on a canvas and show it in a viewport.
98 Class Method _init_class_styles Undocumented
130 Method _init_styles Undocumented
145 Method _merge_style_from_widget_name Merge styles specific to the instance's name if not None
171 Method _get_style_for_state Return a style corresponding to a given state.
248 Method _style_property_changed Undocumented
257 Method _parse_style_key Parse a style property key into a couple (widget, attribute name).
307 Method _parse_style_value Parse a style property value.
424 Method _set_focused Set or unset the focused widget and update the focused child property of
506 Method _do_real_key_press_event Undocumented
516 Class Method _demo_create_viewport Undocumented
522 Class Method _on_demo_delete Undocumented
530 Class Method _demo_widget Meant to be overidden by inheriting widgets for widget creation and
541 Class Method _set_demo_widget_defaults Undocumented

Inherited from Group (via Widget):

Line # Kind Name Docs
85 Method canvas__set Undocumented
105 Method canvas__get Undocumented
110 Method layer__set Undocumented
123 Method layer__get Undocumented
131 Method add Undocumented
173 Method remove Undocumented
192 Method empty Undocumented
202 Method __len__ Undocumented
205 Method __iter__ Undocumented
208 Method update_absolute_x Undocumented
215 Method update_absolute_y Undocumented
222 Method update_absolute_z Undocumented
229 Method update_absolute_position Undocumented
236 Method update_absolute_width Undocumented
245 Method update_absolute_height Undocumented
254 Method update_absolute_size Undocumented
263 Method update_absolute_visible Undocumented
268 Method update_absolute_opacity Undocumented
274 Method regenerate Undocumented
161 Method _proxy_child_signal_scrolled Undocumented
165 Method _proxy_child_signal Undocumented
169 Method _proxy_child_signal_with_pressure Undocumented

Inherited from Node (via Widget, Group):

Line # Kind Name Docs
40 Method absolute_width__get Undocumented
43 Method absolute_width__set Undocumented
48 Method absolute_height__get Undocumented
51 Method absolute_height__set Undocumented
56 Method absolute_x__get Undocumented
59 Method absolute_x__set Undocumented
65 Method absolute_y__get Undocumented
68 Method absolute_y__set Undocumented
74 Method absolute_z__get Undocumented
77 Method absolute_z__set Undocumented
83 Method parent__set Undocumented
96 Method parent__get Undocumented
101 Method x__get Undocumented
107 Method x__set Undocumented
123 Method y__get Undocumented
129 Method y__set Undocumented
146 Method z__get Undocumented
152 Method z__set Undocumented
169 Method position__get Undocumented
175 Method position__set Undocumented
199 Method width__get Undocumented
205 Method width__set Undocumented
223 Method height__get Undocumented
229 Method height__set Undocumented
249 Method size__get Undocumented
255 Method size__set Undocumented
275 Method visible__get Undocumented
281 Method visible__set Undocumented
302 Method opacity__get Undocumented
308 Method opacity__set Undocumented
336 Method animated__get Undocumented
def __init__(self):
overrides elisa.plugins.pigment.widgets.widget.Widget.__init__
Set the default styles for the widget. Subclasses should override and call "self.update_style_properties(self.style.get_items())" after calling this base class constructor.
def update_style_properties(self, props=None):
overrides elisa.plugins.pigment.widgets.widget.Widget.update_style_properties
Update the widget's appearence basing on the properties set.

By default all properties that can match a public member of the widget will be applied automatically. If custom style properties not matching real subwidgets/attributes need to be defined, this method should be overridden: the custom properties should be processed first, and then the remaining properties passed to the parent's update_style_properties method.

Parameterspropsthe properties that have to be updated (type: dictionary of strings ==> anything )
def hide(self):
Hide the OSD.
def show(self, timeout=True, with_ribbon=False, with_mouse=False, with_cover=False):
Show the OSD. Optionally show ribbon controls, mouse controls and cover overlay.
Parameterstimeoutwhether or not the OSD will hide automatically after time_before_hiding seconds (type: bool )
with_ribbonwhether or not to display ribbon controls
with_mousewhether or not to display mouse controls
with_coverwhether or not to display the cover overlay
Unknown Field: boolwith_ribbonbool
with_mousebool
with_coverbool
@property
def is_shown(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 )
API Documentation for Elisa Media Center, generated by pydoctor at 2009-04-27 17:55:12.