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
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
333 Class Method _demo_widget Meant to be overidden by inheriting widgets for widget creation and

Inherited from Widget:

Line # Kind Name Docs
135 Method state__get The present state of the widget
139 Method state__set Set the state of the widget and emit the "state-changed" signal if
156 Method do_state_changed Default 'state-changed' handler
163 Method style__get The present style
167 Method style__set Set the present style, after binding it to the widget and subscribing
187 Method do_style_set Default 'style-set' signal handler
209 Method get_parent Get the parent, if exists.
217 Method get_children Get the list of direct children.
225 Method get_root Get the root of the widget's tree hierarchy
236 Method get_descendants Get the list of nodes in the subtree
250 Method focus__get Whether the widget has focus
254 Method focus__set Set or unset the focus on the widget and emit the 'focus' signal.
282 Method focus_child__get Get the child with focus
290 Method do_key_press_event Default 'key-press-event' signal handler.
353 Class Method demo Create a demo widget, put it on a canvas and show it in a viewport.
92 Method _init_styles Undocumented
183 Method _style_property_changed Undocumented
302 Method _do_real_key_press_event Undocumented
306 Class Method _demo_create_viewport Undocumented
313 Class Method _on_demo_delete Undocumented
332 Class Method _set_demo_widget_defaults Undocumented

Inherited from Group (via Widget):

Line # Kind Name Docs
82 Method canvas__set Undocumented
102 Method canvas__get Undocumented
107 Method layer__set Undocumented
120 Method layer__get Undocumented
128 Method add Undocumented
176 Method empty Undocumented
189 Method __iter__ Undocumented
192 Method update_absolute_x Undocumented
199 Method update_absolute_y Undocumented
206 Method update_absolute_z Undocumented
213 Method update_absolute_position Undocumented
220 Method update_absolute_width Undocumented
229 Method update_absolute_height Undocumented
238 Method update_absolute_size Undocumented
247 Method update_absolute_visible Undocumented
252 Method update_absolute_opacity Undocumented
258 Method regenerate Undocumented
262 Method absolute_width__get Undocumented
265 Method absolute_width__set Undocumented
270 Method absolute_height__get Undocumented
273 Method absolute_height__set Undocumented
278 Method absolute_x__get Undocumented
281 Method absolute_x__set Undocumented
287 Method absolute_y__get Undocumented
290 Method absolute_y__set Undocumented
296 Method absolute_z__get Undocumented
299 Method absolute_z__set Undocumented
150 Method _proxy_child_signal_scrolled Undocumented
154 Method _proxy_child_signal Undocumented
158 Method _proxy_child_signal_with_pressure Undocumented

Inherited from Node (via Widget, Group):

Line # Kind Name Docs
37 Method parent__set Undocumented
57 Method parent__get Undocumented
62 Method x__get Undocumented
68 Method x__set Undocumented
84 Method y__get Undocumented
90 Method y__set Undocumented
107 Method z__get Undocumented
113 Method z__set Undocumented
130 Method position__get Undocumented
136 Method position__set Undocumented
160 Method width__get Undocumented
166 Method width__set Undocumented
184 Method height__get Undocumented
190 Method height__set Undocumented
210 Method size__get Undocumented
216 Method size__set Undocumented
236 Method visible__get Undocumented
242 Method visible__set Undocumented
260 Method opacity__get Undocumented
266 Method opacity__set Undocumented
def __init__(self):
Set the default styles for the widget. Subclasses should override and call "self._update_style_properties()" after calling this base class constructor.
def _update_style_properties(self, props=None):

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.
Parameterspropsthe properties that have to be updated (type: dictionary of strings ==> anything )
def _queue_layout(self):
Undocumented
def _resized_callback(self, notifier, width, height):
Undocumented
def _repositioned_callback(self, notifier, x, y, z):
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 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 2008-10-13 19:16:17.