Struct gtk::Box

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

The GtkBox widget arranges child widgets into a single row or column, depending upon the value of its property::Orientable::orientation property. Within the other dimension, all children are allocated the same size. Of course, the property::Widget::halign and property::Widget::valign properties can be used on the children to influence their allocation.

GtkBox uses a notion of packing. Packing refers to adding widgets with reference to a particular position in a Container. For a GtkBox, there are two reference positions: the start and the end of the box. For a vertical Box, the start is defined as the top of the box and the end is defined as the bottom. For a horizontal Box the start is defined as the left side and the end is defined as the right side.

Use repeated calls to BoxExt::pack_start() to pack widgets into a GtkBox from start to end. Use BoxExt::pack_end() to add widgets from end to start. You may intersperse these calls and add widgets from both ends of the same GtkBox.

Because GtkBox is a Container, you may also use ContainerExt::add() to insert widgets into the box, and they will be packed with the default values for expand and fill child properties. Use ContainerExt::remove() to remove widgets from the GtkBox.

Use BoxExt::set_homogeneous() to specify whether or not all children of the GtkBox are forced to get the same amount of space.

Use BoxExt::set_spacing() to determine how much space will be minimally placed between all children in the GtkBox. Note that spacing is added between the children, while padding added by BoxExt::pack_start() or BoxExt::pack_end() is added on either side of the widget it belongs to.

Use BoxExt::reorder_child() to move a GtkBox child to a different place in the box.

Use BoxExt::set_child_packing() to reset the expand, fill and padding child properties. Use BoxExt::query_child_packing() to query these fields.

CSS nodes

GtkBox uses a single CSS node with name box.

In horizontal orientation, the nodes of the children are always arranged from left to right. So :first-child will always select the leftmost child, regardless of text direction.

Implements

BoxExt, ContainerExt, WidgetExt, glib::ObjectExt, BuildableExt, OrientableExt, ContainerExtManual, WidgetExtManual, BuildableExtManual

Implementations

impl Box

pub const NONE: Option<&'static Box> = None

pub fn new(orientation: Orientation, spacing: i32) -> Box

Creates a new Box.

orientation

the box’s orientation.

spacing

the number of pixels to place by default between children.

Returns

a new Box.

pub fn builder() -> BoxBuilder

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

This method returns an instance of BoxBuilder which can be used to create Box objects.

Trait Implementations

impl Clone for Box

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Box

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

Formats the value using the given formatter.

impl Default for Box

fn default() -> Self

Returns the “default value” for a type.

impl Display for Box

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

Formats the value using the given formatter.

impl Hash for Box

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,

Feeds a slice of this type into the given Hasher.

impl<T: BoxImpl> IsSubclassable<T> for Box

fn class_init(class: &mut Class<Self>)

Override the virtual methods of this class for the given subclass and do other class initialization.

fn instance_init(instance: &mut InitializingObject<T>)

Instance specific initialization.

impl Ord for Box

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl ParentClassIs for Box

type Parent = Container

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

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

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

const 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 Box

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

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

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

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

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

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

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

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

const 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 Box

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Box

impl IsA<Box> for AppChooserWidget

impl IsA<Box> for ButtonBox

impl IsA<Box> for ColorChooserWidget

impl IsA<Box> for FileChooserButton

impl IsA<Box> for FileChooserWidget

impl IsA<Box> for FontChooserWidget

impl IsA<Box> for InfoBar

impl IsA<Box> for RecentChooserWidget

impl IsA<Box> for ShortcutLabel

impl IsA<Box> for ShortcutsGroup

impl IsA<Box> for ShortcutsSection

impl IsA<Box> for ShortcutsShortcut

impl IsA<Box> for StackSwitcher

impl IsA<Box> for Statusbar

impl IsA<Buildable> for Box

impl IsA<Container> for Box

impl IsA<Orientable> for Box

impl IsA<Widget> for Box