Box

class Box(**properties: Any)

Superclasses: Widget, InitiallyUnowned, Object

Subclasses: ShortcutsGroup, ShortcutsSection

Implemented Interfaces: Accessible, Buildable, ConstraintTarget, Orientable

Arranges child widgets into a single row or column.

Whether it is a row or column depends on the value of its orientation property. Within the other dimension, all children are allocated the same size. The halign and valign properties can be used on the children to influence their allocation.

Use repeated calls to append to pack widgets into a GtkBox from start to end. Use remove to remove widgets from the GtkBox. insert_child_after can be used to add a child at a particular position.

Use set_homogeneous to specify whether or not all children of the GtkBox are forced to get the same amount of space.

Use set_spacing to determine how much space will be minimally placed between all children in the GtkBox. Note that spacing is added between the children.

Use reorder_child_after to move a child to a different place in the box.

CSS nodes

GtkBox uses a single CSS node with name box.

Accessibility

Until GTK 4.10, GtkBox used the group role.

Starting from GTK 4.12, GtkBox uses the generic role.

Constructors

class Box

classmethod new(orientation: Orientation, spacing: int) → Widget

Creates a new box.

Parameters:

• orientation – the box’s orientation

• spacing – the number of pixels to place between children

Methods

class Box

append(child: Widget) → None

Adds a child at the end.

Parameters:

child – the widget to append

get_baseline_child() → int

Gets the value set by set_baseline_child.

Added in version 4.12.

get_baseline_position() → BaselinePosition

Gets the value set by set_baseline_position.

get_homogeneous() → bool

Returns whether the box is homogeneous.

In a homogeneous box all children are the same size.

get_spacing() → int

Gets the value set by set_spacing.

insert_child_after(child: Widget, sibling: Widget | None = None) → None

Inserts a child at a specific position.

The child is added after sibling in the list of box children.

If sibling is NULL, the child is placed at the beginning.

Parameters:

• child – the widget to insert

• sibling – the sibling after which to insert child

prepend(child: Widget) → None

Adds a child at the beginning.

Parameters:

child – the widget to prepend

remove(child: Widget) → None

Removes a child widget from the box.

The child must have been added before with append, prepend, or insert_child_after.

Parameters:

child – the child to remove

reorder_child_after(child: Widget, sibling: Widget | None = None) → None

Moves a child to a different position.

The child is moved to the position after sibling in the list of box children.

If sibling is NULL, the child is placed at the beginning.

Parameters:

• child – the widget to move, must be a child of box

• sibling – the sibling to move child after

set_baseline_child(child: int) → None

Sets the baseline child of a box.

This affects only vertical boxes.

Added in version 4.12.

Parameters:

child – a child position, or -1

set_baseline_position(position: BaselinePosition) → None

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 with respect to the extra space available.

Parameters:

position – the baseline position

set_homogeneous(homogeneous: bool) → None

Sets whether or not all children are given equal space in the box.

Parameters:

homogeneous – true to create equal allotments, false for variable allotments

set_spacing(spacing: int) → None

Sets the number of pixels to place between children.

Parameters:

spacing – the number of pixels to put between children

Properties

class Box

props.baseline_child: int

The position of the child that determines the baseline.

This is only relevant if the box is in vertical orientation.

Added in version 4.12.

props.baseline_position: BaselinePosition

How to position baseline-aligned widgets if extra space is available.

props.homogeneous: bool

Whether the children should all be the same size.

props.spacing: int

The amount of space between children.

Fields

class Box

parent_instance