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 Variables | selected_item_index | index of the currently selected item in the model
(type: int
) |
visible_range_size | number of rendered items
(type: float
) | |
model | list of data items that is rendered by the list widget
(type: list
) | |
drag_motion_resolution | minimum time between 2 drag events in milliseconds
(type: int
) | |
drag_threshold | amount of movement needed to activate dragging in canvas coordinates
(type: float
) | |
animated | True if the list is animated, False otherwise
(type: bool
) | |
preloaded | number of items that are prerendered before they become visible
(type: int
) | |
focus_on_click | whether 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 |
Parameters | widget_class | widget type used to render the items of the model
(type: type inheriting from elisa.plugins.pigment.widgets.widget.Widget
) |
visible_range_size | DOCME (type: int ) |
Parameters | model | list of items that should be rendered by the list widget (type: list ) |
Parameters | renderer | function called to render an item of the model to the widget used for rendering (type: callable ) |
Parameters | widget | the widget to connect to (type: elisa.plugins.pigment.widgets.widget.Widget ) |
widget_signal | the name of the signal of the widget (type: str ) | |
local_signal | the name of the signal of the list (type: str ) |
Returns | elisa.plugins.pigment.widgets.Widget
|