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

Part of elisa.plugins.pigment.widgets.button View In Hierarchy

A simple button with one image and/or one label.
Instance Variablesimagethe path to the image to display (type: string )
labelthe button's label (type: string )
focus_on_clickwhether the button will grab focus when clicked (type: boolean )
Line # Kind Name Docs
42 Method __init__ Add a background drawable to always get the events.
75 Method update_style_properties Update the widget's appearence basing on the properties set.
93 Method image__get The path of the image
97 Method image__set Set the image at the specified path, creating the
127 Method label__get Get the text of the label
135 Method label__set Set the label text
154 Method do_focus Undocumented
160 Method do_clicked Undocumented
167 Method do_pressed Undocumented
173 Method do_released Undocumented
180 Method do_key_press_event Default 'key-press-event' signal handler.
188 Class Method _demo_widget Meant to be overidden by inheriting widgets for widget creation and

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
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
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__
Add a background drawable to always get the events.
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 image__get(self):
The path of the image
def image__set(self, value):
Set the image at the specified path, creating the elisa.plugins.pigment.graph.image.Image object, adding it to the scenegraph and associating an pgm.timing.implicit.Animated object.
Parametersvaluethe path of the image (type: string )
def label__get(self):
Get the text of the label
def label__set(self, value):
Set the label text
def do_focus(self, value):
Undocumented
def do_clicked(self, x, y, z, button, time, pressure):
Undocumented
def do_pressed(self, x, y, z, button, time, pressure):
Undocumented
def do_released(self, x, y, z, button, time):
Undocumented
def do_key_press_event(self, viewport, event, widget):
overrides elisa.plugins.pigment.widgets.widget.Widget.do_key_press_event
Default 'key-press-event' signal handler.

Forward the signal to the focused child, if any.

@classmethod
def _demo_widget(cls, *args, **kwargs):
overrides elisa.plugins.pigment.widgets.widget.Widget._demo_widget
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 2009-04-27 17:55:12.