class Gtk::FlowBox

• Gtk::FlowBox
• Gtk::Widget
• GObject::InitiallyUnowned
• GObject::Object
• Reference
• Object

Overview

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

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

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

Also see Gtk::ListBox.

CSS nodes

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

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

Accessibility

Gtk::FlowBox uses the %GTK_ACCESSIBLE_ROLE_GRID role, and Gtk::FlowBoxChild uses the %GTK_ACCESSIBLE_ROLE_GRID_CELL role.

Included Modules

• Gtk::Accessible
• Gtk::Buildable
• Gtk::ConstraintTarget
• Gtk::Orientable

Defined in:

Constructors

• .new : self

  Creates a Gtk::FlowBox.

• .new(*, accept_unpaired_release : Bool? = nil, accessible_role : Gtk::AccessibleRole? = nil, activate_on_single_click : Bool? = nil, can_focus : Bool? = nil, can_target : Bool? = nil, column_spacing : UInt32? = nil, css_classes : Enumerable(String)? = nil, css_name : String? = nil, cursor : Gdk::Cursor? = nil, focus_on_click : Bool? = nil, focusable : Bool? = nil, halign : Gtk::Align? = nil, has_default : Bool? = nil, has_focus : Bool? = nil, has_tooltip : Bool? = nil, height_request : Int32? = nil, hexpand : Bool? = nil, hexpand_set : Bool? = nil, homogeneous : Bool? = nil, layout_manager : Gtk::LayoutManager? = nil, margin_bottom : Int32? = nil, margin_end : Int32? = nil, margin_start : Int32? = nil, margin_top : Int32? = nil, max_children_per_line : UInt32? = nil, min_children_per_line : UInt32? = nil, name : String? = nil, opacity : Float64? = nil, orientation : Gtk::Orientation? = nil, overflow : Gtk::Overflow? = nil, parent : Gtk::Widget? = nil, receives_default : Bool? = nil, root : Gtk::Root? = nil, row_spacing : UInt32? = nil, scale_factor : Int32? = nil, selection_mode : Gtk::SelectionMode? = nil, sensitive : Bool? = nil, tooltip_markup : String? = nil, tooltip_text : String? = nil, valign : Gtk::Align? = nil, vexpand : Bool? = nil, vexpand_set : Bool? = nil, visible : Bool? = nil, width_request : Int32? = nil)

Class Method Summary

• .g_type : UInt64

  Returns the type id (GType) registered in GLib type system.

Instance Method Summary

• #accept_unpaired_release=(value : Bool) : Bool
• #accept_unpaired_release? : Bool
• #activate_cursor_child_signal
• #activate_on_single_click : Bool

  Returns whether children activate on single clicks.

• #activate_on_single_click=(single : Bool) : Nil

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

• #activate_on_single_click? : Bool
• #append(child : Gtk::Widget) : Nil

  Adds @child to the end of @self.

• #bind_model(model : Gio::ListModel?, create_widget_func : Gtk::FlowBoxCreateWidgetFunc) : Nil

  Binds @model to @box.

• #child_activated_signal
• #child_at_index(idx : Int32) : Gtk::FlowBoxChild?

  Gets the nth child in the @box.

• #child_at_pos(x : Int32, y : Int32) : Gtk::FlowBoxChild?

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

• #column_spacing : UInt32

  Gets the horizontal spacing.

• #column_spacing=(spacing : UInt32) : Nil

  Sets the horizontal space to add between children.

• #filter_func=(filter_func : Gtk::FlowBoxFilterFunc?) : Nil

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

• #hadjustment=(adjustment : Gtk::Adjustment) : Nil

  Hooks up an adjustment to focus handling in @box.

• #homogeneous : Bool

  Returns whether the box is homogeneous.

• #homogeneous=(homogeneous : Bool) : Nil

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

• #homogeneous? : Bool
• #insert(widget : Gtk::Widget, position : Int32) : Nil

  Inserts the @widget into @box at @position.

• #invalidate_filter : Nil

  Updates the filtering for all children.

• #invalidate_sort : Nil

  Updates the sorting for all children.

• #max_children_per_line : UInt32

  Gets the maximum number of children per line.

• #max_children_per_line=(n_children : UInt32) : Nil

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

• #min_children_per_line : UInt32

  Gets the minimum number of children per line.

• #min_children_per_line=(n_children : UInt32) : Nil

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

• #move_cursor_signal
• #prepend(child : Gtk::Widget) : Nil

  Adds @child to the start of @self.

• #remove(widget : Gtk::Widget) : Nil

  Removes a child from @box.

• #row_spacing : UInt32

  Gets the vertical spacing.

• #row_spacing=(spacing : UInt32) : Nil

  Sets the vertical space to add between children.

• #select_all : Nil

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

• #select_all_signal
• #select_child(child : Gtk::FlowBoxChild) : Nil

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

• #selected_children : GLib::List

  Creates a list of all selected children.

• #selected_children_changed_signal
• #selected_foreach(func : Gtk::FlowBoxForeachFunc, data : Pointer(Void)?) : Nil

  Calls a function for each selected child.

• #selection_mode : Gtk::SelectionMode

  Gets the selection mode of @box.

• #selection_mode=(mode : Gtk::SelectionMode) : Nil

  Sets how selection works in @box.

• #sort_func=(sort_func : Gtk::FlowBoxSortFunc?) : Nil

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

• #toggle_cursor_child_signal
• #unselect_all : Nil

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

• #unselect_all_signal
• #unselect_child(child : Gtk::FlowBoxChild) : Nil

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

• #vadjustment=(adjustment : Gtk::Adjustment) : Nil

  Hooks up an adjustment to focus handling in @box.

Constructor Detail

Class Method Detail

Instance Method Detail