Memory-managed wrapper type.

Type class for types which can be safely cast to FlowBox, for instance with toFlowBox.

Cast to FlowBox, for types for which this is known to be safe. For general casts, use castTo.

A convenience alias for Nothing :: Maybe FlowBox.

Binds model to box.

If box was already bound to a model, that previous binding is destroyed.

The contents of box are cleared and then filled with widgets that represent items from model. box is updated whenever model changes. If model is Nothing, box is left empty.

It is undefined to add or remove widgets directly (for example, with flowBoxInsert or containerAdd) while box is bound to a model.

Note that using a model is incompatible with the filtering and sorting functionality in GtkFlowBox. When using a model, filtering and sorting should be implemented by the model.

Since: 3.18

Returns whether children activate on single clicks.

Since: 3.12

Gets the nth child in the box.

Since: 3.12

Gets the child in the (x, y) position.

Since: 3.22.6

Gets the horizontal spacing.

Since: 3.12

Returns whether the box is homogeneous (all children are the same size). See boxSetHomogeneous.

Since: 3.12

Gets the maximum number of children per line.

Since: 3.12

Gets the minimum number of children per line.

Since: 3.12

Gets the vertical spacing.

Since: 3.12

Creates a list of all selected children.

Since: 3.12

Gets the selection mode of box.

Since: 3.12

Inserts the widget into box at position.

If a sort function is set, the widget will actually be inserted at the calculated position and this function has the same effect as containerAdd.

If position is -1, or larger than the total number of children in the box, then the widget will be appended to the end.

Since: 3.12

Updates the filtering for all children.

Call this function when the result of the filter function on the box is changed due ot an external factor. For instance, this would be used if the filter function just looked for a specific search term, and the entry with the string has changed.

Since: 3.12

Updates the sorting for all children.

Call this when the result of the sort function on box is changed due to an external factor.

Since: 3.12

Creates a GtkFlowBox.

Since: 3.12

Select all children of box, if the selection mode allows it.

Since: 3.12

Selects a single child of box, if the selection mode allows it.

Since: 3.12

Calls a function for each selected child.

Note that the selection cannot be modified from within this function.

Since: 3.12

If single is True, children will be activated when you click on them, otherwise you need to double-click.

Since: 3.12

Sets the horizontal space to add between children. See the FlowBox:column-spacing property.

Since: 3.12

By setting a filter function on the box one can decide dynamically which of the children to show. For instance, to implement a search function that only shows the children matching the search terms.

The filterFunc will be called for each child after the call, and it will continue to be called each time a child changes (via flowBoxChildChanged) or when flowBoxInvalidateFilter is called.

Note that using a filter function is incompatible with using a model (see flowBoxBindModel).

Since: 3.12

Hooks up an adjustment to focus handling in box. The adjustment is also used for autoscrolling during rubberband selection. See scrolledWindowGetHadjustment for a typical way of obtaining the adjustment, and flowBoxSetVadjustmentfor setting the vertical adjustment.

The adjustments have to be in pixel units and in the same coordinate system as the allocation for immediate children of the box.

Since: 3.12

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

Since: 3.12

Sets the maximum number of children to request and allocate space for in box’s orientation.

Setting the maximum number of children per line limits the overall natural size request to be no more than nChildren children long in the given orientation.

Since: 3.12

Sets the minimum number of children to line up in box’s orientation before flowing.

Since: 3.12

Sets the vertical space to add between children. See the FlowBox:row-spacing property.

Since: 3.12

Sets how selection works in box. See SelectionMode for details.

Since: 3.12

By setting a sort function on the box, one can dynamically reorder the children of the box, based on the contents of the children.

The sortFunc will be called for each child after the call, and will continue to be called each time a child changes (via flowBoxChildChanged) and when flowBoxInvalidateSort is called.

Note that using a sort function is incompatible with using a model (see flowBoxBindModel).

Since: 3.12

Hooks up an adjustment to focus handling in box. The adjustment is also used for autoscrolling during rubberband selection. See scrolledWindowGetVadjustment for a typical way of obtaining the adjustment, and flowBoxSetHadjustmentfor setting the horizontal adjustment.

The adjustments have to be in pixel units and in the same coordinate system as the allocation for immediate children of the box.

Since: 3.12

Unselect all children of box, if the selection mode allows it.

Since: 3.12

Unselects a single child of box, if the selection mode allows it.

Since: 3.12

Construct a GValueConstruct with valid value for the “activate-on-single-click” property. This is rarely needed directly, but it is used by new.

Get the value of the “activate-on-single-click” property. When overloading is enabled, this is equivalent to

get flowBox #activateOnSingleClick

Set the value of the “activate-on-single-click” property. When overloading is enabled, this is equivalent to

set flowBox [ #activateOnSingleClick := value ]

Construct a GValueConstruct with valid value for the “column-spacing” property. This is rarely needed directly, but it is used by new.

Get the value of the “column-spacing” property. When overloading is enabled, this is equivalent to

get flowBox #columnSpacing

Set the value of the “column-spacing” property. When overloading is enabled, this is equivalent to

set flowBox [ #columnSpacing := value ]

Construct a GValueConstruct with valid value for the “homogeneous” property. This is rarely needed directly, but it is used by new.

Get the value of the “homogeneous” property. When overloading is enabled, this is equivalent to

get flowBox #homogeneous

Set the value of the “homogeneous” property. When overloading is enabled, this is equivalent to

set flowBox [ #homogeneous := value ]

Construct a GValueConstruct with valid value for the “max-children-per-line” property. This is rarely needed directly, but it is used by new.

Get the value of the “max-children-per-line” property. When overloading is enabled, this is equivalent to

get flowBox #maxChildrenPerLine

Set the value of the “max-children-per-line” property. When overloading is enabled, this is equivalent to

set flowBox [ #maxChildrenPerLine := value ]

Construct a GValueConstruct with valid value for the “min-children-per-line” property. This is rarely needed directly, but it is used by new.

Get the value of the “min-children-per-line” property. When overloading is enabled, this is equivalent to

get flowBox #minChildrenPerLine

Set the value of the “min-children-per-line” property. When overloading is enabled, this is equivalent to

set flowBox [ #minChildrenPerLine := value ]

Construct a GValueConstruct with valid value for the “row-spacing” property. This is rarely needed directly, but it is used by new.

Get the value of the “row-spacing” property. When overloading is enabled, this is equivalent to

get flowBox #rowSpacing

Set the value of the “row-spacing” property. When overloading is enabled, this is equivalent to

set flowBox [ #rowSpacing := value ]

Construct a GValueConstruct with valid value for the “selection-mode” property. This is rarely needed directly, but it is used by new.

Get the value of the “selection-mode” property. When overloading is enabled, this is equivalent to

get flowBox #selectionMode

Set the value of the “selection-mode” property. When overloading is enabled, this is equivalent to

set flowBox [ #selectionMode := value ]

Type for the callback on the (unwrapped) C side.

The ::activate-cursor-child signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user activates the box.

Connect a signal handler for the “activate-cursor-child” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after flowBox #activateCursorChild callback

Wrap the callback into a Closure.

Generate a function pointer callable from C code, from a C_FlowBoxActivateCursorChildCallback.

A convenience synonym for Nothing :: Maybe FlowBoxActivateCursorChildCallback.

Connect a signal handler for the “activate-cursor-child” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on flowBox #activateCursorChild callback

Wrap a FlowBoxActivateCursorChildCallback into a C_FlowBoxActivateCursorChildCallback.

Type for the callback on the (unwrapped) C side.

The ::child-activated signal is emitted when a child has been activated by the user.

Connect a signal handler for the “child-activated” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after flowBox #childActivated callback

Wrap the callback into a Closure.

Generate a function pointer callable from C code, from a C_FlowBoxChildActivatedCallback.

A convenience synonym for Nothing :: Maybe FlowBoxChildActivatedCallback.

Connect a signal handler for the “child-activated” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on flowBox #childActivated callback

Wrap a FlowBoxChildActivatedCallback into a C_FlowBoxChildActivatedCallback.

Type for the callback on the (unwrapped) C side.

The ::move-cursor signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user initiates a cursor movement.

Applications should not connect to it, but may emit it with g_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 modifer does not. There are too many key combinations to list them all here.

• Arrow keys move by individual children
• Home/End keys move to the ends of the box
• PageUp/PageDown keys move vertically by pages

Connect a signal handler for the “move-cursor” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after flowBox #moveCursor callback

Wrap the callback into a Closure.

Generate a function pointer callable from C code, from a C_FlowBoxMoveCursorCallback.

A convenience synonym for Nothing :: Maybe FlowBoxMoveCursorCallback.

Connect a signal handler for the “move-cursor” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on flowBox #moveCursor callback

Wrap a FlowBoxMoveCursorCallback into a C_FlowBoxMoveCursorCallback.

Type for the callback on the (unwrapped) C side.

The ::select-all signal is a [keybinding signal][GtkBindingSignal] which gets emitted to select all children of the box, if the selection mode permits it.

The default bindings for this signal is Ctrl-a.

Connect a signal handler for the “select-all” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after flowBox #selectAll callback

Wrap the callback into a Closure.

Generate a function pointer callable from C code, from a C_FlowBoxSelectAllCallback.

A convenience synonym for Nothing :: Maybe FlowBoxSelectAllCallback.

Connect a signal handler for the “select-all” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on flowBox #selectAll callback

Wrap a FlowBoxSelectAllCallback into a C_FlowBoxSelectAllCallback.

Type for the callback on the (unwrapped) C side.

The ::selected-children-changed signal is emitted when the set of selected children changes.

Use flowBoxSelectedForeach or flowBoxGetSelectedChildren to obtain the selected children.

Connect a signal handler for the “selected-children-changed” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after flowBox #selectedChildrenChanged callback

Wrap the callback into a Closure.

Generate a function pointer callable from C code, from a C_FlowBoxSelectedChildrenChangedCallback.

A convenience synonym for Nothing :: Maybe FlowBoxSelectedChildrenChangedCallback.

Connect a signal handler for the “selected-children-changed” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on flowBox #selectedChildrenChanged callback

Wrap a FlowBoxSelectedChildrenChangedCallback into a C_FlowBoxSelectedChildrenChangedCallback.

Type for the callback on the (unwrapped) C side.

The ::toggle-cursor-child signal is a [keybinding signal][GtkBindingSignal] which toggles the selection of the child that has the focus.

The default binding for this signal is Ctrl-Space.

Connect a signal handler for the “toggle-cursor-child” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after flowBox #toggleCursorChild callback

Wrap the callback into a Closure.

Generate a function pointer callable from C code, from a C_FlowBoxToggleCursorChildCallback.

A convenience synonym for Nothing :: Maybe FlowBoxToggleCursorChildCallback.

Connect a signal handler for the “toggle-cursor-child” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on flowBox #toggleCursorChild callback

Wrap a FlowBoxToggleCursorChildCallback into a C_FlowBoxToggleCursorChildCallback.

Type for the callback on the (unwrapped) C side.

The ::unselect-all signal is a [keybinding signal][GtkBindingSignal] which gets emitted to unselect all children of the box, if the selection mode permits it.

The default bindings for this signal is Ctrl-Shift-a.

Connect a signal handler for the “unselect-all” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after flowBox #unselectAll callback

Wrap the callback into a Closure.

Generate a function pointer callable from C code, from a C_FlowBoxUnselectAllCallback.

A convenience synonym for Nothing :: Maybe FlowBoxUnselectAllCallback.

Connect a signal handler for the “unselect-all” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on flowBox #unselectAll callback

Wrap a FlowBoxUnselectAllCallback into a C_FlowBoxUnselectAllCallback.