gtk/auto/

box_.rs

// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT

use crate::{
    Align, BaselinePosition, Buildable, Container, Orientable, Orientation, PackType, ResizeMode,
    Widget,
};
use glib::{
    prelude::*,
    signal::{connect_raw, SignalHandlerId},
    translate::*,
};
use std::{boxed::Box as Box_, fmt, mem, mem::transmute};

glib::wrapper! {
    /// The GtkBox widget arranges child widgets into a single row or column,
    /// depending upon the value of its [`orientation`][struct@crate::Orientable#orientation] property. Within
    /// the other dimension, all children are allocated the same size. Of course,
    /// the [`halign`][struct@crate::Widget#halign] and [`valign`][struct@crate::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`][crate::Container]. For a GtkBox, there are two reference positions: the
    /// start and the end of the box.
    /// For a vertical [`Box`][crate::Box], the start is defined as the top of the box and
    /// the end is defined as the bottom. For a horizontal [`Box`][crate::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()`][crate::prelude::BoxExt::pack_start()] to pack widgets into a
    /// GtkBox from start to end. Use [`BoxExt::pack_end()`][crate::prelude::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`][crate::Container], you may also use [`ContainerExt::add()`][crate::prelude::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()`][crate::prelude::ContainerExt::remove()]
    /// to remove widgets from the GtkBox.
    ///
    /// Use [`BoxExt::set_homogeneous()`][crate::prelude::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()`][crate::prelude::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()`][crate::prelude::BoxExt::pack_start()] or [`BoxExt::pack_end()`][crate::prelude::BoxExt::pack_end()] is added
    /// on either side of the widget it belongs to.
    ///
    /// Use [`BoxExt::reorder_child()`][crate::prelude::BoxExt::reorder_child()] to move a GtkBox child to a different
    /// place in the box.
    ///
    /// Use [`BoxExt::set_child_packing()`][crate::prelude::BoxExt::set_child_packing()] to reset the expand,
    /// fill and padding child properties.
    /// Use [`BoxExt::query_child_packing()`][crate::prelude::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.
    ///
    /// ## Properties
    ///
    ///
    /// #### `baseline-position`
    ///  Readable | Writeable
    ///
    ///
    /// #### `homogeneous`
    ///  Readable | Writeable
    ///
    ///
    /// #### `spacing`
    ///  Readable | Writeable
    /// <details><summary><h4>Container</h4></summary>
    ///
    ///
    /// #### `border-width`
    ///  Readable | Writeable
    ///
    ///
    /// #### `child`
    ///  Writeable
    ///
    ///
    /// #### `resize-mode`
    ///  Readable | Writeable
    /// </details>
    /// <details><summary><h4>Widget</h4></summary>
    ///
    ///
    /// #### `app-paintable`
    ///  Readable | Writeable
    ///
    ///
    /// #### `can-default`
    ///  Readable | Writeable
    ///
    ///
    /// #### `can-focus`
    ///  Readable | Writeable
    ///
    ///
    /// #### `composite-child`
    ///  Readable
    ///
    ///
    /// #### `double-buffered`
    ///  Whether the widget is double buffered.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `events`
    ///  Readable | Writeable
    ///
    ///
    /// #### `expand`
    ///  Whether to expand in both directions. Setting this sets both [`hexpand`][struct@crate::Widget#hexpand] and [`vexpand`][struct@crate::Widget#vexpand]
    ///
    /// 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.
    ///
    /// Before 3.20, several widgets (GtkButton, GtkFileChooserButton,
    /// GtkComboBox) implemented this property individually.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `halign`
    ///  How to distribute horizontal space if widget gets extra space, see [`Align`][crate::Align]
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `has-default`
    ///  Readable | Writeable
    ///
    ///
    /// #### `has-focus`
    ///  Readable | Writeable
    ///
    ///
    /// #### `has-tooltip`
    ///  Enables or disables the emission of [`query-tooltip`][struct@crate::Widget#query-tooltip] on `widget`.
    /// A value of [`true`] indicates that `widget` can have a tooltip, in this case
    /// the widget will be queried using [`query-tooltip`][struct@crate::Widget#query-tooltip] to determine
    /// whether it will provide a tooltip or not.
    ///
    /// Note that setting this property to [`true`] for the first time will change
    /// the event masks of the GdkWindows of this widget to include leave-notify
    /// and motion-notify events. This cannot and will not be undone when the
    /// property is set to [`false`] again.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `height-request`
    ///  Readable | Writeable
    ///
    ///
    /// #### `hexpand`
    ///  Whether to expand horizontally. See [`WidgetExt::set_hexpand()`][crate::prelude::WidgetExt::set_hexpand()].
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `hexpand-set`
    ///  Whether to use the [`hexpand`][struct@crate::Widget#hexpand] property. See [`WidgetExt::is_hexpand_set()`][crate::prelude::WidgetExt::is_hexpand_set()].
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `is-focus`
    ///  Readable | Writeable
    ///
    ///
    /// #### `margin`
    ///  Sets all four sides' margin at once. If read, returns max
    /// margin on any side.
    ///
    /// 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
    /// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::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
    /// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `margin-left`
    ///  Margin on left 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
    /// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `margin-right`
    ///  Margin on right 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
    /// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::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
    /// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::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
    /// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `name`
    ///  Readable | Writeable
    ///
    ///
    /// #### `no-show-all`
    ///  Readable | Writeable
    ///
    ///
    /// #### `opacity`
    ///  The requested opacity of the widget. See [`WidgetExt::set_opacity()`][crate::prelude::WidgetExt::set_opacity()] for
    /// more details about window opacity.
    ///
    /// Before 3.8 this was only available in GtkWindow
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `parent`
    ///  Readable | Writeable
    ///
    ///
    /// #### `receives-default`
    ///  Readable | Writeable
    ///
    ///
    /// #### `scale-factor`
    ///  The scale factor of the widget. See [`WidgetExt::scale_factor()`][crate::prelude::WidgetExt::scale_factor()] for
    /// more details about widget scaling.
    ///
    /// Readable
    ///
    ///
    /// #### `sensitive`
    ///  Readable | Writeable
    ///
    ///
    /// #### `style`
    ///  The style of the widget, which contains information about how it will look (colors, etc).
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `tooltip-markup`
    ///  Sets the text of tooltip to be the given string, which is marked up
    /// with the [Pango text markup language][PangoMarkupFormat].
    /// Also see [`Tooltip::set_markup()`][crate::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`][struct@crate::Widget#has-tooltip]
    /// will automatically be set to [`true`] and there will be taken care of
    /// [`query-tooltip`][struct@crate::Widget#query-tooltip] in the default signal handler.
    ///
    /// Note that if both [`tooltip-text`][struct@crate::Widget#tooltip-text] and [`tooltip-markup`][struct@crate::Widget#tooltip-markup]
    /// are set, the last one wins.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `tooltip-text`
    ///  Sets the text of tooltip to be the given string.
    ///
    /// Also see [`Tooltip::set_text()`][crate::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`][struct@crate::Widget#has-tooltip]
    /// will automatically be set to [`true`] and there will be taken care of
    /// [`query-tooltip`][struct@crate::Widget#query-tooltip] in the default signal handler.
    ///
    /// Note that if both [`tooltip-text`][struct@crate::Widget#tooltip-text] and [`tooltip-markup`][struct@crate::Widget#tooltip-markup]
    /// are set, the last one wins.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `valign`
    ///  How to distribute vertical space if widget gets extra space, see [`Align`][crate::Align]
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `vexpand`
    ///  Whether to expand vertically. See [`WidgetExt::set_vexpand()`][crate::prelude::WidgetExt::set_vexpand()].
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `vexpand-set`
    ///  Whether to use the [`vexpand`][struct@crate::Widget#vexpand] property. See [`WidgetExt::is_vexpand_set()`][crate::prelude::WidgetExt::is_vexpand_set()].
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `visible`
    ///  Readable | Writeable
    ///
    ///
    /// #### `width-request`
    ///  Readable | Writeable
    ///
    ///
    /// #### `window`
    ///  The widget's window if it is realized, [`None`] otherwise.
    ///
    /// Readable
    /// </details>
    /// <details><summary><h4>Orientable</h4></summary>
    ///
    ///
    /// #### `orientation`
    ///  The orientation of the orientable.
    ///
    /// Readable | Writeable
    /// </details>
    ///
    /// # Implements
    ///
    /// [`BoxExt`][trait@crate::prelude::BoxExt], [`ContainerExt`][trait@crate::prelude::ContainerExt], [`WidgetExt`][trait@crate::prelude::WidgetExt], [`trait@glib::ObjectExt`], [`BuildableExt`][trait@crate::prelude::BuildableExt], [`OrientableExt`][trait@crate::prelude::OrientableExt], [`ContainerExtManual`][trait@crate::prelude::ContainerExtManual], [`WidgetExtManual`][trait@crate::prelude::WidgetExtManual], [`BuildableExtManual`][trait@crate::prelude::BuildableExtManual]
    #[doc(alias = "GtkBox")]
    pub struct Box(Object<ffi::GtkBox, ffi::GtkBoxClass>) @extends Container, Widget, @implements Buildable, Orientable;

    match fn {
        type_ => || ffi::gtk_box_get_type(),
    }
}

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

    /// Creates a new [`Box`][crate::Box].
    /// ## `orientation`
    /// the box’s orientation.
    /// ## `spacing`
    /// the number of pixels to place by default between children.
    ///
    /// # Returns
    ///
    /// a new [`Box`][crate::Box].
    #[doc(alias = "gtk_box_new")]
    pub fn new(orientation: Orientation, spacing: i32) -> Box {
        assert_initialized_main_thread!();
        unsafe {
            Widget::from_glib_none(ffi::gtk_box_new(orientation.into_glib(), spacing)).unsafe_cast()
        }
    }

    // rustdoc-stripper-ignore-next
    /// Creates a new builder-pattern struct instance to construct [`Box`] objects.
    ///
    /// This method returns an instance of [`BoxBuilder`](crate::builders::BoxBuilder) which can be used to create [`Box`] objects.
    pub fn builder() -> BoxBuilder {
        BoxBuilder::new()
    }
}

impl Default for Box {
    fn default() -> Self {
        glib::object::Object::new::<Self>()
    }
}

// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`Box`] objects.
///
/// [builder-pattern]: https://doc.rust-lang.org/1.0.0/style/ownership/builders.html
#[must_use = "The builder must be built to be used"]
pub struct BoxBuilder {
    builder: glib::object::ObjectBuilder<'static, Box>,
}

impl BoxBuilder {
    fn new() -> Self {
        Self {
            builder: glib::object::Object::builder(),
        }
    }

    pub fn baseline_position(self, baseline_position: BaselinePosition) -> Self {
        Self {
            builder: self
                .builder
                .property("baseline-position", baseline_position),
        }
    }

    pub fn homogeneous(self, homogeneous: bool) -> Self {
        Self {
            builder: self.builder.property("homogeneous", homogeneous),
        }
    }

    pub fn spacing(self, spacing: i32) -> Self {
        Self {
            builder: self.builder.property("spacing", spacing),
        }
    }

    pub fn border_width(self, border_width: u32) -> Self {
        Self {
            builder: self.builder.property("border-width", border_width),
        }
    }

    pub fn child(self, child: &impl IsA<Widget>) -> Self {
        Self {
            builder: self.builder.property("child", child.clone().upcast()),
        }
    }

    pub fn resize_mode(self, resize_mode: ResizeMode) -> Self {
        Self {
            builder: self.builder.property("resize-mode", resize_mode),
        }
    }

    pub fn app_paintable(self, app_paintable: bool) -> Self {
        Self {
            builder: self.builder.property("app-paintable", app_paintable),
        }
    }

    pub fn can_default(self, can_default: bool) -> Self {
        Self {
            builder: self.builder.property("can-default", can_default),
        }
    }

    pub fn can_focus(self, can_focus: bool) -> Self {
        Self {
            builder: self.builder.property("can-focus", can_focus),
        }
    }

    pub fn events(self, events: gdk::EventMask) -> Self {
        Self {
            builder: self.builder.property("events", events),
        }
    }

    /// Whether to expand in both directions. Setting this sets both [`hexpand`][struct@crate::Widget#hexpand] and [`vexpand`][struct@crate::Widget#vexpand]
    pub fn expand(self, expand: bool) -> Self {
        Self {
            builder: self.builder.property("expand", expand),
        }
    }

    /// Whether the widget should grab focus when it is clicked with the mouse.
    ///
    /// This property is only relevant for widgets that can take focus.
    ///
    /// Before 3.20, several widgets (GtkButton, GtkFileChooserButton,
    /// GtkComboBox) implemented this property individually.
    pub fn focus_on_click(self, focus_on_click: bool) -> Self {
        Self {
            builder: self.builder.property("focus-on-click", focus_on_click),
        }
    }

    /// How to distribute horizontal space if widget gets extra space, see [`Align`][crate::Align]
    pub fn halign(self, halign: Align) -> Self {
        Self {
            builder: self.builder.property("halign", halign),
        }
    }

    pub fn has_default(self, has_default: bool) -> Self {
        Self {
            builder: self.builder.property("has-default", has_default),
        }
    }

    pub fn has_focus(self, has_focus: bool) -> Self {
        Self {
            builder: self.builder.property("has-focus", has_focus),
        }
    }

    /// Enables or disables the emission of [`query-tooltip`][struct@crate::Widget#query-tooltip] on `widget`.
    /// A value of [`true`] indicates that `widget` can have a tooltip, in this case
    /// the widget will be queried using [`query-tooltip`][struct@crate::Widget#query-tooltip] to determine
    /// whether it will provide a tooltip or not.
    ///
    /// Note that setting this property to [`true`] for the first time will change
    /// the event masks of the GdkWindows of this widget to include leave-notify
    /// and motion-notify events. This cannot and will not be undone when the
    /// property is set to [`false`] again.
    pub fn has_tooltip(self, has_tooltip: bool) -> Self {
        Self {
            builder: self.builder.property("has-tooltip", has_tooltip),
        }
    }

    pub fn height_request(self, height_request: i32) -> Self {
        Self {
            builder: self.builder.property("height-request", height_request),
        }
    }

    /// Whether to expand horizontally. See [`WidgetExt::set_hexpand()`][crate::prelude::WidgetExt::set_hexpand()].
    pub fn hexpand(self, hexpand: bool) -> Self {
        Self {
            builder: self.builder.property("hexpand", hexpand),
        }
    }

    /// Whether to use the [`hexpand`][struct@crate::Widget#hexpand] property. See [`WidgetExt::is_hexpand_set()`][crate::prelude::WidgetExt::is_hexpand_set()].
    pub fn hexpand_set(self, hexpand_set: bool) -> Self {
        Self {
            builder: self.builder.property("hexpand-set", hexpand_set),
        }
    }

    pub fn is_focus(self, is_focus: bool) -> Self {
        Self {
            builder: self.builder.property("is-focus", is_focus),
        }
    }

    /// Sets all four sides' margin at once. If read, returns max
    /// margin on any side.
    pub fn margin(self, margin: i32) -> Self {
        Self {
            builder: self.builder.property("margin", margin),
        }
    }

    /// 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
    /// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
    pub fn margin_bottom(self, margin_bottom: i32) -> Self {
        Self {
            builder: self.builder.property("margin-bottom", margin_bottom),
        }
    }

    /// 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
    /// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
    pub fn margin_end(self, margin_end: i32) -> Self {
        Self {
            builder: self.builder.property("margin-end", margin_end),
        }
    }

    /// 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
    /// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
    pub fn margin_start(self, margin_start: i32) -> Self {
        Self {
            builder: self.builder.property("margin-start", margin_start),
        }
    }

    /// 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
    /// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
    pub fn margin_top(self, margin_top: i32) -> Self {
        Self {
            builder: self.builder.property("margin-top", margin_top),
        }
    }

    pub fn name(self, name: impl Into<glib::GString>) -> Self {
        Self {
            builder: self.builder.property("name", name.into()),
        }
    }

    pub fn no_show_all(self, no_show_all: bool) -> Self {
        Self {
            builder: self.builder.property("no-show-all", no_show_all),
        }
    }

    /// The requested opacity of the widget. See [`WidgetExt::set_opacity()`][crate::prelude::WidgetExt::set_opacity()] for
    /// more details about window opacity.
    ///
    /// Before 3.8 this was only available in GtkWindow
    pub fn opacity(self, opacity: f64) -> Self {
        Self {
            builder: self.builder.property("opacity", opacity),
        }
    }

    pub fn parent(self, parent: &impl IsA<Container>) -> Self {
        Self {
            builder: self.builder.property("parent", parent.clone().upcast()),
        }
    }

    pub fn receives_default(self, receives_default: bool) -> Self {
        Self {
            builder: self.builder.property("receives-default", receives_default),
        }
    }

    pub fn sensitive(self, sensitive: bool) -> Self {
        Self {
            builder: self.builder.property("sensitive", sensitive),
        }
    }

    /// Sets the text of tooltip to be the given string, which is marked up
    /// with the [Pango text markup language][PangoMarkupFormat].
    /// Also see [`Tooltip::set_markup()`][crate::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`][struct@crate::Widget#has-tooltip]
    /// will automatically be set to [`true`] and there will be taken care of
    /// [`query-tooltip`][struct@crate::Widget#query-tooltip] in the default signal handler.
    ///
    /// Note that if both [`tooltip-text`][struct@crate::Widget#tooltip-text] and [`tooltip-markup`][struct@crate::Widget#tooltip-markup]
    /// are set, the last one wins.
    pub fn tooltip_markup(self, tooltip_markup: impl Into<glib::GString>) -> Self {
        Self {
            builder: self
                .builder
                .property("tooltip-markup", tooltip_markup.into()),
        }
    }

    /// Sets the text of tooltip to be the given string.
    ///
    /// Also see [`Tooltip::set_text()`][crate::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`][struct@crate::Widget#has-tooltip]
    /// will automatically be set to [`true`] and there will be taken care of
    /// [`query-tooltip`][struct@crate::Widget#query-tooltip] in the default signal handler.
    ///
    /// Note that if both [`tooltip-text`][struct@crate::Widget#tooltip-text] and [`tooltip-markup`][struct@crate::Widget#tooltip-markup]
    /// are set, the last one wins.
    pub fn tooltip_text(self, tooltip_text: impl Into<glib::GString>) -> Self {
        Self {
            builder: self.builder.property("tooltip-text", tooltip_text.into()),
        }
    }

    /// How to distribute vertical space if widget gets extra space, see [`Align`][crate::Align]
    pub fn valign(self, valign: Align) -> Self {
        Self {
            builder: self.builder.property("valign", valign),
        }
    }

    /// Whether to expand vertically. See [`WidgetExt::set_vexpand()`][crate::prelude::WidgetExt::set_vexpand()].
    pub fn vexpand(self, vexpand: bool) -> Self {
        Self {
            builder: self.builder.property("vexpand", vexpand),
        }
    }

    /// Whether to use the [`vexpand`][struct@crate::Widget#vexpand] property. See [`WidgetExt::is_vexpand_set()`][crate::prelude::WidgetExt::is_vexpand_set()].
    pub fn vexpand_set(self, vexpand_set: bool) -> Self {
        Self {
            builder: self.builder.property("vexpand-set", vexpand_set),
        }
    }

    pub fn visible(self, visible: bool) -> Self {
        Self {
            builder: self.builder.property("visible", visible),
        }
    }

    pub fn width_request(self, width_request: i32) -> Self {
        Self {
            builder: self.builder.property("width-request", width_request),
        }
    }

    /// The orientation of the orientable.
    pub fn orientation(self, orientation: Orientation) -> Self {
        Self {
            builder: self.builder.property("orientation", orientation),
        }
    }

    // rustdoc-stripper-ignore-next
    /// Build the [`Box`].
    #[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
    pub fn build(self) -> Box {
        self.builder.build()
    }
}

mod sealed {
    pub trait Sealed {}
    impl<T: super::IsA<super::Box>> Sealed for T {}
}

/// Trait containing all [`struct@Box`] methods.
///
/// # Implementors
///
/// [`AppChooserWidget`][struct@crate::AppChooserWidget], [`Box`][struct@crate::Box], [`ButtonBox`][struct@crate::ButtonBox], [`ColorChooserWidget`][struct@crate::ColorChooserWidget], [`FileChooserButton`][struct@crate::FileChooserButton], [`FileChooserWidget`][struct@crate::FileChooserWidget], [`FontChooserWidget`][struct@crate::FontChooserWidget], [`InfoBar`][struct@crate::InfoBar], [`RecentChooserWidget`][struct@crate::RecentChooserWidget], [`ShortcutLabel`][struct@crate::ShortcutLabel], [`ShortcutsGroup`][struct@crate::ShortcutsGroup], [`ShortcutsSection`][struct@crate::ShortcutsSection], [`ShortcutsShortcut`][struct@crate::ShortcutsShortcut], [`StackSwitcher`][struct@crate::StackSwitcher], [`Statusbar`][struct@crate::Statusbar]
pub trait BoxExt: IsA<Box> + sealed::Sealed + 'static {
    /// Gets the value set by [`set_baseline_position()`][Self::set_baseline_position()].
    ///
    /// # Returns
    ///
    /// the baseline position
    #[doc(alias = "gtk_box_get_baseline_position")]
    #[doc(alias = "get_baseline_position")]
    fn baseline_position(&self) -> BaselinePosition {
        unsafe {
            from_glib(ffi::gtk_box_get_baseline_position(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Retrieves the center widget of the box.
    ///
    /// # Returns
    ///
    /// the center widget
    ///  or [`None`] in case no center widget is set.
    #[doc(alias = "gtk_box_get_center_widget")]
    #[doc(alias = "get_center_widget")]
    fn center_widget(&self) -> Option<Widget> {
        unsafe {
            from_glib_none(ffi::gtk_box_get_center_widget(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Returns whether the box is homogeneous (all children are the
    /// same size). See [`set_homogeneous()`][Self::set_homogeneous()].
    ///
    /// # Returns
    ///
    /// [`true`] if the box is homogeneous.
    #[doc(alias = "gtk_box_get_homogeneous")]
    #[doc(alias = "get_homogeneous")]
    fn is_homogeneous(&self) -> bool {
        unsafe { from_glib(ffi::gtk_box_get_homogeneous(self.as_ref().to_glib_none().0)) }
    }

    /// Gets the value set by [`set_spacing()`][Self::set_spacing()].
    ///
    /// # Returns
    ///
    /// spacing between children
    #[doc(alias = "gtk_box_get_spacing")]
    #[doc(alias = "get_spacing")]
    fn spacing(&self) -> i32 {
        unsafe { ffi::gtk_box_get_spacing(self.as_ref().to_glib_none().0) }
    }

    /// Adds `child` to `self`, packed with reference to the end of `self`.
    /// The `child` is packed after (away from end of) any other child
    /// packed with reference to the end of `self`.
    /// ## `child`
    /// the [`Widget`][crate::Widget] to be added to `self`
    /// ## `expand`
    /// [`true`] if the new child is to be given extra space allocated
    ///  to `self`. The extra space will be divided evenly between all children
    ///  of `self` that use this option
    /// ## `fill`
    /// [`true`] if space given to `child` by the `expand` option is
    ///  actually allocated to `child`, rather than just padding it. This
    ///  parameter has no effect if `expand` is set to [`false`]. A child is
    ///  always allocated the full height of a horizontal [`Box`][crate::Box] and the full width
    ///  of a vertical [`Box`][crate::Box]. This option affects the other dimension
    /// ## `padding`
    /// extra space in pixels to put between this child and its
    ///  neighbors, over and above the global amount specified by
    ///  [`spacing`][struct@crate::Box#spacing] property. If `child` is a widget at one of the
    ///  reference ends of `self`, then `padding` pixels are also put between
    ///  `child` and the reference edge of `self`
    #[doc(alias = "gtk_box_pack_end")]
    fn pack_end(&self, child: &impl IsA<Widget>, expand: bool, fill: bool, padding: u32) {
        unsafe {
            ffi::gtk_box_pack_end(
                self.as_ref().to_glib_none().0,
                child.as_ref().to_glib_none().0,
                expand.into_glib(),
                fill.into_glib(),
                padding,
            );
        }
    }

    /// Adds `child` to `self`, packed with reference to the start of `self`.
    /// The `child` is packed after any other child packed with reference
    /// to the start of `self`.
    /// ## `child`
    /// the [`Widget`][crate::Widget] to be added to `self`
    /// ## `expand`
    /// [`true`] if the new child is to be given extra space allocated
    ///  to `self`. The extra space will be divided evenly between all children
    ///  that use this option
    /// ## `fill`
    /// [`true`] if space given to `child` by the `expand` option is
    ///  actually allocated to `child`, rather than just padding it. This
    ///  parameter has no effect if `expand` is set to [`false`]. A child is
    ///  always allocated the full height of a horizontal [`Box`][crate::Box] and the full width
    ///  of a vertical [`Box`][crate::Box]. This option affects the other dimension
    /// ## `padding`
    /// extra space in pixels to put between this child and its
    ///  neighbors, over and above the global amount specified by
    ///  [`spacing`][struct@crate::Box#spacing] property. If `child` is a widget at one of the
    ///  reference ends of `self`, then `padding` pixels are also put between
    ///  `child` and the reference edge of `self`
    #[doc(alias = "gtk_box_pack_start")]
    fn pack_start(&self, child: &impl IsA<Widget>, expand: bool, fill: bool, padding: u32) {
        unsafe {
            ffi::gtk_box_pack_start(
                self.as_ref().to_glib_none().0,
                child.as_ref().to_glib_none().0,
                expand.into_glib(),
                fill.into_glib(),
                padding,
            );
        }
    }

    /// Obtains information about how `child` is packed into `self`.
    /// ## `child`
    /// the [`Widget`][crate::Widget] of the child to query
    ///
    /// # Returns
    ///
    ///
    /// ## `expand`
    /// pointer to return location for expand child
    ///  property
    ///
    /// ## `fill`
    /// pointer to return location for fill child
    ///  property
    ///
    /// ## `padding`
    /// pointer to return location for padding
    ///  child property
    ///
    /// ## `pack_type`
    /// pointer to return location for pack-type
    ///  child property
    #[doc(alias = "gtk_box_query_child_packing")]
    fn query_child_packing(&self, child: &impl IsA<Widget>) -> (bool, bool, u32, PackType) {
        unsafe {
            let mut expand = mem::MaybeUninit::uninit();
            let mut fill = mem::MaybeUninit::uninit();
            let mut padding = mem::MaybeUninit::uninit();
            let mut pack_type = mem::MaybeUninit::uninit();
            ffi::gtk_box_query_child_packing(
                self.as_ref().to_glib_none().0,
                child.as_ref().to_glib_none().0,
                expand.as_mut_ptr(),
                fill.as_mut_ptr(),
                padding.as_mut_ptr(),
                pack_type.as_mut_ptr(),
            );
            (
                from_glib(expand.assume_init()),
                from_glib(fill.assume_init()),
                padding.assume_init(),
                from_glib(pack_type.assume_init()),
            )
        }
    }

    /// Moves `child` to a new `position` in the list of `self` children.
    /// The list contains widgets packed [`PackType::Start`][crate::PackType::Start]
    /// as well as widgets packed [`PackType::End`][crate::PackType::End], in the order that these
    /// widgets were added to `self`.
    ///
    /// A widget’s position in the `self` children list determines where
    /// the widget is packed into `self`. A child widget at some position
    /// in the list will be packed just after all other widgets of the
    /// same packing type that appear earlier in the list.
    /// ## `child`
    /// the [`Widget`][crate::Widget] to move
    /// ## `position`
    /// the new position for `child` in the list of children
    ///  of `self`, starting from 0. If negative, indicates the end of
    ///  the list
    #[doc(alias = "gtk_box_reorder_child")]
    fn reorder_child(&self, child: &impl IsA<Widget>, position: i32) {
        unsafe {
            ffi::gtk_box_reorder_child(
                self.as_ref().to_glib_none().0,
                child.as_ref().to_glib_none().0,
                position,
            );
        }
    }

    /// Sets the baseline position of a box. This 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
    /// `position` is used to allocate the baseline wrt the
    /// extra space available.
    /// ## `position`
    /// a [`BaselinePosition`][crate::BaselinePosition]
    #[doc(alias = "gtk_box_set_baseline_position")]
    fn set_baseline_position(&self, position: BaselinePosition) {
        unsafe {
            ffi::gtk_box_set_baseline_position(
                self.as_ref().to_glib_none().0,
                position.into_glib(),
            );
        }
    }

    /// Sets a center widget; that is a child widget that will be
    /// centered with respect to the full width of the box, even
    /// if the children at either side take up different amounts
    /// of space.
    /// ## `widget`
    /// the widget to center
    #[doc(alias = "gtk_box_set_center_widget")]
    fn set_center_widget(&self, widget: Option<&impl IsA<Widget>>) {
        unsafe {
            ffi::gtk_box_set_center_widget(
                self.as_ref().to_glib_none().0,
                widget.map(|p| p.as_ref()).to_glib_none().0,
            );
        }
    }

    /// Sets the way `child` is packed into `self`.
    /// ## `child`
    /// the [`Widget`][crate::Widget] of the child to set
    /// ## `expand`
    /// the new value of the expand child property
    /// ## `fill`
    /// the new value of the fill child property
    /// ## `padding`
    /// the new value of the padding child property
    /// ## `pack_type`
    /// the new value of the pack-type child property
    #[doc(alias = "gtk_box_set_child_packing")]
    fn set_child_packing(
        &self,
        child: &impl IsA<Widget>,
        expand: bool,
        fill: bool,
        padding: u32,
        pack_type: PackType,
    ) {
        unsafe {
            ffi::gtk_box_set_child_packing(
                self.as_ref().to_glib_none().0,
                child.as_ref().to_glib_none().0,
                expand.into_glib(),
                fill.into_glib(),
                padding,
                pack_type.into_glib(),
            );
        }
    }

    /// Sets the [`homogeneous`][struct@crate::Box#homogeneous] property of `self`, controlling
    /// whether or not all children of `self` are given equal space
    /// in the box.
    /// ## `homogeneous`
    /// a boolean value, [`true`] to create equal allotments,
    ///  [`false`] for variable allotments
    #[doc(alias = "gtk_box_set_homogeneous")]
    fn set_homogeneous(&self, homogeneous: bool) {
        unsafe {
            ffi::gtk_box_set_homogeneous(self.as_ref().to_glib_none().0, homogeneous.into_glib());
        }
    }

    /// Sets the [`spacing`][struct@crate::Box#spacing] property of `self`, which is the
    /// number of pixels to place between children of `self`.
    /// ## `spacing`
    /// the number of pixels to put between children
    #[doc(alias = "gtk_box_set_spacing")]
    fn set_spacing(&self, spacing: i32) {
        unsafe {
            ffi::gtk_box_set_spacing(self.as_ref().to_glib_none().0, spacing);
        }
    }

    fn child_expands<T: IsA<crate::Widget>>(&self, item: &T) -> bool {
        crate::prelude::ContainerExtManual::child_property(
            self.as_ref(),
            &item.clone().upcast(),
            "expand",
        )
    }

    fn set_child_expand<T: IsA<crate::Widget>>(&self, item: &T, expand: bool) {
        crate::prelude::ContainerExtManual::child_set_property(
            self.as_ref(),
            &item.clone().upcast(),
            "expand",
            &expand,
        )
    }

    fn child_fills<T: IsA<crate::Widget>>(&self, item: &T) -> bool {
        crate::prelude::ContainerExtManual::child_property(
            self.as_ref(),
            &item.clone().upcast(),
            "fill",
        )
    }

    fn set_child_fill<T: IsA<crate::Widget>>(&self, item: &T, fill: bool) {
        crate::prelude::ContainerExtManual::child_set_property(
            self.as_ref(),
            &item.clone().upcast(),
            "fill",
            &fill,
        )
    }

    #[doc(alias = "child.pack-type")]
    fn child_pack_type<T: IsA<crate::Widget>>(&self, item: &T) -> PackType {
        crate::prelude::ContainerExtManual::child_property(
            self.as_ref(),
            &item.clone().upcast(),
            "pack-type",
        )
    }

    #[doc(alias = "child.pack-type")]
    fn set_child_pack_type<T: IsA<crate::Widget>>(&self, item: &T, pack_type: PackType) {
        crate::prelude::ContainerExtManual::child_set_property(
            self.as_ref(),
            &item.clone().upcast(),
            "pack-type",
            &pack_type,
        )
    }

    fn child_padding<T: IsA<crate::Widget>>(&self, item: &T) -> u32 {
        crate::prelude::ContainerExtManual::child_property(
            self.as_ref(),
            &item.clone().upcast(),
            "padding",
        )
    }

    fn set_child_padding<T: IsA<crate::Widget>>(&self, item: &T, padding: u32) {
        crate::prelude::ContainerExtManual::child_set_property(
            self.as_ref(),
            &item.clone().upcast(),
            "padding",
            &padding,
        )
    }

    fn child_position<T: IsA<crate::Widget>>(&self, item: &T) -> i32 {
        crate::prelude::ContainerExtManual::child_property(
            self.as_ref(),
            &item.clone().upcast(),
            "position",
        )
    }

    fn set_child_position<T: IsA<crate::Widget>>(&self, item: &T, position: i32) {
        crate::prelude::ContainerExtManual::child_set_property(
            self.as_ref(),
            &item.clone().upcast(),
            "position",
            &position,
        )
    }

    #[doc(alias = "baseline-position")]
    fn connect_baseline_position_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_baseline_position_trampoline<
            P: IsA<Box>,
            F: Fn(&P) + 'static,
        >(
            this: *mut ffi::GtkBox,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(Box::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::baseline-position\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_baseline_position_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "homogeneous")]
    fn connect_homogeneous_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_homogeneous_trampoline<P: IsA<Box>, F: Fn(&P) + 'static>(
            this: *mut ffi::GtkBox,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(Box::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::homogeneous\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_homogeneous_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "spacing")]
    fn connect_spacing_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_spacing_trampoline<P: IsA<Box>, F: Fn(&P) + 'static>(
            this: *mut ffi::GtkBox,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(Box::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::spacing\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_spacing_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

impl<O: IsA<Box>> BoxExt for O {}

impl fmt::Display for Box {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        f.write_str("Box")
    }
}