Class

GtkFlowBox

Description [src]

final class Gtk.FlowBox : Gtk.Widget {
  /* No available fields */
}

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 gtk_flow_box_insert(), and a GtkFlowBoxChild widget will automatically be inserted between the box and the widget.

Also see GtkListBox.

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 GTK_ACCESSIBLE_ROLE_GRID role, and GtkFlowBoxChild uses the GTK_ACCESSIBLE_ROLE_GRID_CELL role.

Hierarchy

Ancestors

GtkWidget
GInitiallyUnowned
GObject

Implements

Constructors

gtk_flow_box_new

Creates a GtkFlowBox.

Instance methods

gtk_flow_box_bind_model

Binds model to box.

gtk_flow_box_get_activate_on_single_click

Returns whether children activate on single clicks.

gtk_flow_box_get_child_at_index

Gets the nth child in the box.

gtk_flow_box_get_child_at_pos

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

gtk_flow_box_get_column_spacing

Gets the horizontal spacing.

gtk_flow_box_get_homogeneous

Returns whether the box is homogeneous.

gtk_flow_box_get_max_children_per_line

Gets the maximum number of children per line.

gtk_flow_box_get_min_children_per_line

Gets the minimum number of children per line.

gtk_flow_box_get_row_spacing

Gets the vertical spacing.

gtk_flow_box_get_selected_children

Creates a list of all selected children.

gtk_flow_box_get_selection_mode

Gets the selection mode of box.

gtk_flow_box_insert

Inserts the widget into box at position.

gtk_flow_box_invalidate_filter

Updates the filtering for all children.

gtk_flow_box_invalidate_sort

Updates the sorting for all children.

gtk_flow_box_remove

Removes a child from box.

gtk_flow_box_select_all

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

gtk_flow_box_select_child

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

gtk_flow_box_selected_foreach

Calls a function for each selected child.

gtk_flow_box_set_activate_on_single_click

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

gtk_flow_box_set_column_spacing

Sets the horizontal space to add between children.

gtk_flow_box_set_filter_func

By setting a filter function on the box one can decide dynamically which of the children to show.

gtk_flow_box_set_hadjustment

Hooks up an adjustment to focus handling in box.

gtk_flow_box_set_homogeneous

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

gtk_flow_box_set_max_children_per_line

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

gtk_flow_box_set_min_children_per_line

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

gtk_flow_box_set_row_spacing

Sets the vertical space to add between children.

gtk_flow_box_set_selection_mode

Sets how selection works in box.

gtk_flow_box_set_sort_func

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

gtk_flow_box_set_vadjustment

Hooks up an adjustment to focus handling in box.

gtk_flow_box_unselect_all

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

gtk_flow_box_unselect_child

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

Methods inherited from GtkWidget (159)

gtk_widget_action_set_enabled

Enable or disable an action installed with gtk_widget_class_install_action().

gtk_widget_activate

For widgets that can be “activated” (buttons, menu items, etc.), this function activates them.

gtk_widget_activate_action

Looks up the action in the action groups associated with widget and its ancestors, and activates it.

gtk_widget_activate_action_variant

Looks up the action in the action groups associated with widget and its ancestors, and activates it.

gtk_widget_activate_default

Activates the default.activate action from widget.

gtk_widget_add_controller

Adds controller to widget so that it will receive events.

gtk_widget_add_css_class

Adds a style class to widget.

gtk_widget_add_mnemonic_label

Adds a widget to the list of mnemonic labels for this widget.

gtk_widget_add_tick_callback

Queues an animation frame update and adds a callback to be called before each frame.

gtk_widget_allocate

This function is only used by GtkWidget subclasses, to assign a size, position and (optionally) baseline to their child widgets.

gtk_widget_child_focus

Called by widgets as the user moves around the window using keyboard shortcuts.

gtk_widget_compute_bounds

Computes the bounds for widget in the coordinate space of target.

gtk_widget_compute_expand

Computes whether a container should give this widget extra space when possible.

gtk_widget_compute_point

Translates the given point in widget‘s coordinates to coordinates relative to target’s coordinate system.

gtk_widget_compute_transform

Computes a matrix suitable to describe a transformation from widget‘s coordinate system into target‘s coordinate system.

gtk_widget_contains

Tests if the point at (x, y) is contained in widget.

gtk_widget_create_pango_context

Creates a new PangoContext with the appropriate font map, font options, font description, and base direction for drawing text for this widget.

gtk_widget_create_pango_layout

Creates a new PangoLayout with the appropriate font map, font description, and base direction for drawing text for this widget.

gtk_drag_check_threshold

Checks to see if a drag movement has passed the GTK drag threshold.

gtk_widget_error_bell

Notifies the user about an input-related error on this widget.

gtk_widget_get_allocated_baseline

Returns the baseline that has currently been allocated to widget.

gtk_widget_get_allocated_height

Returns the height that has currently been allocated to widget.

gtk_widget_get_allocated_width

Returns the width that has currently been allocated to widget.

Methods inherited from GtkBuildable (1)

gtk_buildable_get_buildable_id

Gets the ID of the buildable object.

Methods inherited from GtkOrientable (2)

gtk_orientable_get_orientation

Retrieves the orientation of the orientable.

gtk_orientable_set_orientation

Sets the orientation of the orientable.

Properties inherited from GtkAccessible (1)

Gtk.Accessible:accessible-role

The accessible role of the given GtkAccessible implementation.

Properties inherited from GtkOrientable (1)

Gtk.Orientable:orientation

The orientation of the orientable.