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

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.

Use repeated calls to gtk_box_pack_start to pack widgets from start to end. Use gtk_box_pack_end to add widgets from end to start.

Instance Variablesspacingamount of space between children (type: int )
alignmentdefines 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
96 Method create_widgets Override this method in subclasses to create subwidgets.
102 Method update_style_properties Update the widget's appearence basing on the properties set.
143 Method clean Undocumented
150 Method pack_start Add widget to the box packed after any other widget packed using
167 Method pack_end Add widget to the box packed after any other widget packed using
184 Method remove Undocumented
201 Method pop Undocumented
224 Method __len__ Undocumented
227 Method __contains__ Undocumented
257 Method spacing__get Undocumented
260 Method spacing__set Undocumented
266 Method alignment__get Undocumented
269 Method alignment__set Undocumented
117 Method _queue_layout Undocumented
127 Method _child_resized_callback Undocumented
130 Method _child_changed_callback Undocumented
139 Method _disconnect_child Undocumented
215 Method _remove_packed_child Undocumented
238 Method _insert_new_child Undocumented
244 Method _connect_to_child_signals Undocumented
275 Method _layout Undocumented
279 Method _prelayout_children Compute the size of children packed with expand set to True and the
330 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
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
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
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 create_widgets(self):
Override this method in subclasses to create subwidgets.
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 _queue_layout(self):
Undocumented
def _child_resized_callback(self, notifier, width, height):
Undocumented
def _child_changed_callback(self, notifier, property):
Undocumented
def _disconnect_child(self, child):
Undocumented
def clean(self):
Undocumented
def pack_start(self, widget, expand=False):
Add 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.
Parameterswidgetwidget to pack in the box (type: elisa.plugins.pigment.widgets.widget.Widget )
expandTrue 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 )
def pack_end(self, widget, expand=False):
Add 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.
Parameterswidgetwidget to pack in the box (type: elisa.plugins.pigment.widgets.widget.Widget )
expandTrue 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 )
def remove(self, widget):
Undocumented
def pop(self):
Undocumented
def _remove_packed_child(self, idx, child_list):
Undocumented
def __len__(self):
Undocumented
def __contains__(self, widget):
Undocumented
def _insert_new_child(self, child):
Undocumented
def _connect_to_child_signals(self, child):
Undocumented
def spacing__get(self):
Undocumented
def spacing__set(self, spacing):
Undocumented
def alignment__get(self):
Undocumented
def alignment__set(self, alignment):
Undocumented
def _layout(self):
Undocumented
def _prelayout_children(self, children, property):
Compute the size of children packed with expand set to True and the coordinate at which the first widget should be positioned depending on the number of children, their expand mode and the box alignment.
Parameterschildrenchildren for which to compute the value (type: list of Child )
propertyone of 'width', 'height' (type: str )
Returns (type: tuple of float )
@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.