FlowBox

A GtkFlowBox positions child widgets in sequence according to its orientation.

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.container.Container.add, and a GtkFlowBoxChild widget will automatically be inserted between the box and the widget.

Also see #GtkListBox.

GtkFlowBox was added in GTK+ 3.12.

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.

class FlowBox : Container , Orientable {

this(void* ptr, Flag!"Take" take);

static GType _getGType();

GType _gType [@property getter];

FlowBox self();

static FlowBoxGidBuilder builder();

bool activateOnSingleClick [@property getter];

bool activateOnSingleClick [@property setter];

uint columnSpacing [@property getter];

uint columnSpacing [@property setter];

bool homogeneous [@property getter];

bool homogeneous [@property setter];

uint maxChildrenPerLine [@property getter];

uint maxChildrenPerLine [@property setter];

uint minChildrenPerLine [@property getter];

uint minChildrenPerLine [@property setter];

uint rowSpacing [@property getter];

uint rowSpacing [@property setter];

gtk.types.SelectionMode selectionMode [@property getter];

gtk.types.SelectionMode selectionMode [@property setter];

void bindModel(gio.list_model.ListModel model, gtk.types.FlowBoxCreateWidgetFunc createWidgetFunc);

bool getActivateOnSingleClick();

gtk.flow_box_child.FlowBoxChild getChildAtIndex(int idx);

gtk.flow_box_child.FlowBoxChild getChildAtPos(int x, int y);

uint getColumnSpacing();

bool getHomogeneous();

uint getMaxChildrenPerLine();

uint getMinChildrenPerLine();

uint getRowSpacing();

gtk.flow_box_child.FlowBoxChild[] getSelectedChildren();

gtk.types.SelectionMode getSelectionMode();

void insert(gtk.widget.Widget widget, int position);

void invalidateFilter();

void invalidateSort();

void selectAll();

void selectChild(gtk.flow_box_child.FlowBoxChild child);

void selectedForeach(gtk.types.FlowBoxForeachFunc func);

void setActivateOnSingleClick(bool single);

void setColumnSpacing(uint spacing);

void setFilterFunc(gtk.types.FlowBoxFilterFunc filterFunc);

void setHadjustment(gtk.adjustment.Adjustment adjustment);

void setHomogeneous(bool homogeneous);

void setMaxChildrenPerLine(uint nChildren);

void setMinChildrenPerLine(uint nChildren);

void setRowSpacing(uint spacing);

void setSelectionMode(gtk.types.SelectionMode mode);

void setSortFunc(gtk.types.FlowBoxSortFunc sortFunc);

void setVadjustment(gtk.adjustment.Adjustment adjustment);

void unselectAll();

void unselectChild(gtk.flow_box_child.FlowBoxChild child);

gulong connectActivateCursorChild(T callback, Flag!"After" after);

gulong connectChildActivated(T callback, Flag!"After" after);

gulong connectMoveCursor(T callback, Flag!"After" after);

gulong connectSelectAll(T callback, Flag!"After" after);

gulong connectSelectedChildrenChanged(T callback, Flag!"After" after);

gulong connectToggleCursorChild(T callback, Flag!"After" after);

gulong connectUnselectAll(T callback, Flag!"After" after);

}

Constructors

this this(void* ptr, Flag!"Take" take)
this this(): Creates a GtkFlowBox.

Members

Functions

bindModel void bindModel(gio.list_model.ListModel model, gtk.types.FlowBoxCreateWidgetFunc createWidgetFunc): Binds model to box.
connectActivateCursorChild gulong connectActivateCursorChild(T callback, Flag!"After" after): Connect to ActivateCursorChild signal.
connectChildActivated gulong connectChildActivated(T callback, Flag!"After" after): Connect to ChildActivated signal.
connectMoveCursor gulong connectMoveCursor(T callback, Flag!"After" after): Connect to MoveCursor signal.
connectSelectAll gulong connectSelectAll(T callback, Flag!"After" after): Connect to SelectAll signal.
connectSelectedChildrenChanged gulong connectSelectedChildrenChanged(T callback, Flag!"After" after): Connect to SelectedChildrenChanged signal.
connectToggleCursorChild gulong connectToggleCursorChild(T callback, Flag!"After" after): Connect to ToggleCursorChild signal.
connectUnselectAll gulong connectUnselectAll(T callback, Flag!"After" after): Connect to UnselectAll signal.
getActivateOnSingleClick bool getActivateOnSingleClick(): Returns whether children activate on single clicks.
getChildAtIndex gtk.flow_box_child.FlowBoxChild getChildAtIndex(int idx): Gets the nth child in the box.
getChildAtPos gtk.flow_box_child.FlowBoxChild getChildAtPos(int x, int y): Gets the child in the (x, y) position.
getColumnSpacing uint getColumnSpacing(): Gets the horizontal spacing.
getHomogeneous bool getHomogeneous(): Returns whether the box is homogeneous (all children are the same size). See gtk.box.Box.setHomogeneous.
getMaxChildrenPerLine uint getMaxChildrenPerLine(): Gets the maximum number of children per line.
getMinChildrenPerLine uint getMinChildrenPerLine(): Gets the minimum number of children per line.
getRowSpacing uint getRowSpacing(): Gets the vertical spacing.
getSelectedChildren gtk.flow_box_child.FlowBoxChild[] getSelectedChildren(): Creates a list of all selected children.
getSelectionMode gtk.types.SelectionMode getSelectionMode(): Gets the selection mode of box.
insert void insert(gtk.widget.Widget widget, int position): Inserts the widget into box at position.
invalidateFilter void invalidateFilter(): Updates the filtering for all children.
invalidateSort void invalidateSort(): Updates the sorting for all children.
selectAll void selectAll(): Select all children of box, if the selection mode allows it.
selectChild void selectChild(gtk.flow_box_child.FlowBoxChild child): Selects a single child of box, if the selection mode allows it.
selectedForeach void selectedForeach(gtk.types.FlowBoxForeachFunc func): Calls a function for each selected child.
self FlowBox self(): Returns this, for use in with statements.
setActivateOnSingleClick void setActivateOnSingleClick(bool single): If single is true, children will be activated when you click on them, otherwise you need to double-click.
setColumnSpacing void setColumnSpacing(uint spacing): Sets the horizontal space to add between children. See the #GtkFlowBox:column-spacing property.
setFilterFunc void setFilterFunc(gtk.types.FlowBoxFilterFunc filterFunc): 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.
setHadjustment void setHadjustment(gtk.adjustment.Adjustment adjustment): Hooks up an adjustment to focus handling in box. The adjustment is also used for autoscrolling during rubberband selection. See gtk.scrolled_window.ScrolledWindow.getHadjustment for a typical way of obtaining the adjustment, and gtk.flow_box.FlowBox.setVadjustmentfor setting the vertical adjustment.
setHomogeneous void setHomogeneous(bool homogeneous): Sets the #GtkFlowBox:homogeneous property of box, controlling whether or not all children of box are given equal space in the box.
setMaxChildrenPerLine void setMaxChildrenPerLine(uint nChildren): Sets the maximum number of children to request and allocate space for in box’s orientation.
setMinChildrenPerLine void setMinChildrenPerLine(uint nChildren): Sets the minimum number of children to line up in box’s orientation before flowing.
setRowSpacing void setRowSpacing(uint spacing): Sets the vertical space to add between children. See the #GtkFlowBox:row-spacing property.
setSelectionMode void setSelectionMode(gtk.types.SelectionMode mode): Sets how selection works in box. See #GtkSelectionMode for details.
setSortFunc void setSortFunc(gtk.types.FlowBoxSortFunc sortFunc): By setting a sort function on the box, one can dynamically reorder the children of the box, based on the contents of the children.
setVadjustment void setVadjustment(gtk.adjustment.Adjustment adjustment): Hooks up an adjustment to focus handling in box. The adjustment is also used for autoscrolling during rubberband selection. See gtk.scrolled_window.ScrolledWindow.getVadjustment for a typical way of obtaining the adjustment, and gtk.flow_box.FlowBox.setHadjustmentfor setting the horizontal adjustment.
unselectAll void unselectAll(): Unselect all children of box, if the selection mode allows it.
unselectChild void unselectChild(gtk.flow_box_child.FlowBoxChild child): Unselects a single child of box, if the selection mode allows it.

Properties

_gType GType _gType [@property getter]
activateOnSingleClick bool activateOnSingleClick [@property getter]: Get activateOnSingleClick property.
activateOnSingleClick bool activateOnSingleClick [@property setter]: Set activateOnSingleClick property.
columnSpacing uint columnSpacing [@property getter]: Get columnSpacing property.
columnSpacing uint columnSpacing [@property setter]: Set columnSpacing property.
homogeneous bool homogeneous [@property getter]: Get homogeneous property.
homogeneous bool homogeneous [@property setter]: Set homogeneous property.
maxChildrenPerLine uint maxChildrenPerLine [@property getter]: Get maxChildrenPerLine property.
maxChildrenPerLine uint maxChildrenPerLine [@property setter]: Set maxChildrenPerLine property.
minChildrenPerLine uint minChildrenPerLine [@property getter]: Get minChildrenPerLine property.
minChildrenPerLine uint minChildrenPerLine [@property setter]: Set minChildrenPerLine property.
rowSpacing uint rowSpacing [@property getter]: Get rowSpacing property.
rowSpacing uint rowSpacing [@property setter]: Set rowSpacing property.
selectionMode gtk.types.SelectionMode selectionMode [@property getter]: Get selectionMode property.
selectionMode gtk.types.SelectionMode selectionMode [@property setter]: Set selectionMode property.

Static functions

_getGType GType _getGType()
builder FlowBoxGidBuilder builder(): Get builder for gtk.flow_box.FlowBox

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.

gtk flow_box classes