gtk4/auto/

cell_renderer_spinner.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
#![allow(deprecated)]

use crate::{ffi, CellRenderer, CellRendererMode, IconSize};
use glib::{
    prelude::*,
    signal::{connect_raw, SignalHandlerId},
    translate::*,
};
use std::boxed::Box as Box_;

glib::wrapper! {
    /// List views use widgets to display their contents.
    ///   You should use [`Spinner`][crate::Spinner] instead
    /// Renders a spinning animation in a cell
    ///
    /// [`CellRendererSpinner`][crate::CellRendererSpinner] renders a spinning animation in a cell, very
    /// similar to [`Spinner`][crate::Spinner]. It can often be used as an alternative
    /// to a [`CellRendererProgress`][crate::CellRendererProgress] for displaying indefinite activity,
    /// instead of actual progress.
    ///
    /// To start the animation in a cell, set the `GtkCellRendererSpinner:active`
    /// property to [`true`] and increment the `GtkCellRendererSpinner:pulse` property
    /// at regular intervals. The usual way to set the cell renderer properties
    /// for each cell is to bind them to columns in your tree model using e.g.
    /// gtk_tree_view_column_add_attribute().
    ///
    /// ## Properties
    ///
    ///
    /// #### `active`
    ///  Whether the spinner is active (ie. shown) in the cell
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `pulse`
    ///  Pulse of the spinner. Increment this value to draw the next frame of the
    /// spinner animation. Usually, you would update this value in a timeout.
    ///
    /// By default, the [`Spinner`][crate::Spinner] widget draws one full cycle of the animation,
    /// consisting of 12 frames, in 750 milliseconds.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `size`
    ///  The [`IconSize`][crate::IconSize] value that specifies the size of the rendered spinner.
    ///
    /// Readable | Writeable
    /// <details><summary><h4>CellRenderer</h4></summary>
    ///
    ///
    /// #### `cell-background`
    ///  Writeable
    ///
    ///
    /// #### `cell-background-rgba`
    ///  Cell background as a [`gdk::RGBA`][crate::gdk::RGBA]
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `cell-background-set`
    ///  Readable | Writeable
    ///
    ///
    /// #### `editing`
    ///  Readable
    ///
    ///
    /// #### `height`
    ///  Readable | Writeable
    ///
    ///
    /// #### `is-expanded`
    ///  Readable | Writeable
    ///
    ///
    /// #### `is-expander`
    ///  Readable | Writeable
    ///
    ///
    /// #### `mode`
    ///  Readable | Writeable
    ///
    ///
    /// #### `sensitive`
    ///  Readable | Writeable
    ///
    ///
    /// #### `visible`
    ///  Readable | Writeable
    ///
    ///
    /// #### `width`
    ///  Readable | Writeable
    ///
    ///
    /// #### `xalign`
    ///  Readable | Writeable
    ///
    ///
    /// #### `xpad`
    ///  Readable | Writeable
    ///
    ///
    /// #### `yalign`
    ///  Readable | Writeable
    ///
    ///
    /// #### `ypad`
    ///  Readable | Writeable
    /// </details>
    ///
    /// # Implements
    ///
    /// [`CellRendererExt`][trait@crate::prelude::CellRendererExt], [`trait@glib::ObjectExt`], [`CellRendererExtManual`][trait@crate::prelude::CellRendererExtManual]
    #[doc(alias = "GtkCellRendererSpinner")]
    pub struct CellRendererSpinner(Object<ffi::GtkCellRendererSpinner>) @extends CellRenderer;

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

impl CellRendererSpinner {
    /// Returns a new cell renderer which will show a spinner to indicate
    /// activity.
    ///
    /// # Deprecated since 4.10
    ///
    ///
    /// # Returns
    ///
    /// a new [`CellRenderer`][crate::CellRenderer]
    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
    #[allow(deprecated)]
    #[doc(alias = "gtk_cell_renderer_spinner_new")]
    pub fn new() -> CellRendererSpinner {
        assert_initialized_main_thread!();
        unsafe { CellRenderer::from_glib_none(ffi::gtk_cell_renderer_spinner_new()).unsafe_cast() }
    }

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

    /// Whether the spinner is active (ie. shown) in the cell
    pub fn is_active(&self) -> bool {
        ObjectExt::property(self, "active")
    }

    /// Whether the spinner is active (ie. shown) in the cell
    pub fn set_active(&self, active: bool) {
        ObjectExt::set_property(self, "active", active)
    }

    /// Pulse of the spinner. Increment this value to draw the next frame of the
    /// spinner animation. Usually, you would update this value in a timeout.
    ///
    /// By default, the [`Spinner`][crate::Spinner] widget draws one full cycle of the animation,
    /// consisting of 12 frames, in 750 milliseconds.
    pub fn pulse(&self) -> u32 {
        ObjectExt::property(self, "pulse")
    }

    /// Pulse of the spinner. Increment this value to draw the next frame of the
    /// spinner animation. Usually, you would update this value in a timeout.
    ///
    /// By default, the [`Spinner`][crate::Spinner] widget draws one full cycle of the animation,
    /// consisting of 12 frames, in 750 milliseconds.
    pub fn set_pulse(&self, pulse: u32) {
        ObjectExt::set_property(self, "pulse", pulse)
    }

    /// The [`IconSize`][crate::IconSize] value that specifies the size of the rendered spinner.
    pub fn size(&self) -> IconSize {
        ObjectExt::property(self, "size")
    }

    /// The [`IconSize`][crate::IconSize] value that specifies the size of the rendered spinner.
    pub fn set_size(&self, size: IconSize) {
        ObjectExt::set_property(self, "size", size)
    }

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

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

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

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

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

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

    /// Whether the spinner is active (ie. shown) in the cell
    pub fn active(self, active: bool) -> Self {
        Self {
            builder: self.builder.property("active", active),
        }
    }

    /// Pulse of the spinner. Increment this value to draw the next frame of the
    /// spinner animation. Usually, you would update this value in a timeout.
    ///
    /// By default, the [`Spinner`][crate::Spinner] widget draws one full cycle of the animation,
    /// consisting of 12 frames, in 750 milliseconds.
    pub fn pulse(self, pulse: u32) -> Self {
        Self {
            builder: self.builder.property("pulse", pulse),
        }
    }

    /// The [`IconSize`][crate::IconSize] value that specifies the size of the rendered spinner.
    pub fn size(self, size: IconSize) -> Self {
        Self {
            builder: self.builder.property("size", size),
        }
    }

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

    /// Cell background as a [`gdk::RGBA`][crate::gdk::RGBA]
    pub fn cell_background_rgba(self, cell_background_rgba: &gdk::RGBA) -> Self {
        Self {
            builder: self
                .builder
                .property("cell-background-rgba", cell_background_rgba),
        }
    }

    pub fn cell_background_set(self, cell_background_set: bool) -> Self {
        Self {
            builder: self
                .builder
                .property("cell-background-set", cell_background_set),
        }
    }

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

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

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

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

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

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

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

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

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

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

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

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