Struct gtk4::FlowBox

#[repr(transparent)]
pub struct FlowBox { /* private fields */ }

A FlowBox 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 FlowBox 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 ScrolledWindow to enable that.

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

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

Also see ListBox.

CSS nodes

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

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

Accessibility

FlowBox uses the AccessibleRole::Grid role, and FlowBoxChild uses the AccessibleRole::GridCell role.

Properties

accept-unpaired-release

Readable | Writeable

activate-on-single-click

Determines whether children can be activated with a single click, or require a double-click.

Readable | Writeable

column-spacing

The amount of horizontal space between two children.

Readable | Writeable

homogeneous

Determines whether all children should be allocated the same size.

Readable | Writeable

max-children-per-line

The maximum amount of children to request space for consecutively in the given orientation.

Readable | Writeable

min-children-per-line

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.

Readable | Writeable

row-spacing

The amount of vertical space between two children.

Readable | Writeable

selection-mode

The selection mode used by the flow box.

Readable | Writeable

Widget

can-focus

Whether the widget or any of its descendents can accept the input focus.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

can-target

Whether the widget can receive pointer events.

Readable | Writeable

css-classes

A list of css classes applied to this widget.

Readable | Writeable

css-name

The name of this widget in the CSS tree.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable | Construct Only

cursor

The cursor used by @widget.

Readable | Writeable

focus-on-click

Whether the widget should grab focus when it is clicked with the mouse.

This property is only relevant for widgets that can take focus.

Readable | Writeable

focusable

Whether this widget itself will accept the input focus.

Readable | Writeable

halign

How to distribute horizontal space if widget gets extra space.

Readable | Writeable

has-default

Whether the widget is the default widget.

Readable

has-focus

Whether the widget has the input focus.

Readable

has-tooltip

Enables or disables the emission of the ::query-tooltip signal on @widget.

A value of true indicates that @widget can have a tooltip, in this case the widget will be queried using query-tooltip to determine whether it will provide a tooltip or not.

Readable | Writeable

height-request

Override for height request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

hexpand

Whether to expand horizontally.

Readable | Writeable

hexpand-set

Whether to use the hexpand property.

Readable | Writeable

layout-manager

The LayoutManager instance to use to compute the preferred size of the widget, and allocate its children.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

margin-bottom

Margin on bottom side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

margin-end

Margin on end of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

margin-start

Margin on start of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

margin-top

Margin on top side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

name

The name of the widget.

Readable | Writeable

opacity

The requested opacity of the widget.

Readable | Writeable

overflow

How content outside the widget’s content area is treated.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

parent

The parent widget of this widget.

Readable

receives-default

Whether the widget will receive the default action when it is focused.

Readable | Writeable

root

The Root widget of the widget tree containing this widget.

This will be None if the widget is not contained in a root widget.

Readable

scale-factor

The scale factor of the widget.

Readable

sensitive

Whether the widget responds to input.

Readable | Writeable

tooltip-markup

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

Also see Tooltip::set_markup().

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: has-tooltip will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

Note that if both tooltip-text and tooltip-markup are set, the last one wins.

Readable | Writeable

tooltip-text

Sets the text of tooltip to be the given string.

Also see Tooltip::set_text().

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: has-tooltip will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

Note that if both tooltip-text and tooltip-markup are set, the last one wins.

Readable | Writeable

valign

How to distribute vertical space if widget gets extra space.

Readable | Writeable

vexpand

Whether to expand vertically.

Readable | Writeable

vexpand-set

Whether to use the vexpand property.

Readable | Writeable

visible

Whether the widget is visible.

Readable | Writeable

width-request

Override for width request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

Accessible

accessible-role

The accessible role of the given Accessible implementation.

The accessible role cannot be changed once set.

Readable | Writeable

Orientable

orientation

The orientation of the orientable.

Readable | Writeable

Signals

activate-cursor-child

Emitted when the user activates the @box_.

This is a keybinding signal.

Action

child-activated

Emitted when a child has been activated by the user.

move-cursor

Emitted when the user initiates a cursor movement.

This is a keybinding signal. 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 modifier does not. There are too many key combinations to list them all here.

• ←, →, ↑, ↓ move by individual children
• Home, End move to the ends of the box
• PgUp, PgDn move vertically by pages

Action

select-all

Emitted to select all children of the box, if the selection mode permits it.

This is a keybinding signal.

The default bindings for this signal is Ctrl-a.

Action

selected-children-changed

Emitted when the set of selected children changes.

Use FlowBox::selected_foreach() or FlowBox::selected_children() to obtain the selected children.

toggle-cursor-child

Emitted to toggle the selection of the child that has the focus.

This is a keybinding signal.

The default binding for this signal is Ctrl-Space.

Action

unselect-all

Emitted to unselect all children of the box, if the selection mode permits it.

This is a keybinding signal.

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

Action

Widget

destroy

Signals that all holders of a reference to the widget should release the reference that they hold.

May result in finalization of the widget if all references are released.

This signal is not suitable for saving widget state.

direction-changed

Emitted when the text direction of a widget changes.

hide

Emitted when @widget is hidden.

keynav-failed

Emitted if keyboard navigation fails.

See WidgetExt::keynav_failed() for details.

map

Emitted when @widget is going to be mapped.

A widget is mapped when the widget is visible (which is controlled with visible) and all its parents up to the toplevel widget are also visible.

The ::map signal can be used to determine whether a widget will be drawn, for instance it can resume an animation that was stopped during the emission of unmap.

mnemonic-activate

Emitted when a widget is activated via a mnemonic.

The default handler for this signal activates @widget if @group_cycling is false, or just makes @widget grab focus if @group_cycling is true.

move-focus

Emitted when the focus is moved.

The ::move-focus signal is a keybinding signal.

The default bindings for this signal are Tab to move forward, and Shift+Tab to move backward.

Action

query-tooltip

Emitted when the widget’s tooltip is about to be shown.

This happens when the has-tooltip property is true and the hover timeout has expired with the cursor hovering “above” @widget; or emitted when @widget got focus in keyboard mode.

Using the given coordinates, the signal handler should determine whether a tooltip should be shown for @widget. If this is the case true should be returned, false otherwise. Note that if @keyboard_mode is true, the values of @x and @y are undefined and should not be used.

The signal handler is free to manipulate @tooltip with the therefore destined function calls.

realize

Emitted when @widget is associated with a gdk::Surface.

This means that WidgetExt::realize() has been called or the widget has been mapped (that is, it is going to be drawn).

show

Emitted when @widget is shown.

state-flags-changed

Emitted when the widget state changes.

See WidgetExt::state_flags().

unmap

Emitted when @widget is going to be unmapped.

A widget is unmapped when either it or any of its parents up to the toplevel widget have been set as hidden.

As ::unmap indicates that a widget will not be shown any longer, it can be used to, for example, stop an animation on the widget.

unrealize

Emitted when the gdk::Surface associated with @widget is destroyed.

This means that WidgetExt::unrealize() has been called or the widget has been unmapped (that is, it is going to be hidden).

Implements

WidgetExt, glib::ObjectExt, AccessibleExt, BuildableExt, ConstraintTargetExt, OrientableExt, WidgetExtManual, AccessibleExtManual

Implementations

impl FlowBox

pub fn new() -> FlowBox

Creates a FlowBox.

Returns

a new FlowBox

pub fn builder() -> FlowBoxBuilder

Creates a new builder-pattern struct instance to construct FlowBox objects.

This method returns an instance of FlowBoxBuilder which can be used to create FlowBox objects.

pub fn append(&self, child: &impl IsA<Widget>)

Available on crate feature v4_6 only.

Adds @child to the end of @self.

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

See also: insert().

child

the Widget to add

pub fn bind_model<P: Fn(&Object) -> Widget + 'static>( &self, model: Option<&impl IsA<ListModel>>, create_widget_func: P )

Binds @model to @self.

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

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

It is undefined to add or remove widgets directly (for example, with insert()) while @self is bound to a model.

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

model

the GListModel to be bound to @self

create_widget_func

a function that creates widgets for items

pub fn activates_on_single_click(&self) -> bool

Returns whether children activate on single clicks.

Returns

true if children are activated on single click, false otherwise

pub fn child_at_index(&self, idx: i32) -> Option<FlowBoxChild>

Gets the nth child in the @self.

idx

the position of the child

Returns

the child widget, which will always be a FlowBoxChild or None in case no child widget with the given index exists.

pub fn child_at_pos(&self, x: i32, y: i32) -> Option<FlowBoxChild>

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

Both @x and @y are assumed to be relative to the origin of @self.

x

the x coordinate of the child

y

the y coordinate of the child

Returns

the child widget, which will always be a FlowBoxChild or None in case no child widget exists for the given x and y coordinates.

pub fn column_spacing(&self) -> u32

Gets the horizontal spacing.

Returns

the horizontal spacing

pub fn is_homogeneous(&self) -> bool

Returns whether the box is homogeneous.

Returns

true if the box is homogeneous.

pub fn max_children_per_line(&self) -> u32

Gets the maximum number of children per line.

Returns

the maximum number of children per line

pub fn min_children_per_line(&self) -> u32

Gets the minimum number of children per line.

Returns

the minimum number of children per line

pub fn row_spacing(&self) -> u32

Gets the vertical spacing.

Returns

the vertical spacing

pub fn selected_children(&self) -> Vec<FlowBoxChild>

Creates a list of all selected children.

Returns

A GList containing the Widget for each selected child. Free with g_list_free() when done.

pub fn selection_mode(&self) -> SelectionMode

Gets the selection mode of @self.

Returns

the SelectionMode

pub fn insert(&self, widget: &impl IsA<Widget>, position: i32)

Inserts the @widget into @self at @position.

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

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

widget

the Widget to add

position

the position to insert @child in

pub fn invalidate_filter(&self)

Updates the filtering for all children.

Call this function when the result of the filter function on the @self is changed due to 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.

pub fn invalidate_sort(&self)

Updates the sorting for all children.

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

pub fn prepend(&self, child: &impl IsA<Widget>)

Available on crate feature v4_6 only.

Adds @child to the start of @self.

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

See also: insert().

child

the Widget to add

pub fn remove(&self, widget: &impl IsA<Widget>)

Removes a child from @self.

widget

the child widget to remove

pub fn remove_all(&self)

Available on crate feature v4_12 only.

Removes all children from @self.

This function does nothing if @self is backed by a model.

pub fn select_all(&self)

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

pub fn select_child(&self, child: &impl IsA<FlowBoxChild>)

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

child

a child of @self

pub fn selected_foreach<P: FnMut(&FlowBox, &FlowBoxChild)>(&self, func: P)

Calls a function for each selected child.

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

func

the function to call for each selected child

pub fn set_activate_on_single_click(&self, single: bool)

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

single

true to emit child-activated on a single click

pub fn set_column_spacing(&self, spacing: u32)

Sets the horizontal space to add between children.

spacing

the spacing to use

pub fn set_filter_func<P: Fn(&FlowBoxChild) -> bool + 'static>( &self, filter_func: P )

By setting a filter function on the @self 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 @filter_func will be called for each child after the call, and it will continue to be called each time a child changes (via FlowBoxChildExt::changed()) or when invalidate_filter() is called.

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

filter_func

callback that lets you filter which children to show

pub fn set_hadjustment(&self, adjustment: &impl IsA<Adjustment>)

Hooks up an adjustment to focus handling in @self.

The adjustment is also used for autoscrolling during rubberband selection. See ScrolledWindow::hadjustment() for a typical way of obtaining the adjustment, and set_vadjustment() for 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.

adjustment

an adjustment which should be adjusted when the focus is moved among the descendents of @container

pub fn set_homogeneous(&self, homogeneous: bool)

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

homogeneous

true to create equal allotments, false for variable allotments

pub fn set_max_children_per_line(&self, n_children: u32)

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

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

n_children

the maximum number of children per line

pub fn set_min_children_per_line(&self, n_children: u32)

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

n_children

the minimum number of children per line

pub fn set_row_spacing(&self, spacing: u32)

Sets the vertical space to add between children.

spacing

the spacing to use

pub fn set_selection_mode(&self, mode: SelectionMode)

Sets how selection works in @self.

mode

the new selection mode

pub fn set_vadjustment(&self, adjustment: &impl IsA<Adjustment>)

Hooks up an adjustment to focus handling in @self.

The adjustment is also used for autoscrolling during rubberband selection. See ScrolledWindow::vadjustment() for a typical way of obtaining the adjustment, and set_hadjustment() for 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.

adjustment

an adjustment which should be adjusted when the focus is moved among the descendents of @container

pub fn unselect_all(&self)

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

pub fn unselect_child(&self, child: &impl IsA<FlowBoxChild>)

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

child

a child of @self

pub fn accepts_unpaired_release(&self) -> bool

pub fn set_accept_unpaired_release(&self, accept_unpaired_release: bool)

pub fn connect_activate_cursor_child<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Emitted when the user activates the @box_.

This is a keybinding signal.

pub fn emit_activate_cursor_child(&self)

pub fn connect_child_activated<F: Fn(&Self, &FlowBoxChild) + 'static>( &self, f: F ) -> SignalHandlerId

Emitted when a child has been activated by the user.

child

the child that is activated

pub fn connect_move_cursor<F: Fn(&Self, MovementStep, i32, bool, bool) -> bool + 'static>( &self, f: F ) -> SignalHandlerId

Emitted when the user initiates a cursor movement.

This is a keybinding signal. 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 modifier does not. There are too many key combinations to list them all here.

• ←, →, ↑, ↓ move by individual children
• Home, End move to the ends of the box
• PgUp, PgDn move vertically by pages

step

the granularity of the move, as a MovementStep

count

the number of @step units to move

extend

whether to extend the selection

modify

whether to modify the selection

Returns

true to stop other handlers from being invoked for the event. false to propagate the event further.

pub fn emit_move_cursor( &self, step: MovementStep, count: i32, extend: bool, modify: bool ) -> bool

pub fn connect_select_all<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Emitted to select all children of the box, if the selection mode permits it.

This is a keybinding signal.

The default bindings for this signal is Ctrl-a.

pub fn emit_select_all(&self)

pub fn connect_selected_children_changed<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Emitted when the set of selected children changes.

Use selected_foreach() or selected_children() to obtain the selected children.

pub fn connect_toggle_cursor_child<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Emitted to toggle the selection of the child that has the focus.

This is a keybinding signal.

The default binding for this signal is Ctrl-Space.

pub fn emit_toggle_cursor_child(&self)

pub fn connect_unselect_all<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Emitted to unselect all children of the box, if the selection mode permits it.

This is a keybinding signal.

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

pub fn emit_unselect_all(&self)

pub fn connect_accept_unpaired_release_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_activate_on_single_click_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_column_spacing_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_homogeneous_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_max_children_per_line_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_min_children_per_line_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_row_spacing_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_selection_mode_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

impl FlowBox

pub fn unbind_model(&self)

pub fn unset_filter_func(&self)

pub fn unset_sort_func(&self)

pub fn set_sort_func<P: Fn(&FlowBoxChild, &FlowBoxChild) -> Ordering + 'static>( &self, sort_func: P )

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

The @sort_func will be called for each child after the call, and will continue to be called each time a child changes (via FlowBoxChildExt::changed()) and when invalidate_sort() is called.

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

sort_func

the sort function

Trait Implementations

impl Clone for FlowBox

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FlowBox

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for FlowBox

fn default() -> Self

Returns the “default value” for a type.

impl Display for FlowBox

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HasParamSpec for FlowBox

type ParamSpec = ParamSpecObject

type SetValue = FlowBox

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, FlowBox>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for FlowBox

fn hash<H>(&self, state: &mut H)where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for FlowBox

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for FlowBox

type Parent = Widget

impl<OT: ObjectType> PartialEq<OT> for FlowBox

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for FlowBox

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for FlowBox

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for FlowBox

impl IsA<Accessible> for FlowBox

impl IsA<Buildable> for FlowBox

impl IsA<ConstraintTarget> for FlowBox

impl IsA<Orientable> for FlowBox

impl IsA<Widget> for FlowBox