gtk4/auto/

box_layout.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::{ffi, BaselinePosition, LayoutManager, Orientable, Orientation};
use glib::{
    prelude::*,
    signal::{connect_raw, SignalHandlerId},
    translate::*,
};
use std::boxed::Box as Box_;

glib::wrapper! {
    /// Arranges children in a single row or column.
    ///
    /// Whether it is a row or column depends on the value of its
    /// [`orientation`][struct@crate::Orientable#orientation] property. Within the other dimension
    /// all children all allocated the same size. The [`BoxLayout`][crate::BoxLayout] will respect
    /// the [`halign`][struct@crate::Widget#halign] and [`valign`][struct@crate::Widget#valign]
    /// properties of each child widget.
    ///
    /// If you want all children to be assigned the same size, you can use
    /// the [`homogeneous`][struct@crate::BoxLayout#homogeneous] property.
    ///
    /// If you want to specify the amount of space placed between each child,
    /// you can use the [`spacing`][struct@crate::BoxLayout#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
    /// <details><summary><h4>Orientable</h4></summary>
    ///
    ///
    /// #### `orientation`
    ///  The orientation of the orientable.
    ///
    /// Readable | Writeable
    /// </details>
    ///
    /// # Implements
    ///
    /// [`LayoutManagerExt`][trait@crate::prelude::LayoutManagerExt], [`trait@glib::ObjectExt`], [`OrientableExt`][trait@crate::prelude::OrientableExt]
    #[doc(alias = "GtkBoxLayout")]
    pub struct BoxLayout(Object<ffi::GtkBoxLayout, ffi::GtkBoxLayoutClass>) @extends LayoutManager, @implements Orientable;

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

impl BoxLayout {
    /// Creates a new [`BoxLayout`][crate::BoxLayout].
    /// ## `orientation`
    /// the orientation for the new layout
    ///
    /// # Returns
    ///
    /// a new box layout
    #[doc(alias = "gtk_box_layout_new")]
    pub fn new(orientation: Orientation) -> BoxLayout {
        assert_initialized_main_thread!();
        unsafe {
            LayoutManager::from_glib_full(ffi::gtk_box_layout_new(orientation.into_glib()))
                .unsafe_cast()
        }
    }

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

    /// 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
    #[cfg(feature = "v4_12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v4_12")))]
    #[doc(alias = "gtk_box_layout_get_baseline_child")]
    #[doc(alias = "get_baseline_child")]
    #[doc(alias = "baseline-child")]
    pub fn baseline_child(&self) -> i32 {
        unsafe { ffi::gtk_box_layout_get_baseline_child(self.to_glib_none().0) }
    }

    /// Gets the value set by gtk_box_layout_set_baseline_position().
    ///
    /// # Returns
    ///
    /// the baseline position
    #[doc(alias = "gtk_box_layout_get_baseline_position")]
    #[doc(alias = "get_baseline_position")]
    #[doc(alias = "baseline-position")]
    pub fn baseline_position(&self) -> BaselinePosition {
        unsafe {
            from_glib(ffi::gtk_box_layout_get_baseline_position(
                self.to_glib_none().0,
            ))
        }
    }

    /// Returns whether the layout is set to be homogeneous.
    ///
    /// # Returns
    ///
    /// [`true`] if the layout is homogeneous
    #[doc(alias = "gtk_box_layout_get_homogeneous")]
    #[doc(alias = "get_homogeneous")]
    #[doc(alias = "homogeneous")]
    pub fn is_homogeneous(&self) -> bool {
        unsafe { from_glib(ffi::gtk_box_layout_get_homogeneous(self.to_glib_none().0)) }
    }

    /// Returns the space that @self puts between children.
    ///
    /// # Returns
    ///
    /// the spacing of the layout
    #[doc(alias = "gtk_box_layout_get_spacing")]
    #[doc(alias = "get_spacing")]
    pub fn spacing(&self) -> u32 {
        unsafe { ffi::gtk_box_layout_get_spacing(self.to_glib_none().0) }
    }

    /// Sets the index of the child that determines the baseline
    /// in vertical layout.
    /// ## `child`
    /// the child position, or -1
    #[cfg(feature = "v4_12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v4_12")))]
    #[doc(alias = "gtk_box_layout_set_baseline_child")]
    #[doc(alias = "baseline-child")]
    pub fn set_baseline_child(&self, child: i32) {
        unsafe {
            ffi::gtk_box_layout_set_baseline_child(self.to_glib_none().0, child);
        }
    }

    /// 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`][crate::BaselinePosition]
    #[doc(alias = "gtk_box_layout_set_baseline_position")]
    #[doc(alias = "baseline-position")]
    pub fn set_baseline_position(&self, position: BaselinePosition) {
        unsafe {
            ffi::gtk_box_layout_set_baseline_position(self.to_glib_none().0, position.into_glib());
        }
    }

    /// Sets whether the box layout will allocate the same
    /// size to all children.
    /// ## `homogeneous`
    /// [`true`] to set the box layout as homogeneous
    #[doc(alias = "gtk_box_layout_set_homogeneous")]
    #[doc(alias = "homogeneous")]
    pub fn set_homogeneous(&self, homogeneous: bool) {
        unsafe {
            ffi::gtk_box_layout_set_homogeneous(self.to_glib_none().0, homogeneous.into_glib());
        }
    }

    /// Sets how much spacing to put between children.
    /// ## `spacing`
    /// the spacing to apply between children
    #[doc(alias = "gtk_box_layout_set_spacing")]
    #[doc(alias = "spacing")]
    pub fn set_spacing(&self, spacing: u32) {
        unsafe {
            ffi::gtk_box_layout_set_spacing(self.to_glib_none().0, spacing);
        }
    }

    #[cfg(feature = "v4_12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v4_12")))]
    #[doc(alias = "baseline-child")]
    pub fn connect_baseline_child_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_baseline_child_trampoline<F: Fn(&BoxLayout) + 'static>(
            this: *mut ffi::GtkBoxLayout,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this))
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::baseline-child".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_baseline_child_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

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

    #[doc(alias = "homogeneous")]
    pub fn connect_homogeneous_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_homogeneous_trampoline<F: Fn(&BoxLayout) + 'static>(
            this: *mut ffi::GtkBoxLayout,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this))
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::homogeneous".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_homogeneous_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "spacing")]
    pub fn connect_spacing_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_spacing_trampoline<F: Fn(&BoxLayout) + 'static>(
            this: *mut ffi::GtkBoxLayout,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this))
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::spacing".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_spacing_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

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

// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`BoxLayout`] 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 BoxLayoutBuilder {
    builder: glib::object::ObjectBuilder<'static, BoxLayout>,
}

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

    /// 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.
    #[cfg(feature = "v4_12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v4_12")))]
    pub fn baseline_child(self, baseline_child: i32) -> Self {
        Self {
            builder: self.builder.property("baseline-child", baseline_child),
        }
    }

    /// 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.
    pub fn baseline_position(self, baseline_position: BaselinePosition) -> Self {
        Self {
            builder: self
                .builder
                .property("baseline-position", baseline_position),
        }
    }

    /// Whether the box layout should distribute the available space
    /// equally among the children.
    pub fn homogeneous(self, homogeneous: bool) -> Self {
        Self {
            builder: self.builder.property("homogeneous", homogeneous),
        }
    }

    /// The space to put between the children.
    pub fn spacing(self, spacing: i32) -> Self {
        Self {
            builder: self.builder.property("spacing", spacing),
        }
    }

    /// 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 [`BoxLayout`].
    #[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
    pub fn build(self) -> BoxLayout {
        assert_initialized_main_thread!();
        self.builder.build()
    }
}