FlowBox

class FlowBox(**properties: Any)

Superclasses: Widget, InitiallyUnowned, Object

Implemented Interfaces: Accessible, Buildable, ConstraintTarget, Orientable

A GtkFlowBox puts child widgets in reflowing grid.

For instance, with the horizontal orientation, the widgets will be arranged from left to right, starting a new row under the previous row when necessary. Reducing the width in this case will require more rows, so a larger height will be requested.

Likewise, with the vertical orientation, the widgets will be arranged from top to bottom, starting a new column to the right when necessary. Reducing the height will require more columns, so a larger width will be requested.

The size request of a GtkFlowBox alone may not be what you expect; if you need to be able to shrink it along both axes and dynamically reflow its children, you may have to wrap it in a GtkScrolledWindow to enable that.

The children of a GtkFlowBox can be dynamically sorted and filtered.

Although a GtkFlowBox must have only GtkFlowBoxChild children, you can add any kind of widget to it via insert, and a GtkFlowBoxChild widget will automatically be inserted between the box and the widget.

Also see ListBox.

CSS nodes

flowbox
├── flowboxchild
│   ╰── <child>
├── flowboxchild
│   ╰── <child>
┊
╰── [rubberband]

GtkFlowBox uses a single CSS node with name flowbox. GtkFlowBoxChild uses a single CSS node with name flowboxchild. For rubberband selection, a subnode with name rubberband is used.

Accessibility

GtkFlowBox uses the GRID role, and GtkFlowBoxChild uses the GRID_CELL role.

Constructors

class FlowBox

classmethod new() → Widget: Creates a GtkFlowBox.

Methods

class FlowBox

append(child: Widget) → None

Adds child to the end of self.

If a sort function is set, the widget will actually be inserted at the calculated position.

Properties

class FlowBox

props.accept_unpaired_release: bool

props.activate_on_single_click: bool: Determines whether children can be activated with a single click, or require a double-click.

props.column_spacing: int: The amount of horizontal space between two children.

props.homogeneous: bool: Determines whether all children should be allocated the same size.

props.max_children_per_line: int: The maximum amount of children to request space for consecutively in the given orientation.

props.min_children_per_line: int

The minimum number of children to allocate consecutively in the given orientation.

Setting the minimum children per line ensures that a reasonably small height will be requested for the overall minimum width of the box.

props.row_spacing: int: The amount of vertical space between two children.

props.selection_mode: SelectionMode: The selection mode used by the flow box.

Signals

class FlowBox.signals

activate_cursor_child() → None

Emitted when the user activates the box.

This is a keybinding signal.

child_activated(child: FlowBoxChild) → None

Emitted when a child has been activated by the user.

Parameters:: child – the child that is activated

move_cursor(step: MovementStep, count: int, extend: bool, modify: bool) → bool

Emitted when the user initiates a cursor movement.

This is a keybinding signal. Applications should not connect to it, but may emit it with signal_emit_by_name() if they need to control the cursor programmatically.

The default bindings for this signal come in two variants, the variant with the Shift modifier extends the selection, the variant without the Shift modifier does not. There are too many key combinations to list them all here.