Box

The GtkBox widget arranges child widgets into a single row or column, depending upon the value of its #GtkOrientable:orientation property. Within the other dimension, all children are allocated the same size. Of course, the #GtkWidget:halign and #GtkWidget:valign properties can be used on the children to influence their allocation.

GtkBox uses a notion of packing. Packing refers to adding widgets with reference to a particular position in a #GtkContainer. For a GtkBox, there are two reference positions: the start and the end of the box. For a vertical #GtkBox, the start is defined as the top of the box and the end is defined as the bottom. For a horizontal #GtkBox the start is defined as the left side and the end is defined as the right side.

Use repeated calls to gtk.box.Box.packStart to pack widgets into a GtkBox from start to end. Use gtk.box.Box.packEnd to add widgets from end to start. You may intersperse these calls and add widgets from both ends of the same GtkBox.

Because GtkBox is a #GtkContainer, you may also use gtk.container.Container.add to insert widgets into the box, and they will be packed with the default values for expand and fill child properties. Use gtk.container.Container.remove to remove widgets from the GtkBox.

Use gtk.box.Box.setHomogeneous to specify whether or not all children of the GtkBox are forced to get the same amount of space.

Use gtk.box.Box.setSpacing to determine how much space will be minimally placed between all children in the GtkBox. Note that spacing is added between the children, while padding added by gtk.box.Box.packStart or gtk.box.Box.packEnd is added on either side of the widget it belongs to.

Use gtk.box.Box.reorderChild to move a GtkBox child to a different place in the box.

Use gtk.box.Box.setChildPacking to reset the expand, fill and padding child properties. Use gtk.box.Box.queryChildPacking to query these fields.

CSS nodes

GtkBox uses a single CSS node with name box.

In horizontal orientation, the nodes of the children are always arranged from left to right. So :first-child will always select the leftmost child, regardless of text direction.

Constructors

this
this(void* ptr, Flag!"Take" take)
this
this(gtk.types.Orientation orientation, int spacing)

Creates a new #GtkBox.

Members

Functions

getBaselinePosition
gtk.types.BaselinePosition getBaselinePosition()

Gets the value set by gtk.box.Box.setBaselinePosition.

getCenterWidget
gtk.widget.Widget getCenterWidget()

Retrieves the center widget of the box.

getHomogeneous
bool getHomogeneous()

Returns whether the box is homogeneous (all children are the same size). See gtk.box.Box.setHomogeneous.

getSpacing
int getSpacing()

Gets the value set by gtk.box.Box.setSpacing.

packEnd
void packEnd(gtk.widget.Widget child, bool expand, bool fill, uint padding)

Adds child to box, packed with reference to the end of box. The child is packed after (away from end of) any other child packed with reference to the end of box.

packStart
void packStart(gtk.widget.Widget child, bool expand, bool fill, uint padding)

Adds child to box, packed with reference to the start of box. The child is packed after any other child packed with reference to the start of box.

queryChildPacking
void queryChildPacking(gtk.widget.Widget child, bool expand, bool fill, uint padding, gtk.types.PackType packType)

Obtains information about how child is packed into box.

reorderChild
void reorderChild(gtk.widget.Widget child, int position)

Moves child to a new position in the list of box children. The list contains widgets packed #GTK_PACK_START as well as widgets packed #GTK_PACK_END, in the order that these widgets were added to box.

self
Box self()

Returns this, for use in with statements.

setBaselinePosition
void setBaselinePosition(gtk.types.BaselinePosition position)

Sets the baseline position of a box. This affects only horizontal boxes with at least one baseline aligned child. If there is more vertical space available than requested, and the baseline is not allocated by the parent then position is used to allocate the baseline wrt the extra space available.

setCenterWidget
void setCenterWidget(gtk.widget.Widget widget)

Sets a center widget; that is a child widget that will be centered with respect to the full width of the box, even if the children at either side take up different amounts of space.

setChildPacking
void setChildPacking(gtk.widget.Widget child, bool expand, bool fill, uint padding, gtk.types.PackType packType)

Sets the way child is packed into box.

setHomogeneous
void setHomogeneous(bool homogeneous)

Sets the #GtkBox:homogeneous property of box, controlling whether or not all children of box are given equal space in the box.

setSpacing
void setSpacing(int spacing)

Sets the #GtkBox:spacing property of box, which is the number of pixels to place between children of box.

Properties

_gType
GType _gType [@property getter]
baselinePosition
gtk.types.BaselinePosition baselinePosition [@property getter]
baselinePosition
gtk.types.BaselinePosition baselinePosition [@property setter]
homogeneous
bool homogeneous [@property getter]
homogeneous
bool homogeneous [@property setter]
spacing
int spacing [@property getter]
spacing
int spacing [@property setter]

Static functions

_getGType
GType _getGType()
builder
BoxGidBuilder builder()

Get builder for gtk.box.Box

Mixed In Members

From mixin OrientableT!()

orientation
gtk.types.Orientation orientation [@property getter]

Get orientation property.

orientation
gtk.types.Orientation orientation [@property setter]

Set orientation property.

getOrientation
gtk.types.Orientation getOrientation()

Retrieves the orientation of the orientable.

setOrientation
void setOrientation(gtk.types.Orientation orientation)

Sets the orientation of the orientable.

Inherited Members

From Container

_getGType
GType _getGType()
_gType
GType _gType [@property getter]
self
Container self()

Returns this, for use in with statements.

builder
ContainerGidBuilder builder()

Get builder for gtk.container.Container

borderWidth
uint borderWidth [@property getter]
borderWidth
uint borderWidth [@property setter]
child
gtk.widget.Widget child [@property setter]
resizeMode
gtk.types.ResizeMode resizeMode [@property getter]
resizeMode
gtk.types.ResizeMode resizeMode [@property setter]
add
void add(gtk.widget.Widget widget)

Adds widget to container. Typically used for simple containers such as #GtkWindow, #GtkFrame, or #GtkButton; for more complicated layout containers such as #GtkBox or #GtkGrid, this function will pick default packing parameters that may not be correct. So consider functions such as gtk.box.Box.packStart and gtk.grid.Grid.attach as an alternative to gtk.container.Container.add in those cases. A widget may be added to only one container at a time; you can’t place the same widget inside two different containers.

checkResize
void checkResize()
childGetProperty
void childGetProperty(gtk.widget.Widget child, string propertyName, gobject.value.Value value)

Gets the value of a child property for child and container.

childNotify
void childNotify(gtk.widget.Widget child, string childProperty)

Emits a #GtkWidget::child-notify signal for the [child property][child-properties] child_property on the child.

childNotifyByPspec
void childNotifyByPspec(gtk.widget.Widget child, gobject.param_spec.ParamSpec pspec)

Emits a #GtkWidget::child-notify signal for the [child property][child-properties] specified by pspec on the child.

childSetProperty
void childSetProperty(gtk.widget.Widget child, string propertyName, gobject.value.Value value)

Sets a child property for child and container.

childType
gobject.types.GType childType()

Returns the type of the children supported by the container.

forall
void forall(gtk.types.Callback callback)

Invokes callback on each direct child of container, including children that are considered “internal” (implementation details of the container). “Internal” children generally weren’t added by the user of the container, but were added by the container implementation itself.

foreach_
void foreach_(gtk.types.Callback callback)

Invokes callback on each non-internal child of container. See gtk.container.Container.forall for details on what constitutes an “internal” child. For all practical purposes, this function should iterate over precisely those child widgets that were added to the container by the application with explicit add() calls.

getBorderWidth
uint getBorderWidth()

Retrieves the border width of the container. See gtk.container.Container.setBorderWidth.

getChildren
gtk.widget.Widget[] getChildren()

Returns the container’s non-internal children. See gtk.container.Container.forall for details on what constitutes an "internal" child.

getFocusChain
bool getFocusChain(gtk.widget.Widget[] focusableWidgets)

Retrieves the focus chain of the container, if one has been set explicitly. If no focus chain has been explicitly set, GTK+ computes the focus chain based on the positions of the children. In that case, GTK+ stores null in focusable_widgets and returns false.

getFocusChild
gtk.widget.Widget getFocusChild()

Returns the current focus child widget inside container. This is not the currently focused widget. That can be obtained by calling gtk.window.Window.getFocus.

getFocusHadjustment
gtk.adjustment.Adjustment getFocusHadjustment()

Retrieves the horizontal focus adjustment for the container. See gtk_container_set_focus_hadjustment ().

getFocusVadjustment
gtk.adjustment.Adjustment getFocusVadjustment()

Retrieves the vertical focus adjustment for the container. See gtk.container.Container.setFocusVadjustment.

getPathForChild
gtk.widget_path.WidgetPath getPathForChild(gtk.widget.Widget child)

Returns a newly created widget path representing all the widget hierarchy from the toplevel down to and including child.

getResizeMode
gtk.types.ResizeMode getResizeMode()

Returns the resize mode for the container. See gtk_container_set_resize_mode ().

propagateDraw
void propagateDraw(gtk.widget.Widget child, cairo.context.Context cr)

When a container receives a call to the draw function, it must send synthetic #GtkWidget::draw calls to all children that don’t have their own #GdkWindows. This function provides a convenient way of doing this. A container, when it receives a call to its #GtkWidget::draw function, calls gtk.container.Container.propagateDraw once for each child, passing in the cr the container received.

remove
void remove(gtk.widget.Widget widget)

Removes widget from container. widget must be inside container. Note that container will own a reference to widget, and that this may be the last reference held; so removing a widget from its container can destroy that widget. If you want to use widget again, you need to add a reference to it before removing it from a container, using gobject.object.ObjectWrap.ref_. If you don’t want to use widget again it’s usually more efficient to simply destroy it directly using gtk.widget.Widget.destroy since this will remove it from the container and help break any circular reference count cycles.

resizeChildren
void resizeChildren()
setBorderWidth
void setBorderWidth(uint borderWidth)

Sets the border width of the container.

setFocusChain
void setFocusChain(gtk.widget.Widget[] focusableWidgets)

Sets a focus chain, overriding the one computed automatically by GTK+.

setFocusChild
void setFocusChild(gtk.widget.Widget child)

Sets, or unsets if child is null, the focused child of container.

setFocusHadjustment
void setFocusHadjustment(gtk.adjustment.Adjustment adjustment)

Hooks up an adjustment to focus handling in a container, so when a child of the container is focused, the adjustment is scrolled to show that widget. This function sets the horizontal alignment. See gtk.scrolled_window.ScrolledWindow.getHadjustment for a typical way of obtaining the adjustment and gtk.container.Container.setFocusVadjustment for setting the vertical adjustment.

setFocusVadjustment
void setFocusVadjustment(gtk.adjustment.Adjustment adjustment)

Hooks up an adjustment to focus handling in a container, so when a child of the container is focused, the adjustment is scrolled to show that widget. This function sets the vertical alignment. See gtk.scrolled_window.ScrolledWindow.getVadjustment for a typical way of obtaining the adjustment and gtk.container.Container.setFocusHadjustment for setting the horizontal adjustment.

setReallocateRedraws
void setReallocateRedraws(bool needsRedraws)

Sets the reallocate_redraws flag of the container to the given value.

setResizeMode
void setResizeMode(gtk.types.ResizeMode resizeMode)

Sets the resize mode for the container.

unsetFocusChain
void unsetFocusChain()

Removes a focus chain explicitly set with gtk.container.Container.setFocusChain.

connectAdd
gulong connectAdd(T callback, Flag!"After" after)

Connect to Add signal.

connectCheckResize
gulong connectCheckResize(T callback, Flag!"After" after)

Connect to CheckResize signal.

connectRemove
gulong connectRemove(T callback, Flag!"After" after)

Connect to Remove signal.

connectSetFocusChild
gulong connectSetFocusChild(T callback, Flag!"After" after)

Connect to SetFocusChild signal.

From Orientable

_getGType
GType _getGType()
orientation
gtk.types.Orientation orientation [@property getter]

Get orientation property.

orientation
gtk.types.Orientation orientation [@property setter]

Set orientation property.

getOrientation
gtk.types.Orientation getOrientation()

Retrieves the orientation of the orientable.

setOrientation
void setOrientation(gtk.types.Orientation orientation)

Sets the orientation of the orientable.