gtk/auto/

adjustment.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;
use glib::{
    object::ObjectType as _,
    prelude::*,
    signal::{SignalHandlerId, connect_raw},
    translate::*,
};
use std::boxed::Box as Box_;

glib::wrapper! {
    /// The [`Adjustment`][crate::Adjustment] object represents a value which has an associated lower
    /// and upper bound, together with step and page increments, and a page size.
    /// It is used within several GTK+ widgets, including [`SpinButton`][crate::SpinButton], [`Viewport`][crate::Viewport],
    /// and [`Range`][crate::Range] (which is a base class for [`Scrollbar`][crate::Scrollbar] and [`Scale`][crate::Scale]).
    ///
    /// The [`Adjustment`][crate::Adjustment] object does not update the value itself. Instead
    /// it is left up to the owner of the [`Adjustment`][crate::Adjustment] to control the value.
    ///
    /// ## Properties
    ///
    ///
    /// #### `lower`
    ///  The minimum value of the adjustment.
    ///
    /// Readable | Writable
    ///
    ///
    /// #### `page-increment`
    ///  The page increment of the adjustment.
    ///
    /// Readable | Writable
    ///
    ///
    /// #### `page-size`
    ///  The page size of the adjustment.
    /// Note that the page-size is irrelevant and should be set to zero
    /// if the adjustment is used for a simple scalar value, e.g. in a
    /// [`SpinButton`][crate::SpinButton].
    ///
    /// Readable | Writable
    ///
    ///
    /// #### `step-increment`
    ///  The step increment of the adjustment.
    ///
    /// Readable | Writable
    ///
    ///
    /// #### `upper`
    ///  The maximum value of the adjustment.
    /// Note that values will be restricted by
    /// `upper - page-size` if the page-size
    /// property is nonzero.
    ///
    /// Readable | Writable
    ///
    ///
    /// #### `value`
    ///  The value of the adjustment.
    ///
    /// Readable | Writable
    ///
    /// ## Signals
    ///
    ///
    /// #### `changed`
    ///  Emitted when one or more of the [`Adjustment`][crate::Adjustment] properties have been
    /// changed, other than the [`value`][struct@crate::Adjustment#value] property.
    ///
    ///
    ///
    ///
    /// #### `value-changed`
    ///  Emitted when the [`value`][struct@crate::Adjustment#value] property has been changed.
    ///
    ///
    ///
    /// # Implements
    ///
    /// [`AdjustmentExt`][trait@crate::prelude::AdjustmentExt], [`trait@glib::ObjectExt`]
    #[doc(alias = "GtkAdjustment")]
    pub struct Adjustment(Object<ffi::GtkAdjustment, ffi::GtkAdjustmentClass>);

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

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

    /// Creates a new [`Adjustment`][crate::Adjustment].
    /// ## `value`
    /// the initial value
    /// ## `lower`
    /// the minimum value
    /// ## `upper`
    /// the maximum value
    /// ## `step_increment`
    /// the step increment
    /// ## `page_increment`
    /// the page increment
    /// ## `page_size`
    /// the page size
    ///
    /// # Returns
    ///
    /// a new [`Adjustment`][crate::Adjustment]
    #[doc(alias = "gtk_adjustment_new")]
    pub fn new(
        value: f64,
        lower: f64,
        upper: f64,
        step_increment: f64,
        page_increment: f64,
        page_size: f64,
    ) -> Adjustment {
        assert_initialized_main_thread!();
        unsafe {
            from_glib_none(ffi::gtk_adjustment_new(
                value,
                lower,
                upper,
                step_increment,
                page_increment,
                page_size,
            ))
        }
    }

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

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

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

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

    /// The minimum value of the adjustment.
    pub fn lower(self, lower: f64) -> Self {
        Self {
            builder: self.builder.property("lower", lower),
        }
    }

    /// The page increment of the adjustment.
    pub fn page_increment(self, page_increment: f64) -> Self {
        Self {
            builder: self.builder.property("page-increment", page_increment),
        }
    }

    /// The page size of the adjustment.
    /// Note that the page-size is irrelevant and should be set to zero
    /// if the adjustment is used for a simple scalar value, e.g. in a
    /// [`SpinButton`][crate::SpinButton].
    pub fn page_size(self, page_size: f64) -> Self {
        Self {
            builder: self.builder.property("page-size", page_size),
        }
    }

    /// The step increment of the adjustment.
    pub fn step_increment(self, step_increment: f64) -> Self {
        Self {
            builder: self.builder.property("step-increment", step_increment),
        }
    }

    /// The maximum value of the adjustment.
    /// Note that values will be restricted by
    /// `upper - page-size` if the page-size
    /// property is nonzero.
    pub fn upper(self, upper: f64) -> Self {
        Self {
            builder: self.builder.property("upper", upper),
        }
    }

    /// The value of the adjustment.
    pub fn value(self, value: f64) -> Self {
        Self {
            builder: self.builder.property("value", value),
        }
    }

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

/// Trait containing all [`struct@Adjustment`] methods.
///
/// # Implementors
///
/// [`Adjustment`][struct@crate::Adjustment]
pub trait AdjustmentExt: IsA<Adjustment> + 'static {
    /// Updates the [`value`][struct@crate::Adjustment#value] property to ensure that the range
    /// between `lower` and `upper` is in the current page (i.e. between
    /// [`value`][struct@crate::Adjustment#value] and [`value`][struct@crate::Adjustment#value] + [`page-size`][struct@crate::Adjustment#page-size]).
    /// If the range is larger than the page size, then only the start of it will
    /// be in the current page.
    ///
    /// A [`value-changed`][struct@crate::Adjustment#value-changed] signal will be emitted if the value is changed.
    /// ## `lower`
    /// the lower value
    /// ## `upper`
    /// the upper value
    #[doc(alias = "gtk_adjustment_clamp_page")]
    fn clamp_page(&self, lower: f64, upper: f64) {
        unsafe {
            ffi::gtk_adjustment_clamp_page(self.as_ref().to_glib_none().0, lower, upper);
        }
    }

    /// Sets all properties of the adjustment at once.
    ///
    /// Use this function to avoid multiple emissions of the
    /// [`changed`][struct@crate::Adjustment#changed] signal. See [`set_lower()`][Self::set_lower()]
    /// for an alternative way of compressing multiple emissions of
    /// [`changed`][struct@crate::Adjustment#changed] into one.
    /// ## `value`
    /// the new value
    /// ## `lower`
    /// the new minimum value
    /// ## `upper`
    /// the new maximum value
    /// ## `step_increment`
    /// the new step increment
    /// ## `page_increment`
    /// the new page increment
    /// ## `page_size`
    /// the new page size
    #[doc(alias = "gtk_adjustment_configure")]
    fn configure(
        &self,
        value: f64,
        lower: f64,
        upper: f64,
        step_increment: f64,
        page_increment: f64,
        page_size: f64,
    ) {
        unsafe {
            ffi::gtk_adjustment_configure(
                self.as_ref().to_glib_none().0,
                value,
                lower,
                upper,
                step_increment,
                page_increment,
                page_size,
            );
        }
    }

    /// Retrieves the minimum value of the adjustment.
    ///
    /// # Returns
    ///
    /// The current minimum value of the adjustment
    #[doc(alias = "gtk_adjustment_get_lower")]
    #[doc(alias = "get_lower")]
    fn lower(&self) -> f64 {
        unsafe { ffi::gtk_adjustment_get_lower(self.as_ref().to_glib_none().0) }
    }

    /// Gets the smaller of step increment and page increment.
    ///
    /// # Returns
    ///
    /// the minimum increment of `self`
    #[doc(alias = "gtk_adjustment_get_minimum_increment")]
    #[doc(alias = "get_minimum_increment")]
    fn minimum_increment(&self) -> f64 {
        unsafe { ffi::gtk_adjustment_get_minimum_increment(self.as_ref().to_glib_none().0) }
    }

    /// Retrieves the page increment of the adjustment.
    ///
    /// # Returns
    ///
    /// The current page increment of the adjustment
    #[doc(alias = "gtk_adjustment_get_page_increment")]
    #[doc(alias = "get_page_increment")]
    #[doc(alias = "page-increment")]
    fn page_increment(&self) -> f64 {
        unsafe { ffi::gtk_adjustment_get_page_increment(self.as_ref().to_glib_none().0) }
    }

    /// Retrieves the page size of the adjustment.
    ///
    /// # Returns
    ///
    /// The current page size of the adjustment
    #[doc(alias = "gtk_adjustment_get_page_size")]
    #[doc(alias = "get_page_size")]
    #[doc(alias = "page-size")]
    fn page_size(&self) -> f64 {
        unsafe { ffi::gtk_adjustment_get_page_size(self.as_ref().to_glib_none().0) }
    }

    /// Retrieves the step increment of the adjustment.
    ///
    /// # Returns
    ///
    /// The current step increment of the adjustment.
    #[doc(alias = "gtk_adjustment_get_step_increment")]
    #[doc(alias = "get_step_increment")]
    #[doc(alias = "step-increment")]
    fn step_increment(&self) -> f64 {
        unsafe { ffi::gtk_adjustment_get_step_increment(self.as_ref().to_glib_none().0) }
    }

    /// Retrieves the maximum value of the adjustment.
    ///
    /// # Returns
    ///
    /// The current maximum value of the adjustment
    #[doc(alias = "gtk_adjustment_get_upper")]
    #[doc(alias = "get_upper")]
    fn upper(&self) -> f64 {
        unsafe { ffi::gtk_adjustment_get_upper(self.as_ref().to_glib_none().0) }
    }

    /// Gets the current value of the adjustment.
    /// See [`set_value()`][Self::set_value()].
    ///
    /// # Returns
    ///
    /// The current value of the adjustment
    #[doc(alias = "gtk_adjustment_get_value")]
    #[doc(alias = "get_value")]
    fn value(&self) -> f64 {
        unsafe { ffi::gtk_adjustment_get_value(self.as_ref().to_glib_none().0) }
    }

    /// Sets the minimum value of the adjustment.
    ///
    /// When setting multiple adjustment properties via their individual
    /// setters, multiple [`changed`][struct@crate::Adjustment#changed] signals will be emitted.
    /// However, since the emission of the [`changed`][struct@crate::Adjustment#changed] signal
    /// is tied to the emission of the [`notify`][struct@crate::glib::Object#notify] signals of the changed
    /// properties, it’s possible to compress the [`changed`][struct@crate::Adjustment#changed]
    /// signals into one by calling [`ObjectExt::freeze_notify()`][crate::glib::prelude::ObjectExt::freeze_notify()] and
    /// [`ObjectExt::thaw_notify()`][crate::glib::prelude::ObjectExt::thaw_notify()] around the calls to the individual setters.
    ///
    /// Alternatively, using a single [`ObjectExt::set()`][crate::glib::prelude::ObjectExt::set()] for all the properties
    /// to change, or using [`configure()`][Self::configure()] has the same effect
    /// of compressing [`changed`][struct@crate::Adjustment#changed] emissions.
    /// ## `lower`
    /// the new minimum value
    #[doc(alias = "gtk_adjustment_set_lower")]
    #[doc(alias = "lower")]
    fn set_lower(&self, lower: f64) {
        unsafe {
            ffi::gtk_adjustment_set_lower(self.as_ref().to_glib_none().0, lower);
        }
    }

    /// Sets the page increment of the adjustment.
    ///
    /// See [`set_lower()`][Self::set_lower()] about how to compress multiple
    /// emissions of the [`changed`][struct@crate::Adjustment#changed] signal when setting
    /// multiple adjustment properties.
    /// ## `page_increment`
    /// the new page increment
    #[doc(alias = "gtk_adjustment_set_page_increment")]
    #[doc(alias = "page-increment")]
    fn set_page_increment(&self, page_increment: f64) {
        unsafe {
            ffi::gtk_adjustment_set_page_increment(self.as_ref().to_glib_none().0, page_increment);
        }
    }

    /// Sets the page size of the adjustment.
    ///
    /// See [`set_lower()`][Self::set_lower()] about how to compress multiple
    /// emissions of the GtkAdjustment::changed signal when setting
    /// multiple adjustment properties.
    /// ## `page_size`
    /// the new page size
    #[doc(alias = "gtk_adjustment_set_page_size")]
    #[doc(alias = "page-size")]
    fn set_page_size(&self, page_size: f64) {
        unsafe {
            ffi::gtk_adjustment_set_page_size(self.as_ref().to_glib_none().0, page_size);
        }
    }

    /// Sets the step increment of the adjustment.
    ///
    /// See [`set_lower()`][Self::set_lower()] about how to compress multiple
    /// emissions of the [`changed`][struct@crate::Adjustment#changed] signal when setting
    /// multiple adjustment properties.
    /// ## `step_increment`
    /// the new step increment
    #[doc(alias = "gtk_adjustment_set_step_increment")]
    #[doc(alias = "step-increment")]
    fn set_step_increment(&self, step_increment: f64) {
        unsafe {
            ffi::gtk_adjustment_set_step_increment(self.as_ref().to_glib_none().0, step_increment);
        }
    }

    /// Sets the maximum value of the adjustment.
    ///
    /// Note that values will be restricted by `upper - page-size`
    /// if the page-size property is nonzero.
    ///
    /// See [`set_lower()`][Self::set_lower()] about how to compress multiple
    /// emissions of the [`changed`][struct@crate::Adjustment#changed] signal when setting
    /// multiple adjustment properties.
    /// ## `upper`
    /// the new maximum value
    #[doc(alias = "gtk_adjustment_set_upper")]
    #[doc(alias = "upper")]
    fn set_upper(&self, upper: f64) {
        unsafe {
            ffi::gtk_adjustment_set_upper(self.as_ref().to_glib_none().0, upper);
        }
    }

    /// Sets the [`Adjustment`][crate::Adjustment] value. The value is clamped to lie between
    /// [`lower`][struct@crate::Adjustment#lower] and [`upper`][struct@crate::Adjustment#upper].
    ///
    /// Note that for adjustments which are used in a [`Scrollbar`][crate::Scrollbar], the
    /// effective range of allowed values goes from [`lower`][struct@crate::Adjustment#lower] to
    /// [`upper`][struct@crate::Adjustment#upper] - [`page-size`][struct@crate::Adjustment#page-size].
    /// ## `value`
    /// the new value
    #[doc(alias = "gtk_adjustment_set_value")]
    #[doc(alias = "value")]
    fn set_value(&self, value: f64) {
        unsafe {
            ffi::gtk_adjustment_set_value(self.as_ref().to_glib_none().0, value);
        }
    }

    /// Emitted when one or more of the [`Adjustment`][crate::Adjustment] properties have been
    /// changed, other than the [`value`][struct@crate::Adjustment#value] property.
    #[doc(alias = "changed")]
    fn connect_changed<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn changed_trampoline<P: IsA<Adjustment>, F: Fn(&P) + 'static>(
            this: *mut ffi::GtkAdjustment,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(Adjustment::from_glib_borrow(this).unsafe_cast_ref())
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"changed".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    changed_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// Emitted when the [`value`][struct@crate::Adjustment#value] property has been changed.
    #[doc(alias = "value-changed")]
    fn connect_value_changed<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn value_changed_trampoline<P: IsA<Adjustment>, F: Fn(&P) + 'static>(
            this: *mut ffi::GtkAdjustment,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(Adjustment::from_glib_borrow(this).unsafe_cast_ref())
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"value-changed".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    value_changed_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "lower")]
    fn connect_lower_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_lower_trampoline<P: IsA<Adjustment>, F: Fn(&P) + 'static>(
            this: *mut ffi::GtkAdjustment,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(Adjustment::from_glib_borrow(this).unsafe_cast_ref())
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::lower".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_lower_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "page-increment")]
    fn connect_page_increment_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_page_increment_trampoline<
            P: IsA<Adjustment>,
            F: Fn(&P) + 'static,
        >(
            this: *mut ffi::GtkAdjustment,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(Adjustment::from_glib_borrow(this).unsafe_cast_ref())
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::page-increment".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_page_increment_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "page-size")]
    fn connect_page_size_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_page_size_trampoline<
            P: IsA<Adjustment>,
            F: Fn(&P) + 'static,
        >(
            this: *mut ffi::GtkAdjustment,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(Adjustment::from_glib_borrow(this).unsafe_cast_ref())
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::page-size".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_page_size_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "step-increment")]
    fn connect_step_increment_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_step_increment_trampoline<
            P: IsA<Adjustment>,
            F: Fn(&P) + 'static,
        >(
            this: *mut ffi::GtkAdjustment,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(Adjustment::from_glib_borrow(this).unsafe_cast_ref())
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::step-increment".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_step_increment_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "upper")]
    fn connect_upper_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_upper_trampoline<P: IsA<Adjustment>, F: Fn(&P) + 'static>(
            this: *mut ffi::GtkAdjustment,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(Adjustment::from_glib_borrow(this).unsafe_cast_ref())
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::upper".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_upper_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "value")]
    fn connect_value_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_value_trampoline<P: IsA<Adjustment>, F: Fn(&P) + 'static>(
            this: *mut ffi::GtkAdjustment,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(Adjustment::from_glib_borrow(this).unsafe_cast_ref())
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::value".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_value_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

impl<O: IsA<Adjustment>> AdjustmentExt for O {}