libadwaita/auto/

clamp_layout.rs

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

use crate::ffi;
#[cfg(feature = "v1_4")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_4")))]
use crate::LengthUnit;
use glib::{
    prelude::*,
    signal::{connect_raw, SignalHandlerId},
    translate::*,
};
use std::boxed::Box as Box_;

glib::wrapper! {
    /// A layout manager constraining its children to a given size.
    ///
    /// <picture>
    ///   <source srcset="clamp-wide-dark.png" media="(prefers-color-scheme: dark)">
    ///   <img src="clamp-wide.png" alt="clamp-wide">
    /// </picture>
    /// <picture>
    ///   <source srcset="clamp-narrow-dark.png" media="(prefers-color-scheme: dark)">
    ///   <img src="clamp-narrow.png" alt="clamp-narrow">
    /// </picture>
    ///
    /// [`ClampLayout`][crate::ClampLayout] constraints the size of the widgets it contains to a given
    /// maximum size. It will constrain the width if it is horizontal, or the height
    /// if it is vertical. The expansion of the children from their minimum to their
    /// maximum size is eased out for a smooth transition.
    ///
    /// If a child requires more than the requested maximum size, it will be
    /// allocated the minimum size it can fit in instead.
    ///
    /// [`ClampLayout`][crate::ClampLayout] can scale with the text scale factor, use the
    /// [`unit`][struct@crate::ClampLayout#unit] property to enable that behavior.
    ///
    /// See also: [`Clamp`][crate::Clamp], [`ClampScrollable`][crate::ClampScrollable].
    ///
    /// ## Properties
    ///
    ///
    /// #### `maximum-size`
    ///  The maximum size to allocate to the children.
    ///
    /// It is the width if the layout is horizontal, or the height if it is
    /// vertical.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `tightening-threshold`
    ///  The size above which the children are clamped.
    ///
    /// Starting from this size, the layout will tighten its grip on the children,
    /// slowly allocating less and less of the available size up to the maximum
    /// allocated size. Below that threshold and below the maximum size, the
    /// children will be allocated all the available size.
    ///
    /// If the threshold is greater than the maximum size to allocate to the
    /// children, they will be allocated the whole size up to the maximum. If the
    /// threshold is lower than the minimum size to allocate to the children, that
    /// size will be used as the tightening threshold.
    ///
    /// Effectively, tightening the grip on a child before it reaches its maximum
    /// size makes transitions to and from the maximum size smoother when resizing.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `unit`
    ///  The length unit for maximum size and tightening threshold.
    ///
    /// Allows the sizes to vary depending on the text scale factor.
    ///
    /// Readable | Writeable
    /// <details><summary><h4>Orientable</h4></summary>
    ///
    ///
    /// #### `orientation`
    ///  The orientation of the orientable.
    ///
    /// Readable | Writeable
    /// </details>
    ///
    /// # Implements
    ///
    /// [`trait@gtk::prelude::LayoutManagerExt`], [`trait@glib::ObjectExt`], [`trait@gtk::prelude::OrientableExt`]
    #[doc(alias = "AdwClampLayout")]
    pub struct ClampLayout(Object<ffi::AdwClampLayout, ffi::AdwClampLayoutClass>) @extends gtk::LayoutManager, @implements gtk::Orientable;

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

impl ClampLayout {
    /// Creates a new [`ClampLayout`][crate::ClampLayout].
    ///
    /// # Returns
    ///
    /// the newly created [`ClampLayout`][crate::ClampLayout]
    #[doc(alias = "adw_clamp_layout_new")]
    pub fn new() -> ClampLayout {
        assert_initialized_main_thread!();
        unsafe { gtk::LayoutManager::from_glib_full(ffi::adw_clamp_layout_new()).unsafe_cast() }
    }

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

    /// Gets the maximum size allocated to the children.
    ///
    /// # Returns
    ///
    /// the maximum size to allocate to the children
    #[doc(alias = "adw_clamp_layout_get_maximum_size")]
    #[doc(alias = "get_maximum_size")]
    #[doc(alias = "maximum-size")]
    pub fn maximum_size(&self) -> i32 {
        unsafe { ffi::adw_clamp_layout_get_maximum_size(self.to_glib_none().0) }
    }

    /// Gets the size above which the children are clamped.
    ///
    /// # Returns
    ///
    /// the size above which the children are clamped
    #[doc(alias = "adw_clamp_layout_get_tightening_threshold")]
    #[doc(alias = "get_tightening_threshold")]
    #[doc(alias = "tightening-threshold")]
    pub fn tightening_threshold(&self) -> i32 {
        unsafe { ffi::adw_clamp_layout_get_tightening_threshold(self.to_glib_none().0) }
    }

    /// Gets the length unit for maximum size and tightening threshold.
    ///
    /// # Returns
    ///
    /// the length unit
    #[cfg(feature = "v1_4")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_4")))]
    #[doc(alias = "adw_clamp_layout_get_unit")]
    #[doc(alias = "get_unit")]
    pub fn unit(&self) -> LengthUnit {
        unsafe { from_glib(ffi::adw_clamp_layout_get_unit(self.to_glib_none().0)) }
    }

    /// Sets the maximum size allocated to the children.
    ///
    /// It is the width if the layout is horizontal, or the height if it is vertical.
    /// ## `maximum_size`
    /// the maximum size
    #[doc(alias = "adw_clamp_layout_set_maximum_size")]
    #[doc(alias = "maximum-size")]
    pub fn set_maximum_size(&self, maximum_size: i32) {
        unsafe {
            ffi::adw_clamp_layout_set_maximum_size(self.to_glib_none().0, maximum_size);
        }
    }

    /// Sets the size above which the children are clamped.
    ///
    /// Starting from this size, the layout will tighten its grip on the children,
    /// slowly allocating less and less of the available size up to the maximum
    /// allocated size. Below that threshold and below the maximum size, the children
    /// will be allocated all the available size.
    ///
    /// If the threshold is greater than the maximum size to allocate to the
    /// children, they will be allocated the whole size up to the maximum. If the
    /// threshold is lower than the minimum size to allocate to the children, that
    /// size will be used as the tightening threshold.
    ///
    /// Effectively, tightening the grip on a child before it reaches its maximum
    /// size makes transitions to and from the maximum size smoother when resizing.
    /// ## `tightening_threshold`
    /// the tightening threshold
    #[doc(alias = "adw_clamp_layout_set_tightening_threshold")]
    #[doc(alias = "tightening-threshold")]
    pub fn set_tightening_threshold(&self, tightening_threshold: i32) {
        unsafe {
            ffi::adw_clamp_layout_set_tightening_threshold(
                self.to_glib_none().0,
                tightening_threshold,
            );
        }
    }

    /// Sets the length unit for maximum size and tightening threshold.
    ///
    /// Allows the sizes to vary depending on the text scale factor.
    /// ## `unit`
    /// the length unit
    #[cfg(feature = "v1_4")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_4")))]
    #[doc(alias = "adw_clamp_layout_set_unit")]
    #[doc(alias = "unit")]
    pub fn set_unit(&self, unit: LengthUnit) {
        unsafe {
            ffi::adw_clamp_layout_set_unit(self.to_glib_none().0, unit.into_glib());
        }
    }

    #[doc(alias = "maximum-size")]
    pub fn connect_maximum_size_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_maximum_size_trampoline<F: Fn(&ClampLayout) + 'static>(
            this: *mut ffi::AdwClampLayout,
            _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::maximum-size".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_maximum_size_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "tightening-threshold")]
    pub fn connect_tightening_threshold_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn notify_tightening_threshold_trampoline<
            F: Fn(&ClampLayout) + 'static,
        >(
            this: *mut ffi::AdwClampLayout,
            _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::tightening-threshold".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_tightening_threshold_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[cfg(feature = "v1_4")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_4")))]
    #[doc(alias = "unit")]
    pub fn connect_unit_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_unit_trampoline<F: Fn(&ClampLayout) + 'static>(
            this: *mut ffi::AdwClampLayout,
            _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::unit".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_unit_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

impl Default for ClampLayout {
    fn default() -> Self {
        Self::new()
    }
}

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

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

    /// The maximum size to allocate to the children.
    ///
    /// It is the width if the layout is horizontal, or the height if it is
    /// vertical.
    pub fn maximum_size(self, maximum_size: i32) -> Self {
        Self {
            builder: self.builder.property("maximum-size", maximum_size),
        }
    }

    /// The size above which the children are clamped.
    ///
    /// Starting from this size, the layout will tighten its grip on the children,
    /// slowly allocating less and less of the available size up to the maximum
    /// allocated size. Below that threshold and below the maximum size, the
    /// children will be allocated all the available size.
    ///
    /// If the threshold is greater than the maximum size to allocate to the
    /// children, they will be allocated the whole size up to the maximum. If the
    /// threshold is lower than the minimum size to allocate to the children, that
    /// size will be used as the tightening threshold.
    ///
    /// Effectively, tightening the grip on a child before it reaches its maximum
    /// size makes transitions to and from the maximum size smoother when resizing.
    pub fn tightening_threshold(self, tightening_threshold: i32) -> Self {
        Self {
            builder: self
                .builder
                .property("tightening-threshold", tightening_threshold),
        }
    }

    /// The length unit for maximum size and tightening threshold.
    ///
    /// Allows the sizes to vary depending on the text scale factor.
    #[cfg(feature = "v1_4")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_4")))]
    pub fn unit(self, unit: LengthUnit) -> Self {
        Self {
            builder: self.builder.property("unit", unit),
        }
    }

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

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