gtk4/auto/

constraint_guide.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::{ConstraintStrength, ConstraintTarget, ffi};
use glib::{
    prelude::*,
    signal::{SignalHandlerId, connect_raw},
    translate::*,
};
use std::boxed::Box as Box_;

glib::wrapper! {
    /// An invisible layout element in a [`ConstraintLayout`][crate::ConstraintLayout].
    ///
    /// The [`ConstraintLayout`][crate::ConstraintLayout] treats guides like widgets. They
    /// can be used as the source or target of a [`Constraint`][crate::Constraint].
    ///
    /// Guides have a minimum, maximum and natural size. Depending
    /// on the constraints that are applied, they can act like a
    /// guideline that widgets can be aligned to, or like *flexible
    /// space*.
    ///
    /// Unlike a [`Widget`][crate::Widget], a [`ConstraintGuide`][crate::ConstraintGuide] will not be drawn.
    ///
    /// ## Properties
    ///
    ///
    /// #### `max-height`
    ///  The maximum height of the guide.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `max-width`
    ///  The maximum width of the guide.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `min-height`
    ///  The minimum height of the guide.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `min-width`
    ///  The minimum width of the guide.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `name`
    ///  A name that identifies the [`ConstraintGuide`][crate::ConstraintGuide], for debugging.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `nat-height`
    ///  The preferred, or natural, height of the guide.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `nat-width`
    ///  The preferred, or natural, width of the guide.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `strength`
    ///  The [`ConstraintStrength`][crate::ConstraintStrength] to be used for the constraint on
    /// the natural size of the guide.
    ///
    /// Readable | Writeable
    ///
    /// # Implements
    ///
    /// [`trait@glib::ObjectExt`], [`ConstraintTargetExt`][trait@crate::prelude::ConstraintTargetExt]
    #[doc(alias = "GtkConstraintGuide")]
    pub struct ConstraintGuide(Object<ffi::GtkConstraintGuide, ffi::GtkConstraintGuideClass>) @implements ConstraintTarget;

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

impl ConstraintGuide {
    /// Creates a new [`ConstraintGuide`][crate::ConstraintGuide] object.
    ///
    /// # Returns
    ///
    /// a new [`ConstraintGuide`][crate::ConstraintGuide] object.
    #[doc(alias = "gtk_constraint_guide_new")]
    pub fn new() -> ConstraintGuide {
        assert_initialized_main_thread!();
        unsafe { from_glib_full(ffi::gtk_constraint_guide_new()) }
    }

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

    /// Retrieves the name set using gtk_constraint_guide_set_name().
    ///
    /// # Returns
    ///
    /// the name of the guide
    #[doc(alias = "gtk_constraint_guide_get_name")]
    #[doc(alias = "get_name")]
    pub fn name(&self) -> Option<glib::GString> {
        unsafe { from_glib_none(ffi::gtk_constraint_guide_get_name(self.to_glib_none().0)) }
    }

    /// Retrieves the strength set using gtk_constraint_guide_set_strength().
    ///
    /// # Returns
    ///
    /// the strength of the constraint on the natural size
    #[doc(alias = "gtk_constraint_guide_get_strength")]
    #[doc(alias = "get_strength")]
    pub fn strength(&self) -> ConstraintStrength {
        unsafe {
            from_glib(ffi::gtk_constraint_guide_get_strength(
                self.to_glib_none().0,
            ))
        }
    }

    /// Sets the maximum size of @self.
    ///
    /// If @self is attached to a [`ConstraintLayout`][crate::ConstraintLayout],
    /// the constraints will be updated to reflect the new size.
    /// ## `width`
    /// the new maximum width, or -1 to not change it
    /// ## `height`
    /// the new maximum height, or -1 to not change it
    #[doc(alias = "gtk_constraint_guide_set_max_size")]
    pub fn set_max_size(&self, width: i32, height: i32) {
        unsafe {
            ffi::gtk_constraint_guide_set_max_size(self.to_glib_none().0, width, height);
        }
    }

    /// Sets the minimum size of @self.
    ///
    /// If @self is attached to a [`ConstraintLayout`][crate::ConstraintLayout],
    /// the constraints will be updated to reflect the new size.
    /// ## `width`
    /// the new minimum width, or -1 to not change it
    /// ## `height`
    /// the new minimum height, or -1 to not change it
    #[doc(alias = "gtk_constraint_guide_set_min_size")]
    pub fn set_min_size(&self, width: i32, height: i32) {
        unsafe {
            ffi::gtk_constraint_guide_set_min_size(self.to_glib_none().0, width, height);
        }
    }

    /// Sets a name for the given [`ConstraintGuide`][crate::ConstraintGuide].
    ///
    /// The name is useful for debugging purposes.
    /// ## `name`
    /// a name for the @self
    #[doc(alias = "gtk_constraint_guide_set_name")]
    #[doc(alias = "name")]
    pub fn set_name(&self, name: Option<&str>) {
        unsafe {
            ffi::gtk_constraint_guide_set_name(self.to_glib_none().0, name.to_glib_none().0);
        }
    }

    /// Sets the natural size of @self.
    ///
    /// If @self is attached to a [`ConstraintLayout`][crate::ConstraintLayout],
    /// the constraints will be updated to reflect the new size.
    /// ## `width`
    /// the new natural width, or -1 to not change it
    /// ## `height`
    /// the new natural height, or -1 to not change it
    #[doc(alias = "gtk_constraint_guide_set_nat_size")]
    pub fn set_nat_size(&self, width: i32, height: i32) {
        unsafe {
            ffi::gtk_constraint_guide_set_nat_size(self.to_glib_none().0, width, height);
        }
    }

    /// Sets the strength of the constraint on the natural size of the
    /// given [`ConstraintGuide`][crate::ConstraintGuide].
    /// ## `strength`
    /// the strength of the constraint
    #[doc(alias = "gtk_constraint_guide_set_strength")]
    #[doc(alias = "strength")]
    pub fn set_strength(&self, strength: ConstraintStrength) {
        unsafe {
            ffi::gtk_constraint_guide_set_strength(self.to_glib_none().0, strength.into_glib());
        }
    }

    /// The maximum height of the guide.
    #[doc(alias = "max-height")]
    pub fn max_height(&self) -> i32 {
        ObjectExt::property(self, "max-height")
    }

    /// The maximum height of the guide.
    #[doc(alias = "max-height")]
    pub fn set_max_height(&self, max_height: i32) {
        ObjectExt::set_property(self, "max-height", max_height)
    }

    /// The maximum width of the guide.
    #[doc(alias = "max-width")]
    pub fn max_width(&self) -> i32 {
        ObjectExt::property(self, "max-width")
    }

    /// The maximum width of the guide.
    #[doc(alias = "max-width")]
    pub fn set_max_width(&self, max_width: i32) {
        ObjectExt::set_property(self, "max-width", max_width)
    }

    /// The minimum height of the guide.
    #[doc(alias = "min-height")]
    pub fn min_height(&self) -> i32 {
        ObjectExt::property(self, "min-height")
    }

    /// The minimum height of the guide.
    #[doc(alias = "min-height")]
    pub fn set_min_height(&self, min_height: i32) {
        ObjectExt::set_property(self, "min-height", min_height)
    }

    /// The minimum width of the guide.
    #[doc(alias = "min-width")]
    pub fn min_width(&self) -> i32 {
        ObjectExt::property(self, "min-width")
    }

    /// The minimum width of the guide.
    #[doc(alias = "min-width")]
    pub fn set_min_width(&self, min_width: i32) {
        ObjectExt::set_property(self, "min-width", min_width)
    }

    /// The preferred, or natural, height of the guide.
    #[doc(alias = "nat-height")]
    pub fn nat_height(&self) -> i32 {
        ObjectExt::property(self, "nat-height")
    }

    /// The preferred, or natural, height of the guide.
    #[doc(alias = "nat-height")]
    pub fn set_nat_height(&self, nat_height: i32) {
        ObjectExt::set_property(self, "nat-height", nat_height)
    }

    /// The preferred, or natural, width of the guide.
    #[doc(alias = "nat-width")]
    pub fn nat_width(&self) -> i32 {
        ObjectExt::property(self, "nat-width")
    }

    /// The preferred, or natural, width of the guide.
    #[doc(alias = "nat-width")]
    pub fn set_nat_width(&self, nat_width: i32) {
        ObjectExt::set_property(self, "nat-width", nat_width)
    }

    #[doc(alias = "max-height")]
    pub fn connect_max_height_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_max_height_trampoline<F: Fn(&ConstraintGuide) + 'static>(
            this: *mut ffi::GtkConstraintGuide,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                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::max-height".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_max_height_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "max-width")]
    pub fn connect_max_width_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_max_width_trampoline<F: Fn(&ConstraintGuide) + 'static>(
            this: *mut ffi::GtkConstraintGuide,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                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::max-width".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_max_width_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "min-height")]
    pub fn connect_min_height_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_min_height_trampoline<F: Fn(&ConstraintGuide) + 'static>(
            this: *mut ffi::GtkConstraintGuide,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                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::min-height".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_min_height_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "min-width")]
    pub fn connect_min_width_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_min_width_trampoline<F: Fn(&ConstraintGuide) + 'static>(
            this: *mut ffi::GtkConstraintGuide,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                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::min-width".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_min_width_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "name")]
    pub fn connect_name_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_name_trampoline<F: Fn(&ConstraintGuide) + 'static>(
            this: *mut ffi::GtkConstraintGuide,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                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::name".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_name_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "nat-height")]
    pub fn connect_nat_height_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_nat_height_trampoline<F: Fn(&ConstraintGuide) + 'static>(
            this: *mut ffi::GtkConstraintGuide,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                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::nat-height".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_nat_height_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "nat-width")]
    pub fn connect_nat_width_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_nat_width_trampoline<F: Fn(&ConstraintGuide) + 'static>(
            this: *mut ffi::GtkConstraintGuide,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                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::nat-width".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_nat_width_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "strength")]
    pub fn connect_strength_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_strength_trampoline<F: Fn(&ConstraintGuide) + 'static>(
            this: *mut ffi::GtkConstraintGuide,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                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::strength".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_strength_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

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

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

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

    /// The maximum height of the guide.
    pub fn max_height(self, max_height: i32) -> Self {
        Self {
            builder: self.builder.property("max-height", max_height),
        }
    }

    /// The maximum width of the guide.
    pub fn max_width(self, max_width: i32) -> Self {
        Self {
            builder: self.builder.property("max-width", max_width),
        }
    }

    /// The minimum height of the guide.
    pub fn min_height(self, min_height: i32) -> Self {
        Self {
            builder: self.builder.property("min-height", min_height),
        }
    }

    /// The minimum width of the guide.
    pub fn min_width(self, min_width: i32) -> Self {
        Self {
            builder: self.builder.property("min-width", min_width),
        }
    }

    /// A name that identifies the [`ConstraintGuide`][crate::ConstraintGuide], for debugging.
    pub fn name(self, name: impl Into<glib::GString>) -> Self {
        Self {
            builder: self.builder.property("name", name.into()),
        }
    }

    /// The preferred, or natural, height of the guide.
    pub fn nat_height(self, nat_height: i32) -> Self {
        Self {
            builder: self.builder.property("nat-height", nat_height),
        }
    }

    /// The preferred, or natural, width of the guide.
    pub fn nat_width(self, nat_width: i32) -> Self {
        Self {
            builder: self.builder.property("nat-width", nat_width),
        }
    }

    /// The [`ConstraintStrength`][crate::ConstraintStrength] to be used for the constraint on
    /// the natural size of the guide.
    pub fn strength(self, strength: ConstraintStrength) -> Self {
        Self {
            builder: self.builder.property("strength", strength),
        }
    }

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