libadwaita/auto/

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

glib::wrapper! {
    /// An auxiliary class used by [`ViewStack`][crate::ViewStack].
    ///
    /// ## Properties
    ///
    ///
    /// #### `badge-number`
    ///  The badge number for this page.
    ///
    /// [`ViewSwitcher`][crate::ViewSwitcher] can display it as a badge next to the page icon. It is
    /// commonly used to display a number of unread items within the page.
    ///
    /// It can be used together with [property@ViewStack{age}:needs-attention].
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `child`
    ///  The stack child to which the page belongs.
    ///
    /// Readable | Writeable | Construct Only
    ///
    ///
    /// #### `icon-name`
    ///  The icon name of the child page.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `name`
    ///  The name of the child page.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `needs-attention`
    ///  Whether the page requires the user attention.
    ///
    /// [`ViewSwitcher`][crate::ViewSwitcher] will display it as a dot next to the page icon.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `section-title`
    ///  Section title for this page.
    ///
    /// Does nothing unless [`starts-section`][struct@crate::ViewStackPage#starts-section] is set.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `starts-section`
    ///  Whether this page starts a section.
    ///
    /// If set to `TRUE`, [`pages`][struct@crate::ViewStack#pages] will have a section starting
    /// from this page.
    ///
    /// If [`section-title`][struct@crate::ViewStackPage#section-title] is set, it should be used as a
    /// title for the section.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `title`
    ///  The title of the child page.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `use-underline`
    ///  Whether an embedded underline in the title indicates a mnemonic.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `visible`
    ///  Whether this page is visible.
    ///
    /// This is independent from the [`visible`][struct@crate::gtk::Widget#visible] property of
    /// [`child`][struct@crate::ViewStackPage#child].
    ///
    /// Readable | Writeable
    /// <details><summary><h4>Accessible</h4></summary>
    ///
    ///
    /// #### `accessible-role`
    ///  The accessible role of the given [`gtk::Accessible`][crate::gtk::Accessible] implementation.
    ///
    /// The accessible role cannot be changed once set.
    ///
    /// Readable | Writeable
    /// </details>
    ///
    /// # Implements
    ///
    /// [`trait@glib::ObjectExt`], [`trait@gtk::prelude::AccessibleExt`]
    #[doc(alias = "AdwViewStackPage")]
    pub struct ViewStackPage(Object<ffi::AdwViewStackPage, ffi::AdwViewStackPageClass>) @implements gtk::Accessible;

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

impl ViewStackPage {
    /// Gets the badge number for this page.
    ///
    /// # Returns
    ///
    /// the badge number for this page
    #[doc(alias = "adw_view_stack_page_get_badge_number")]
    #[doc(alias = "get_badge_number")]
    #[doc(alias = "badge-number")]
    pub fn badge_number(&self) -> u32 {
        unsafe { ffi::adw_view_stack_page_get_badge_number(self.to_glib_none().0) }
    }

    /// Gets the stack child to which @self belongs.
    ///
    /// # Returns
    ///
    /// the child to which @self belongs
    #[doc(alias = "adw_view_stack_page_get_child")]
    #[doc(alias = "get_child")]
    pub fn child(&self) -> gtk::Widget {
        unsafe { from_glib_none(ffi::adw_view_stack_page_get_child(self.to_glib_none().0)) }
    }

    /// Gets the icon name of the page.
    ///
    /// # Returns
    ///
    /// the icon name of the page
    #[doc(alias = "adw_view_stack_page_get_icon_name")]
    #[doc(alias = "get_icon_name")]
    #[doc(alias = "icon-name")]
    pub fn icon_name(&self) -> Option<glib::GString> {
        unsafe {
            from_glib_none(ffi::adw_view_stack_page_get_icon_name(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets the name of the page.
    ///
    /// # Returns
    ///
    /// the name of the page
    #[doc(alias = "adw_view_stack_page_get_name")]
    #[doc(alias = "get_name")]
    pub fn name(&self) -> Option<glib::GString> {
        unsafe { from_glib_none(ffi::adw_view_stack_page_get_name(self.to_glib_none().0)) }
    }

    /// Gets whether the page requires the user attention.
    ///
    /// # Returns
    ///
    /// whether the page needs attention
    #[doc(alias = "adw_view_stack_page_get_needs_attention")]
    #[doc(alias = "get_needs_attention")]
    #[doc(alias = "needs-attention")]
    pub fn needs_attention(&self) -> bool {
        unsafe {
            from_glib(ffi::adw_view_stack_page_get_needs_attention(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets the section title for @self.
    ///
    /// # Returns
    ///
    /// the section title
    #[cfg(feature = "v1_9")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_9")))]
    #[doc(alias = "adw_view_stack_page_get_section_title")]
    #[doc(alias = "get_section_title")]
    #[doc(alias = "section-title")]
    pub fn section_title(&self) -> Option<glib::GString> {
        unsafe {
            from_glib_none(ffi::adw_view_stack_page_get_section_title(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets whether @self starts a section.
    ///
    /// # Returns
    ///
    /// whether @self starts a section
    #[cfg(feature = "v1_9")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_9")))]
    #[doc(alias = "adw_view_stack_page_get_starts_section")]
    #[doc(alias = "get_starts_section")]
    #[doc(alias = "starts-section")]
    pub fn is_starts_section(&self) -> bool {
        unsafe {
            from_glib(ffi::adw_view_stack_page_get_starts_section(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets the page title.
    ///
    /// # Returns
    ///
    /// the page title
    #[doc(alias = "adw_view_stack_page_get_title")]
    #[doc(alias = "get_title")]
    pub fn title(&self) -> Option<glib::GString> {
        unsafe { from_glib_none(ffi::adw_view_stack_page_get_title(self.to_glib_none().0)) }
    }

    /// Gets whether underlines in the page title indicate mnemonics.
    ///
    /// # Returns
    ///
    /// whether underlines in the page title indicate mnemonics
    #[doc(alias = "adw_view_stack_page_get_use_underline")]
    #[doc(alias = "get_use_underline")]
    #[doc(alias = "use-underline")]
    pub fn uses_underline(&self) -> bool {
        unsafe {
            from_glib(ffi::adw_view_stack_page_get_use_underline(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets whether @self is visible in its [`ViewStack`][crate::ViewStack].
    ///
    /// This is independent from the [`visible`][struct@crate::gtk::Widget#visible]
    /// property of its widget.
    ///
    /// # Returns
    ///
    /// whether @self is visible
    #[doc(alias = "adw_view_stack_page_get_visible")]
    #[doc(alias = "get_visible")]
    #[doc(alias = "visible")]
    pub fn is_visible(&self) -> bool {
        unsafe { from_glib(ffi::adw_view_stack_page_get_visible(self.to_glib_none().0)) }
    }

    /// Sets the badge number for this page.
    ///
    /// [`ViewSwitcher`][crate::ViewSwitcher] can display it as a badge next to the page icon. It is
    /// commonly used to display a number of unread items within the page.
    ///
    /// It can be used together with [property@ViewStack{age}:needs-attention].
    /// ## `badge_number`
    /// the new value to set
    #[doc(alias = "adw_view_stack_page_set_badge_number")]
    #[doc(alias = "badge-number")]
    pub fn set_badge_number(&self, badge_number: u32) {
        unsafe {
            ffi::adw_view_stack_page_set_badge_number(self.to_glib_none().0, badge_number);
        }
    }

    /// Sets the icon name of the page.
    /// ## `icon_name`
    /// the icon name
    #[doc(alias = "adw_view_stack_page_set_icon_name")]
    #[doc(alias = "icon-name")]
    pub fn set_icon_name(&self, icon_name: Option<&str>) {
        unsafe {
            ffi::adw_view_stack_page_set_icon_name(
                self.to_glib_none().0,
                icon_name.to_glib_none().0,
            );
        }
    }

    /// Sets the name of the page.
    /// ## `name`
    /// the page name
    #[doc(alias = "adw_view_stack_page_set_name")]
    #[doc(alias = "name")]
    pub fn set_name(&self, name: Option<&str>) {
        unsafe {
            ffi::adw_view_stack_page_set_name(self.to_glib_none().0, name.to_glib_none().0);
        }
    }

    /// Sets whether the page requires the user attention.
    ///
    /// [`ViewSwitcher`][crate::ViewSwitcher] will display it as a dot next to the page icon.
    /// ## `needs_attention`
    /// the new value to set
    #[doc(alias = "adw_view_stack_page_set_needs_attention")]
    #[doc(alias = "needs-attention")]
    pub fn set_needs_attention(&self, needs_attention: bool) {
        unsafe {
            ffi::adw_view_stack_page_set_needs_attention(
                self.to_glib_none().0,
                needs_attention.into_glib(),
            );
        }
    }

    /// Sets the section title for @self.
    ///
    /// Does nothing unless [`starts-section`][struct@crate::ViewStackPage#starts-section] is set.
    /// ## `section_title`
    /// the section title
    #[cfg(feature = "v1_9")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_9")))]
    #[doc(alias = "adw_view_stack_page_set_section_title")]
    #[doc(alias = "section-title")]
    pub fn set_section_title(&self, section_title: Option<&str>) {
        unsafe {
            ffi::adw_view_stack_page_set_section_title(
                self.to_glib_none().0,
                section_title.to_glib_none().0,
            );
        }
    }

    /// Sets whether @self starts a section.
    ///
    /// If set to `TRUE`, [`pages`][struct@crate::ViewStack#pages] will have a section starting
    /// from this page.
    ///
    /// If [`section-title`][struct@crate::ViewStackPage#section-title] is set, it should be used as a
    /// title for the section.
    /// ## `starts_section`
    /// whether @self starts a section
    #[cfg(feature = "v1_9")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_9")))]
    #[doc(alias = "adw_view_stack_page_set_starts_section")]
    #[doc(alias = "starts-section")]
    pub fn set_starts_section(&self, starts_section: bool) {
        unsafe {
            ffi::adw_view_stack_page_set_starts_section(
                self.to_glib_none().0,
                starts_section.into_glib(),
            );
        }
    }

    /// Sets the page title.
    /// ## `title`
    /// the page title
    #[doc(alias = "adw_view_stack_page_set_title")]
    #[doc(alias = "title")]
    pub fn set_title(&self, title: Option<&str>) {
        unsafe {
            ffi::adw_view_stack_page_set_title(self.to_glib_none().0, title.to_glib_none().0);
        }
    }

    /// Sets whether underlines in the page title indicate mnemonics.
    /// ## `use_underline`
    /// the new value to set
    #[doc(alias = "adw_view_stack_page_set_use_underline")]
    #[doc(alias = "use-underline")]
    pub fn set_use_underline(&self, use_underline: bool) {
        unsafe {
            ffi::adw_view_stack_page_set_use_underline(
                self.to_glib_none().0,
                use_underline.into_glib(),
            );
        }
    }

    /// Sets whether @self is visible in its [`ViewStack`][crate::ViewStack].
    ///
    /// This is independent from the [`visible`][struct@crate::gtk::Widget#visible] property of
    /// [`child`][struct@crate::ViewStackPage#child].
    /// ## `visible`
    /// whether @self is visible
    #[doc(alias = "adw_view_stack_page_set_visible")]
    #[doc(alias = "visible")]
    pub fn set_visible(&self, visible: bool) {
        unsafe {
            ffi::adw_view_stack_page_set_visible(self.to_glib_none().0, visible.into_glib());
        }
    }

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

    #[doc(alias = "icon-name")]
    pub fn connect_icon_name_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_icon_name_trampoline<F: Fn(&ViewStackPage) + 'static>(
            this: *mut ffi::AdwViewStackPage,
            _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::icon-name".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_icon_name_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(&ViewStackPage) + 'static>(
            this: *mut ffi::AdwViewStackPage,
            _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 = "needs-attention")]
    pub fn connect_needs_attention_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_needs_attention_trampoline<F: Fn(&ViewStackPage) + 'static>(
            this: *mut ffi::AdwViewStackPage,
            _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::needs-attention".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_needs_attention_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

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

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

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

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

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