Class e.p.p.w.l.List(Widget):

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

Known subclasses: elisa.plugins.pigment.widgets.list_carrousel.ListCarrousel, elisa.plugins.pigment.widgets.list_horizontal.ListHorizontal, elisa.plugins.pigment.widgets.list_vertical.ListVertical, elisa.plugins.poblesec.base.coverflow.CoverflowList, elisa.plugins.poblesec.player_slideshow.ListFading

Abstract list widget. It displays data stored in the model list. Items of model are rendered into widgets instances of the widget class passed to the constructor using the specified renderer function.

Usage example for a list of strings rendered in Text drawables:

   l = List(Text)

   def renderer(item, widget):
       widget.label = str(item)
       widget.bg_a = 0

   model = range(100)

   l.set_renderer(renderer)
   l.set_model(model)

Emit the signals:

Instance Variablesselected_item_indexindex of the currently selected item in the model (type: int )
visible_range_sizenumber of rendered items (type: float )
modellist of data items that is rendered by the list widget (type: list )
drag_motion_resolutionminimum time between 2 drag events in milliseconds (type: int )
drag_thresholdamount of movement needed to activate dragging in canvas coordinates (type: float )
animatedTrue if the list is animated, False otherwise (type: bool )
preloadednumber of items that are prerendered before they become visible (type: int )
focus_on_clickwhether the button will grab focus when clicked (type: bool )
Line # Kind Name Docs
93 Method __init__
142 Method set_model Set the list of items that are rendered by the list widget. Further
167 Method set_renderer Function used by the list widget to render an item of the model. It
182 Method set_selector Undocumented
321 Method visible_range_start__get Undocumented
324 Method visible_range_start__set Undocumented
344 Method visible_range_size__get Undocumented
347 Method visible_range_size__set Undocumented
389 Method selected_item_index__get Undocumented
392 Method selected_item_index__set Undocumented
509 Method compute_opacity Undocumented
545 Method visible__set Undocumented
556 Method do_focus Undocumented
559 Method do_released Undocumented
564 Method do_scrolled Undocumented
573 Method do_drag_begin Undocumented
588 Method do_drag_end Undocumented
599 Method do_item_clicked Undocumented
605 Method do_selected_item_changed Undocumented
686 Method clean Undocumented
207 Method _connect_widget Undocumented
212 Method _connect_widget_signal_to_own_with_model
224 Method _emit_item_clicked Undocumented
233 Method _on_items_changed Undocumented
239 Method _on_items_deleted Undocumented
253 Method _on_items_inserted Undocumented
280 Method _on_items_reordered Undocumented
283 Method _move_widgets_from_beginning_to_end Undocumented
288 Method _move_widgets_from_end_to_beginning Undocumented
293 Method _item_index_from_widget_index Undocumented
297 Method _widget_index_from_item_index Undocumented
301 Method _render_widgets Undocumented
311 Method _render_all_widgets Undocumented
357 Method _create_and_render_all Undocumented
373 Method _create_widgets Undocumented
382 Method _destroy_widgets Undocumented
426 Method _selected_to_range_start Undocumented
436 Method _range_start_to_selected Undocumented
443 Method _prepare_widget Undocumented
446 Method _prepare_selector Undocumented
449 Method _layout_widget Undocumented
452 Method _layout_all_widgets Undocumented
474 Method _layout_selector Undocumented
489 Method _set_selector_opacity Undocumented
498 Method _set_selector_visibility Undocumented
612 Method _decelerate Undocumented
639 Method _stop_deceleration Undocumented
646 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
275 Method update_style_properties Update the widget's appearence basing on the properties set.
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
423 Method do_key_press_event Default 'key-press-event' signal handler.
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
297 Method opacity__get Undocumented
303 Method opacity__set Undocumented
def __init__(self, widget_class, visible_range_size=7):
Parameterswidget_classwidget type used to render the items of the model (type: type inheriting from elisa.plugins.pigment.widgets.widget.Widget )
visible_range_sizeDOCME (type: int )
def set_model(self, model):
Set the list of items that are rendered by the list widget. Further updates to the model are automatically picked up by the list widget.
Parametersmodellist of items that should be rendered by the list widget (type: list )
def set_renderer(self, renderer):
Function used by the list widget to render an item of the model. It takes an item of the model as the first argument and an instance of the widget class passed to the constructor of the list widget as the second argument.
Parametersrendererfunction called to render an item of the model to the widget used for rendering (type: callable )
def set_selector(self, selector):
Undocumented
def _connect_widget(self, widget):
Undocumented
def _connect_widget_signal_to_own_with_model(self, widget, widget_signal, local_signal):
Parameterswidgetthe widget to connect to (type: elisa.plugins.pigment.widgets.widget.Widget )
widget_signalthe name of the signal of the widget (type: str )
local_signalthe name of the signal of the list (type: str )
def _emit_item_clicked(self, widget, *args):
Undocumented
def _on_items_changed(self, notifier, index, items):
Undocumented
def _on_items_deleted(self, notifier, index, items):
Undocumented
def _on_items_inserted(self, notifier, index, items):
Undocumented
def _on_items_reordered(self, notifier):
Undocumented
def _move_widgets_from_beginning_to_end(self, number):
Undocumented
def _move_widgets_from_end_to_beginning(self, number):
Undocumented
def _item_index_from_widget_index(self, widget_index):
Undocumented
def _widget_index_from_item_index(self, item_index):
Undocumented
def _render_widgets(self, start, end):
Undocumented
def _render_all_widgets(self):
Undocumented
def visible_range_start__get(self):
Undocumented
def visible_range_start__set(self, visible_range_start):
Undocumented
def visible_range_size__get(self):
Undocumented
def visible_range_size__set(self, visible_range_size):
Undocumented
def _create_and_render_all(self):
Undocumented
def _create_widgets(self):
Undocumented
def _destroy_widgets(self):
Undocumented
def selected_item_index__get(self):
Undocumented
def selected_item_index__set(self, index):
Undocumented
def _selected_to_range_start(self, selected):
Undocumented
def _range_start_to_selected(self, range_start):
Undocumented
def _prepare_widget(self, widget):
Undocumented
def _prepare_selector(self):
Undocumented
def _layout_widget(self, widget, position):
Undocumented
def _layout_all_widgets(self):
Undocumented
def _layout_selector(self):
Undocumented
def _set_selector_opacity(self):
Undocumented
def _set_selector_visibility(self):
Undocumented
def compute_opacity(self, index):
Undocumented
def visible__set(self, value):
Undocumented
def do_focus(self, focus):
Undocumented
def do_released(self, x, y, z, button, time):
Undocumented
def do_scrolled(self, x, y, z, direction, time):
Undocumented
def do_drag_begin(self, x, y, z, button, time, pressure):
Undocumented
def do_drag_end(self, x, y, z, button, time):
Undocumented
def do_item_clicked(self, item):
Undocumented
def do_selected_item_changed(self, item, prev_item):
Undocumented
def _decelerate(self):
Undocumented
def _stop_deceleration(self):
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
def clean(self):
Undocumented
API Documentation for Elisa Media Center, generated by pydoctor at 2009-02-16 19:15:05.