Struct WrapBox

pub struct WrapBox { /* private fields */ }

Available on crate feature v1_7 only.

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

WrapBox is similar to Gtk::Box, but can wrap lines when the widgets cannot fit otherwise. Unlike Gtk::FlowBox, the children aren’t arranged into a grid and behave more like words in a wrapping label.

Like GtkBox, WrapBox is orientable and has spacing:

• child-spacing between children in the same line;
• line-spacing between lines.

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

Use the natural-line-length property to determine the layout’s natural size, e.g. when using it in a gtk::Popover.

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

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

By default, WrapBox wraps as soon as the previous line cannot fit any more children without shrinking them past their natural size. Set 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 line-homogeneous to TRUE.

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

See WrapLayout.

CSS nodes

WrapBox uses a single CSS node with name wrap-box.

Accessibility

WrapBox uses the GTK_ACCESSIBLE_ROLE_GROUP role.

Properties

align

The alignment of the children within each line.

0 means the children are placed at the start of the line, 1 means they are placed at the end of the line. 0.5 means they are placed in the middle of the line.

Alignment is only used when justify is set to ADW_JUSTIFY_NONE, or on the last line when the justify-last-line is FALSE.

Readable | Writeable

child-spacing

The spacing between widgets on the same line.

See child-spacing-unit.

Readable | Writeable

child-spacing-unit

The length unit for child spacing.

Allows the spacing to vary depending on the text scale factor.

See child-spacing.

Readable | Writeable

justify

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

If set to ADW_JUSTIFY_FILL, each widget in the line will be stretched, keeping consistent spacing, so that the line fills the entire widget.

If set to ADW_JUSTIFY_SPREAD, the spacing between widgets will be increased, keeping widget sizes intact. The first and last widget will be aligned with the beginning and end of the line. If the line only contains a single widget, it will be stretched regardless.

If set to ADW_JUSTIFY_NONE, the line will not be stretched and the children will be placed together within the line, according to align.

By default this doesn’t affect the last line, as it will be incomplete. Use justify-last-line to justify it as well.

Readable | Writeable

justify-last-line

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

See justify.

Readable | Writeable

line-homogeneous

Whether all lines should take the same amount of space.

Readable | Writeable

line-spacing

The spacing between lines.

See line-spacing-unit.

Readable | Writeable

line-spacing-unit

The length unit for line spacing.

Allows the spacing to vary depending on the text scale factor.

See line-spacing.

Readable | Writeable

natural-line-length

Determines the natural size for each line.

It should be used to limit the line lengths, for example when used in popovers.

See natural-line-length-unit.

Readable | Writeable

natural-line-length-unit

The length unit for natural line length.

Allows the length to vary depending on the text scale factor.

See natural-line-length.

Readable | Writeable

pack-direction

The direction children are packed in each line.

Readable | Writeable

wrap-policy

Whether wrap direction should be reversed.

By default, lines wrap downwards in a horizontal box, and towards the end in a vertical box. If set to TRUE, they wrap upwards or towards the start respectively.

Readable | Writeable

wrap-reverse

Whether wrap direction should be reversed.

By default, lines wrap downwards in a horizontal box, and towards the end in a vertical box. If set to TRUE, they wrap upwards or towards the start respectively.

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 gtk::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 [WidgetExtManual::set_size_request()][crate::gtk::prelude::WidgetExtManual::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 [WidgetExtManual::set_size_request()][crate::gtk::prelude::WidgetExtManual::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 [WidgetExtManual::set_size_request()][crate::gtk::prelude::WidgetExtManual::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 [WidgetExtManual::set_size_request()][crate::gtk::prelude::WidgetExtManual::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 gtk::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 Gtk::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 Gtk::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 gtk::Accessible implementation.

The accessible role cannot be changed once set.

Readable | Writeable

Orientable

orientation

The orientation of the orientable.

Readable | Writeable

Implements

gtk::prelude::WidgetExt, [trait@glib::ObjectExt], gtk::prelude::AccessibleExt, gtk::prelude::BuildableExt, gtk::prelude::ConstraintTargetExt, gtk::prelude::OrientableExt

GLib type: GObject with reference counted clone semantics.

Implementations

impl WrapBox

pub fn new() -> WrapBox

Creates a new WrapBox.

Returns

the newly created WrapBox

pub fn builder() -> WrapBoxBuilder

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

This method returns an instance of WrapBoxBuilder which can be used to create WrapBox objects.

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

Adds @child as the last child to @self.

child

the widget to append

pub fn align(&self) -> f32

Gets the alignment of the children within each line.

Returns

the child alignment

pub fn child_spacing(&self) -> i32

Gets spacing between widgets on the same line.

Returns

spacing between widgets on the same line

pub fn child_spacing_unit(&self) -> LengthUnit

Gets the length unit for child spacing.

Returns

the length unit

pub fn justify(&self) -> JustifyMode

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

Returns

the justify mode

pub fn is_justify_last_line(&self) -> bool

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

Returns

whether the last line is justified

pub fn is_line_homogeneous(&self) -> bool

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

Returns

whether lines should be homogeneous

pub fn line_spacing(&self) -> i32

Gets the spacing between lines.

See line-spacing-unit.

Returns

the line spacing

pub fn line_spacing_unit(&self) -> LengthUnit

Gets the length unit for line spacing.

Returns

the length unit

pub fn natural_line_length(&self) -> i32

Gets the natural size for each line.

Returns

the natural length

pub fn natural_line_length_unit(&self) -> LengthUnit

Gets the length unit for line spacing.

Returns

the length unit

pub fn pack_direction(&self) -> PackDirection

Gets the direction children are packed in each line.

Returns

the line direction

pub fn wrap_policy(&self) -> WrapPolicy

Gets the policy for line wrapping.

Returns

the wrap policy

pub fn wraps_reverse(&self) -> bool

Gets whether wrap direction is reversed.

Returns

whether wrap direction is reversed

pub fn insert_child_after( &self, child: &impl IsA<Widget>, sibling: Option<&impl IsA<Widget>>, )

Inserts @child in the position after @sibling in the list of @self children.

If @sibling is NULL, inserts @child at the first position.

child

the widget to insert

sibling

the sibling after which to insert @child

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

Adds @child as the first child to @self.

child

the widget to prepend

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

Removes a child widget from @self.

The child must have been added before with append(), prepend(), or insert_child_after().

child

the child to remove

pub fn reorder_child_after( &self, child: &impl IsA<Widget>, sibling: Option<&impl IsA<Widget>>, )

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

If @sibling is NULL, moves @child to the first position.

child

the widget to move, must be a child of @self

sibling

the sibling to move @child after

pub fn set_align(&self, align: f32)

Sets the alignment of the children within each line.

0 means the children are placed at the start of the line, 1 means they are placed at the end of the line. 0.5 means they are placed in the middle of the line.

Alignment is only used when justify is set to ADW_JUSTIFY_NONE, or on the last line when the justify-last-line is FALSE.

align

the child alignment

pub fn set_child_spacing(&self, child_spacing: i32)

Sets the spacing between widgets on the same line.

See child-spacing-unit.

child_spacing

the child spacing

pub fn set_child_spacing_unit(&self, unit: LengthUnit)

Sets the length unit for child spacing.

Allows the spacing to vary depending on the text scale factor.

See child-spacing.

unit

the length unit

pub fn set_justify(&self, justify: JustifyMode)

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

If set to ADW_JUSTIFY_FILL, each widget in the line will be stretched, keeping consistent spacing, so that the line fills the entire widget.

If set to ADW_JUSTIFY_SPREAD, the spacing between widgets will be increased, keeping widget sizes intact. The first and last widget will be aligned with the beginning and end of the line. If the line only contains a single widget, it will be stretched regardless.

If set to ADW_JUSTIFY_NONE, the line will not be stretched and the children will be placed together within the line, according to align.

By default this doesn’t affect the last line, as it will be incomplete. Use justify-last-line to justify it as well.

justify

the justify mode

pub fn set_justify_last_line(&self, justify_last_line: bool)

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

See justify.

justify_last_line

whether to justify the last line

pub fn set_line_homogeneous(&self, homogeneous: bool)

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

homogeneous

whether lines should be homogeneous

pub fn set_line_spacing(&self, line_spacing: i32)

Sets the spacing between lines.

line_spacing

the line spacing

pub fn set_line_spacing_unit(&self, unit: LengthUnit)

Sets the length unit for line spacing.

Allows the spacing to vary depending on the text scale factor.

See line-spacing.

unit

the length unit

pub fn set_natural_line_length(&self, natural_line_length: i32)

Sets the natural size for each line.

It should be used to limit the line lengths, for example when used in popovers.

See natural-line-length-unit.

natural_line_length

the natural length

pub fn set_natural_line_length_unit(&self, unit: LengthUnit)

Sets the length unit for natural line length.

Allows the length to vary depending on the text scale factor.

See natural-line-length.

unit

the length unit

pub fn set_pack_direction(&self, pack_direction: PackDirection)

Sets the direction children are packed in each line.

pack_direction

the new line direction

pub fn set_wrap_policy(&self, wrap_policy: WrapPolicy)

Sets the policy for line wrapping.

If set to ADW_WRAP_NATURAL, the box will wrap to the next line as soon as the previous line cannot fit any more children without shrinking them past their natural size.

If set to ADW_WRAP_MINIMUM, the box will try to fit as many children into each line as possible, shrinking them down to their minimum size before wrapping to the next line.

wrap_policy

the new wrap policy

pub fn set_wrap_reverse(&self, wrap_reverse: bool)

Sets whether wrap direction should be reversed.

By default, lines wrap downwards in a horizontal box, and towards the end in a vertical box. If set to TRUE, they wrap upwards or towards the start respectively.

wrap_reverse

whether to reverse wrap direction

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

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

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

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

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

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

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

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

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

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

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

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

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

Trait Implementations

impl Clone for WrapBox

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

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

Performs copy-assignment from source.

impl Debug for WrapBox

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

Formats the value using the given formatter.

impl Default for WrapBox

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for WrapBox

type ParamSpec = ParamSpecObject

type SetValue = WrapBox

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for WrapBox

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

where H: Hasher,

Hashes the memory address of this object.

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 WrapBox

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

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl ParentClassIs for WrapBox

type Parent = Widget

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

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

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

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

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

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

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

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl StaticType for WrapBox

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for WrapBox

impl IsA<Accessible> for WrapBox

impl IsA<Buildable> for WrapBox

impl IsA<ConstraintTarget> for WrapBox

impl IsA<Orientable> for WrapBox

impl IsA<Widget> for WrapBox