Class e.p.p.w.p.b.Button(Widget):

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

3 states button widget starring a background and an overlaid glyph. A different couple (background, glyph) is displayed for each state among:

Button is by default in STATE_NORMAL. When hovering it it goes to STATE_SELECTED. When pressed it then goes to STATE_ACTIVE.

Instance Variablesstickyif True the button will stay in STATE_SELECTED state after the mouse stopped hovering it, otherwise it will go to STATE_NORMAL (type: bool )
alignmentalignement of the background images (type: pgm.IMAGE_ALIGNMENT )
Line # Kind Name Docs
47 Method __init__ Set the default styles for the widget. Subclasses should override and
97 Method clean Undocumented
138 Method set_glyphs Load the resources normal, selected and active into their
161 Method set_backgrounds Load the resources normal, selected and active into their
184 Method do_state_changed Default 'state-changed' handler
198 Method do_pressed Undocumented
203 Method do_clicked Undocumented
206 Method do_released Undocumented
102 Method _set_alignment Undocumented
109 Method _get_alignment Undocumented
114 Method _add_background Add a background Image drawable for state.
126 Method _add_glyph Add a glyph Image drawable for state.
210 Method _entered Undocumented
214 Method _left Undocumented
220 Class Method _demo_widget Meant to be overidden by inheriting widgets for widget creation and

Inherited from Widget:

Line # Kind Name Docs
140 Method state__get The present state of the widget
144 Method state__set Set the state of the widget and emit the "state-changed" signal if
168 Method style__get The present style
172 Method style__set Set the present style, after binding it to the widget and subscribing
199 Method do_style_set Default 'style-set' signal handler
221 Method get_parent Get the parent, if exists.
229 Method get_children Get the list of direct children.
237 Method get_root Get the root of the widget's tree hierarchy
248 Method get_descendants Get the list of nodes in the subtree
285 Method focus__get Whether the widget has focus
289 Method focus__set Set the focus state on the widget emitting the 'focus' signal on the
326 Method focus_child__get Get the child with focus
332 Method do_key_press_event Default 'key-press-event' signal handler.
401 Class Method demo Create a demo widget, put it on a canvas and show it in a viewport.
97 Method _init_styles Undocumented
195 Method _style_property_changed Undocumented
204 Method _update_style_properties Update the widget's appearence basing on the properties set.
262 Method _set_focused Set or unset the focused widget and update the focused child property of
344 Method _do_real_key_press_event Undocumented
354 Class Method _demo_create_viewport Undocumented
361 Class Method _on_demo_delete Undocumented
380 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
39 Method absolute_width__get Undocumented
42 Method absolute_width__set Undocumented
47 Method absolute_height__get Undocumented
50 Method absolute_height__set Undocumented
55 Method absolute_x__get Undocumented
58 Method absolute_x__set Undocumented
64 Method absolute_y__get Undocumented
67 Method absolute_y__set Undocumented
73 Method absolute_z__get Undocumented
76 Method absolute_z__set Undocumented
82 Method parent__set Undocumented
102 Method parent__get Undocumented
107 Method x__get Undocumented
113 Method x__set Undocumented
129 Method y__get Undocumented
135 Method y__set Undocumented
152 Method z__get Undocumented
158 Method z__set Undocumented
175 Method position__get Undocumented
181 Method position__set Undocumented
205 Method width__get Undocumented
211 Method width__set Undocumented
229 Method height__get Undocumented
235 Method height__set Undocumented
255 Method size__get Undocumented
261 Method size__set Undocumented
281 Method visible__get Undocumented
287 Method visible__set Undocumented
305 Method opacity__get Undocumented
311 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 _set_alignment(self, value):
Undocumented
def _get_alignment(self):
Undocumented
def _add_background(self, state):
Add a background Image drawable for state.
def _add_glyph(self, state):
Add a glyph Image drawable for state.
def set_glyphs(self, normal, selected, active):
Load the resources normal, selected and active into their corresponding glyph drawables.
Parametersnormalimage resource to be used for STATE_NORMAL state (type: str )
selectedimage resource to be used for STATE_SELECTED state (type: str )
activeimage resource to be used for STATE_ACTIVE state (type: str )
def set_backgrounds(self, normal, selected, active):
Load the resources normal, selected and active into their corresponding background drawables.
Parametersnormalimage resource to be used for STATE_NORMAL state (type: str )
selectedimage resource to be used for STATE_SELECTED state (type: str )
activeimage resource to be used for STATE_ACTIVE state (type: str )
def do_state_changed(self, previous_state):
Default 'state-changed' handler
def do_pressed(self, x, y, z, button, time, pressure):
Undocumented
def do_clicked(self, x, y, z, button, time, pressure):
Undocumented
def do_released(self, x, y, z, button, time):
Undocumented
def _entered(self, mouse_area, x, y, z, time):
Undocumented
def _left(self, mouse_area, x, y, z, time):
Undocumented
@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-12-15 12:25:45.