Part of elisa.plugins.pigment.widgets.box View In Hierarchy
Known subclasses: elisa.plugins.pigment.widgets.box.HBox, elisa.plugins.pigment.widgets.box.VBox
Box is an abstract widget that defines a specific kind of container that
layouts a variable number of widgets into a rectangular area. The former is
organized into either a single row or a single column of child widgets
depending upon whether the box is of type HBox
or
VBox
,
respectively.
Instance Variables | spacing | amount of space between children (type: int ) |
alignment | defines where the children are positioned in the rectangular area of the
box
(type: ALIGNMENT
) |
Line # | Kind | Name | Docs |
---|---|---|---|
79 | Method | __init__ | Set the default styles for the widget. Subclasses should override and |
149 | Method | clean | Undocumented |
160 | Method | pack_start | Add widget to
the box packed after any other widget packed using
|
177 | Method | pack_end | Add widget to
the box packed after any other widget packed using
|
194 | Method | remove | Undocumented |
211 | Method | pop | Undocumented |
234 | Method | __len__ | Undocumented |
237 | Method | __contains__ | Undocumented |
265 | Method | spacing__get | Undocumented |
268 | Method | spacing__set | Undocumented |
274 | Method | alignment__get | Undocumented |
277 | Method | alignment__set | Undocumented |
102 | Method | _update_style_properties | Update the widget's appearence basing on the properties set. |
117 | Method | _queue_layout | Undocumented |
127 | Method | _resized_callback | Undocumented |
130 | Method | _repositioned_callback | Undocumented |
133 | Method | _child_resized_callback | Undocumented |
136 | Method | _child_changed_callback | Undocumented |
145 | Method | _disconnect_child | Undocumented |
225 | Method | _remove_packed_child | Undocumented |
248 | Method | _insert_new_child | Undocumented |
283 | Method | _layout | Undocumented |
287 | Method | _prelayout_children | Compute the size of children packed with expand set to True and the |
338 | 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 |
161 | Method | do_state_changed | Default 'state-changed' handler |
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 |
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 |
192 | Method | empty | 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 |
Update the widget's appearence basing on the properties set.
This is intended to be overriden by subclasses, that will implement the actual code to bind style properties to widget ones.Parameters | props | the properties that have to be updated (type: dictionary of strings ==> anything ) |
widget
to
the box packed after any other widget packed using pack_start. Visually widget
will be positioned after any other widget packed that way.
Parameters | widget | widget to pack in the box
(type: elisa.plugins.pigment.widgets.widget.Widget
) |
expand | True if widget is to be given extra space allocated to box. The extra space will be divided evenly between all widgets of box that use this option. (type: bool ) |
widget
to
the box packed after any other widget packed using pack_end. Visually widget
will be positioned before any other widget packed that way.
Parameters | widget | widget to pack in the box
(type: elisa.plugins.pigment.widgets.widget.Widget
) |
expand | True if widget is to be given extra space allocated to box. The extra space will be divided evenly between all widgets of box that use this option. (type: bool ) |
Parameters | children | children for which to compute the value
(type: list of Child
) |
property | one of 'width', 'height' (type: str ) | |
Returns | (type: tuple of float ) |
Returns | elisa.plugins.pigment.widgets.Widget
|