Adw.WrapBox – libadwaita-1 – Vala Binding Reference

Description:

[ CCode ( type_id = "adw_wrap_box_get_type ()" ) ]
[ Version ( since = "1.7" ) ]
public class WrapBox : Widget, Accessible, Buildable, ConstraintTarget, Orientable

A box-like widget that can wrap into multiple lines.

`AdwWrapBox` is similar to [class@Gtk.Box], but can wrap lines when the widgets cannot fit otherwise. Unlike [class@Gtk.FlowBox], the children aren't arranged into a grid and behave more like words in a wrapping label.

Like `GtkBox`, `AdwWrapBox` is orientable and has spacing:

[property@WrapBox:child-spacing] between children in the same line;
[property@WrapBox:line-spacing] between lines.

::: note Unlike `GtkBox`, `AdwWrapBox` cannot follow the CSS `border-spacing` property.

Use the [property@WrapBox:natural-line-length] property to determine the layout's natural size, e.g. when using it in a [ class@Gtk.Popover].

Normally, a horizontal `AdwWrapBox` wraps left to right and top to bottom for left-to-right languages. Both of these directions can be reversed, using the [property@WrapBox:pack-direction] and [property@WrapBox:wrap-reverse] properties. Additionally, the alignment of each line can be controlled with the [property@WrapBox:align] property.

Lines can be justified using the [property@WrapBox:justify] property, filling the entire line by either increasing child size or spacing depending on the value. Set [property@WrapBox:justify-last-line] to justify the last line as well.

By default, `AdwWrapBox` wraps as soon as the previous line cannot fit any more children without shrinking them past their natural size. Set [property@WrapBox:wrap-policy] to [enum@Adw.WrapPolicy.minimum] to only wrap once all the children in the previous line have been shrunk to their minimum size.

To make each line take the same amount of space, set [property@WrapBox:line-homogeneous] to `TRUE`.

Spacing and natural line length can scale with the text scale factor, use the [property@WrapBox:child-spacing-unit], [ property@WrapBox:line-spacing-unit] and/or [property@WrapBox:natural-line-length-unit] properties to enable that behavior.

See [class@WrapLayout].

CSS nodes

`AdwWrapBox` uses a single CSS node with name `wrap-box`.

Accessibility

`AdwWrapBox` uses the [enum@Gtk.AccessibleRole.group] role.

Namespace: Adw

Content:

Properties:

public float align { get; set; }

The alignment of the children within each line.

public int child_spacing { get; set; }

The spacing between widgets on the same line.

public LengthUnit child_spacing_unit { get; set; }

The length unit for child spacing.

public JustifyMode justify { get; set; }

Determines whether and how each complete line should be stretched to fill the entire widget.

public bool justify_last_line { get; set; }

Whether the last line should be stretched to fill the entire widget.

public bool line_homogeneous { get; set; }

Whether all lines should take the same amount of space.

public int line_spacing { get; set; }

The spacing between lines.

public LengthUnit line_spacing_unit { get; set; }

The length unit for line spacing.

public int natural_line_length { get; set; }

Determines the natural size for each line.

public LengthUnit natural_line_length_unit { get; set; }

The length unit for natural line length.

public PackDirection pack_direction { get; set; }

The direction children are packed in each line.

public WrapPolicy wrap_policy { get; set; }

The policy for line wrapping.

public bool wrap_reverse { get; set; }

Whether wrap direction should be reversed.

Creation methods:

public WrapBox ()

Creates a new `AdwWrapBox`.

Methods:

public void append (Widget child)

Adds child as the last child to this.

public float get_align ()

Gets the alignment of the children within each line.

public int get_child_spacing ()

Gets spacing between widgets on the same line.

public LengthUnit get_child_spacing_unit ()

Gets the length unit for child spacing.

public JustifyMode get_justify ()

Gets whether and how each complete line is stretched to fill the entire widget.

public bool get_justify_last_line ()

Gets whether the last line should be stretched to fill the entire widget.

public bool get_line_homogeneous ()

Gets whether all lines should take the same amount of space.

public int get_line_spacing ()

Gets the spacing between lines.

public LengthUnit get_line_spacing_unit ()

Gets the length unit for line spacing.

public int get_natural_line_length ()

Gets the natural size for each line.

public LengthUnit get_natural_line_length_unit ()

Gets the length unit for line spacing.

public PackDirection get_pack_direction ()

Gets the direction children are packed in each line.

public WrapPolicy get_wrap_policy ()

Gets the policy for line wrapping.

public bool get_wrap_reverse ()

Gets whether wrap direction is reversed.

public void insert_child_after (Widget child, Widget? sibling)

Inserts child in the position after sibling in the list of this children.

public void prepend (Widget child)

Adds child as the first child to this.

public void remove (Widget child)

Removes a child widget from this.

public void remove_all ()

Removes all children from this.

public void reorder_child_after (Widget child, Widget? sibling)

Moves child to the position after sibling in the list of this children.

public void set_align (float align)

Sets the alignment of the children within each line.

public void set_child_spacing (int child_spacing)

Sets the spacing between widgets on the same line.

public void set_child_spacing_unit (LengthUnit unit)

Sets the length unit for child spacing.

public void set_justify (JustifyMode justify)

Determines whether and how each complete line should be stretched to fill the entire widget.

public void set_justify_last_line (bool justify_last_line)

Sets whether the last line should be stretched to fill the entire widget.

public void set_line_homogeneous (bool homogeneous)

Sets whether all lines should take the same amount of space.

public void set_line_spacing (int line_spacing)

Sets the spacing between lines.

public void set_line_spacing_unit (LengthUnit unit)

Sets the length unit for line spacing.

public void set_natural_line_length (int natural_line_length)

Sets the natural size for each line.

public void set_natural_line_length_unit (LengthUnit unit)

Sets the length unit for natural line length.

public void set_pack_direction (PackDirection pack_direction)

Sets the direction children are packed in each line.

public void set_wrap_policy (WrapPolicy wrap_policy)

Sets the policy for line wrapping.

public void set_wrap_reverse (bool wrap_reverse)

Sets whether wrap direction should be reversed.

Inherited Members:

All known members inherited from interface Gtk.Orientable

get_orientation

orientation

set_orientation

WrapBox

Object Hierarchy: