Struct gtk4::BoxLayout

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

BoxLayout is a layout manager that arranges children in a single row or column.

Whether it is a row or column depends on the value of its orientation property. Within the other dimension all children all allocated the same size. The BoxLayout will respect the halign and valign properties of each child widget.

If you want all children to be assigned the same size, you can use the homogeneous property.

If you want to specify the amount of space placed between each child, you can use the spacing property.

Properties

baseline-child

The child that determines the baseline of the box in vertical layout.

If the child does baseline positioning, then its baseline is lined up with the baseline of the box. If it doesn’t, then the bottom edge of the child is used.

Readable | Writeable

baseline-position

The position of the allocated baseline within the extra space allocated to each child.

This property is only relevant for horizontal layouts containing at least one child with a baseline alignment.

Readable | Writeable

homogeneous

Whether the box layout should distribute the available space equally among the children.

Readable | Writeable

spacing

The space to put between the children.

Readable | Writeable

Orientable

orientation

The orientation of the orientable.

Readable | Writeable

Implements

LayoutManagerExt, glib::ObjectExt, OrientableExt

Implementations

impl BoxLayout

pub fn new(orientation: Orientation) -> BoxLayout

Creates a new BoxLayout.

orientation

the orientation for the new layout

Returns

a new box layout

pub fn builder() -> BoxLayoutBuilder

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

This method returns an instance of BoxLayoutBuilder which can be used to create BoxLayout objects.

pub fn baseline_child(&self) -> i32

Available on crate feature v4_12 only.

Gets the value set by gtk_box_layout_set_baseline_child().

Returns

the index of the child that determines the baseline in vertical layout, or -1

pub fn baseline_position(&self) -> BaselinePosition

Gets the value set by gtk_box_layout_set_baseline_position().

Returns

the baseline position

pub fn is_homogeneous(&self) -> bool

Returns whether the layout is set to be homogeneous.

Returns

true if the layout is homogeneous

pub fn spacing(&self) -> u32

Returns the space that @self puts between children.

Returns

the spacing of the layout

pub fn set_baseline_child(&self, child: i32)

Available on crate feature v4_12 only.

Sets the index of the child that determines the baseline in vertical layout.

child

the child position, or -1

pub fn set_baseline_position(&self, position: BaselinePosition)

Sets the baseline position of a box layout.

The baseline position affects only horizontal boxes with at least one baseline aligned child. If there is more vertical space available than requested, and the baseline is not allocated by the parent then the given @position is used to allocate the baseline within the extra space available.

position

a BaselinePosition

pub fn set_homogeneous(&self, homogeneous: bool)

Sets whether the box layout will allocate the same size to all children.

homogeneous

true to set the box layout as homogeneous

pub fn set_spacing(&self, spacing: u32)

Sets how much spacing to put between children.

spacing

the spacing to apply between children

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

Available on crate feature v4_12 only.

pub fn connect_baseline_position_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_spacing_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Trait Implementations

impl Clone for BoxLayout

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 BoxLayout

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

Formats the value using the given formatter.

impl Default for BoxLayout

fn default() -> Self

Returns the “default value” for a type.

impl Display for BoxLayout

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

Formats the value using the given formatter.

impl HasParamSpec for BoxLayout

type ParamSpec = ParamSpecObject

type SetValue = BoxLayout

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for BoxLayout

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 BoxLayout

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 BoxLayout

type Parent = LayoutManager

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

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 BoxLayout

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 BoxLayout

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for BoxLayout

impl IsA<LayoutManager> for BoxLayout

impl IsA<Orientable> for BoxLayout