Class e.p.p.w.r.Range(Widget):

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

Known subclasses: elisa.plugins.pigment.widgets.progressbar.ProgressBar, elisa.plugins.pigment.widgets.scrollbar.ScrollBar, elisa.plugins.pigment.widgets.slider.Slider

The range widget provides the common interface and implementation to set a value in a range of values.

Emit the signals:

Instance Variablesitems_numberthe number of items in the range (type: int )
current_indexthe current value, from 0 to (items_number - 1) (type: int )
Line # Kind Name Docs
49 Method __init__ Set the default styles for the widget. Subclasses should override and
76 Method update_style_properties Update the widget's appearence basing on the properties set.
149 Method items_number__get Undocumented
152 Method items_number__set Set the number of items in the range. Minumum is 1. If the range has
175 Method current_index__get Undocumented
178 Method current_index__set Set the position of the cursor. The bar is automatically new painted
262 Method do_index_changed Default 'index-changed' signal handler
266 Method do_scrolled Undocumented
273 Method do_key_press_event Default 'key-press-event' signal handler.
279 Method do_focus Undocumented
285 Method do_clicked Undocumented
95 Method _set_background Undocumented
115 Method _get_background Undocumented
120 Method _set_cursor Undocumented
144 Method _get_cursor Undocumented
193 Method _update_cursor_size Undocumented
212 Method _update_cursor_position Undocumented
229 Method _drag_begin Undocumented
238 Method _pressed Undocumented
241 Method _drag_motion Undocumented
255 Method _drag_end Undocumented
289 Method _get_index_from_position Undocumented
297 Class Method _demo_widget Meant to be overidden by inheriting widgets for widget creation and

Inherited from Widget:

Line # Kind Name Docs
134 Method state__get The present state of the widget
138 Method state__set Set the state of the widget and emit the "state-changed" signal if
155 Method do_state_changed Default 'state-changed' handler
162 Method style__get The present style
166 Method style__set Set the present style, after binding it to the widget and subscribing
193 Method do_style_set Default 'style-set' signal handler
312 Method get_parent Get the parent, if exists.
320 Method get_children Get the list of direct children.
328 Method get_root Get the root of the widget's tree hierarchy
339 Method get_descendants Get the list of nodes in the subtree
376 Method focus__get Whether the widget has focus
380 Method focus__set Set the focus state on the widget emitting the 'focus' signal on the
417 Method focus_child__get Get the child with focus
438 Method clean Undocumented
492 Class Method demo Create a demo widget, put it on a canvas and show it in a viewport.
96 Method _init_styles Undocumented
189 Method _style_property_changed Undocumented
198 Method _parse_style_key Parse a style property key into a couple (widget, attribute name).
236 Method _parse_style_value Parse a style property value.
353 Method _set_focused Set or unset the focused widget and update the focused child property of
435 Method _do_real_key_press_event Undocumented
445 Class Method _demo_create_viewport Undocumented
452 Class Method _on_demo_delete Undocumented
471 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
95 Method parent__get Undocumented
100 Method x__get Undocumented
106 Method x__set Undocumented
122 Method y__get Undocumented
128 Method y__set Undocumented
145 Method z__get Undocumented
151 Method z__set Undocumented
168 Method position__get Undocumented
174 Method position__set Undocumented
198 Method width__get Undocumented
204 Method width__set Undocumented
222 Method height__get Undocumented
228 Method height__set Undocumented
248 Method size__get Undocumented
254 Method size__set Undocumented
274 Method visible__get Undocumented
280 Method visible__set Undocumented
297 Method opacity__get Undocumented
303 Method opacity__set Undocumented
def __init__(self):
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):
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 _set_background(self, background):
Undocumented
def _get_background(self):
Undocumented
def _set_cursor(self, cursor):
Undocumented
def _get_cursor(self):
Undocumented
def items_number__get(self):
Undocumented
def items_number__set(self, nb):
Set the number of items in the range. Minumum is 1. If the range has shrunk too much, reset the curren index
Parametersnbthe number of items (type: int )
def current_index__get(self):
Undocumented
def current_index__set(self, position):
Set the position of the cursor. The bar is automatically new painted
Parameterspositionthe position to set to (type: int )
def _update_cursor_size(self):
Undocumented
def _update_cursor_position(self):
Undocumented
def _drag_begin(self, widget, x, y, z, button, time, pressure):
Undocumented
def _pressed(self, widget, x, y, z, button, time, pressure):
Undocumented
def _drag_motion(self, widget, x, y, z, button, time, pressure):
Undocumented
def _drag_end(self, widget, x, y, z, button, time):
Undocumented
def do_index_changed(self, current, previous):
Default 'index-changed' signal handler
def do_scrolled(self, x, y, z, direction, time):
Undocumented
def do_key_press_event(self, viewport, event, widget):
Default 'key-press-event' signal handler.

Forward the signal to the focused child, if any.

def do_focus(self, value):
Undocumented
def do_clicked(self, x, y, z, button, time, pressure):
Undocumented
def _get_index_from_position(self, x, y, z):
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 2009-02-16 19:15:05.