libadwaita/auto/

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

glib::wrapper! {
    /// A helper object for [`ToastOverlay`][crate::ToastOverlay].
    ///
    /// Toasts are meant to be passed into [`ToastOverlay::add_toast()`][crate::ToastOverlay::add_toast()] as
    /// follows:
    ///
    /// **⚠️ The following code is in c ⚠️**
    ///
    /// ```c
    /// adw_toast_overlay_add_toast (overlay, adw_toast_new (_("Simple Toast")));
    /// ```
    ///
    /// <picture>
    ///   <source srcset="toast-simple-dark.png" media="(prefers-color-scheme: dark)">
    ///   <img src="toast-simple.png" alt="toast-simple">
    /// </picture>
    ///
    /// Toasts always have a close button. They emit the [`dismissed`][struct@crate::Toast#dismissed]
    /// signal when disappearing.
    ///
    /// [`timeout`][struct@crate::Toast#timeout] determines how long the toast stays on screen, while
    /// [`priority`][struct@crate::Toast#priority] determines how it behaves if another toast is
    /// already being displayed.
    ///
    /// Toast titles use Pango markup by default, set [`use-markup`][struct@crate::Toast#use-markup] to
    /// `FALSE` if this is unwanted.
    ///
    /// [`custom-title`][struct@crate::Toast#custom-title] can be used to replace the title label with a
    /// custom widget.
    ///
    /// ## Actions
    ///
    /// Toasts can have one button on them, with a label and an attached
    /// `Gio::Action`.
    ///
    /// **⚠️ The following code is in c ⚠️**
    ///
    /// ```c
    /// AdwToast *toast = adw_toast_new (_("Toast with Action"));
    ///
    /// adw_toast_set_button_label (toast, _("_Example"));
    /// adw_toast_set_action_name (toast, "win.example");
    ///
    /// adw_toast_overlay_add_toast (overlay, toast);
    /// ```
    ///
    /// <picture>
    ///   <source srcset="toast-action-dark.png" media="(prefers-color-scheme: dark)">
    ///   <img src="toast-action.png" alt="toast-action">
    /// </picture>
    ///
    /// ## Modifying toasts
    ///
    /// Toasts can be modified after they have been shown. For this, an [`Toast`][crate::Toast]
    /// reference must be kept around while the toast is visible.
    ///
    /// A common use case for this is using toasts as undo prompts that stack with
    /// each other, allowing to batch undo the last deleted items:
    ///
    /// **⚠️ The following code is in c ⚠️**
    ///
    /// ```c
    ///
    /// static void
    /// toast_undo_cb (GtkWidget  *sender,
    ///                const char *action,
    ///                GVariant   *param)
    /// {
    ///   // Undo the deletion
    /// }
    ///
    /// static void
    /// dismissed_cb (MyWindow *self)
    /// {
    ///   self->undo_toast = NULL;
    ///
    ///   // Permanently delete the items
    /// }
    ///
    /// static void
    /// delete_item (MyWindow *self,
    ///              MyItem   *item)
    /// {
    ///   g_autofree char *title = NULL;
    ///   int n_items;
    ///
    ///   // Mark the item as waiting for deletion
    ///   n_items = ... // The number of waiting items
    ///
    ///   if (!self->undo_toast) {
    ///     self->undo_toast = adw_toast_new_format (_("‘%s’ deleted"), ...);
    ///
    ///     adw_toast_set_priority (self->undo_toast, ADW_TOAST_PRIORITY_HIGH);
    ///     adw_toast_set_button_label (self->undo_toast, _("_Undo"));
    ///     adw_toast_set_action_name (self->undo_toast, "toast.undo");
    ///
    ///     g_signal_connect_swapped (self->undo_toast, "dismissed",
    ///                               G_CALLBACK (dismissed_cb), self);
    ///
    ///     adw_toast_overlay_add_toast (self->toast_overlay, self->undo_toast);
    ///
    ///     return;
    ///   }
    ///
    ///   title =
    ///     g_strdup_printf (ngettext ("<span font_features='tnum=1'>%d</span> item deleted",
    ///                                "<span font_features='tnum=1'>%d</span> items deleted",
    ///                                n_items), n_items);
    ///
    ///   adw_toast_set_title (self->undo_toast, title);
    ///
    ///   // Bump the toast timeout
    ///   adw_toast_overlay_add_toast (self->toast_overlay, g_object_ref (self->undo_toast));
    /// }
    ///
    /// static void
    /// my_window_class_init (MyWindowClass *klass)
    /// {
    ///   GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (klass);
    ///
    ///   gtk_widget_class_install_action (widget_class, "toast.undo", NULL, toast_undo_cb);
    /// }
    /// ```
    ///
    /// <picture>
    ///   <source srcset="toast-undo-dark.png" media="(prefers-color-scheme: dark)">
    ///   <img src="toast-undo.png" alt="toast-undo">
    /// </picture>
    ///
    /// ## Properties
    ///
    ///
    /// #### `action-name`
    ///  The name of the associated action.
    ///
    /// It will be activated when clicking the button.
    ///
    /// See [`action-target`][struct@crate::Toast#action-target].
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `action-target`
    ///  The parameter for action invocations.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `button-label`
    ///  The label to show on the button.
    ///
    /// Underlines in the button text can be used to indicate a mnemonic.
    ///
    /// If set to `NULL`, the button won't be shown.
    ///
    /// See [`action-name`][struct@crate::Toast#action-name].
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `custom-title`
    ///  The custom title widget.
    ///
    /// It will be displayed instead of the title if set. In this case,
    /// [`title`][struct@crate::Toast#title] is ignored.
    ///
    /// Setting a custom title will unset [`title`][struct@crate::Toast#title].
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `priority`
    ///  The priority of the toast.
    ///
    /// Priority controls how the toast behaves when another toast is already
    /// being displayed.
    ///
    /// If the priority is [enum@Adw.ToastPriority.normal], the toast will be
    /// queued.
    ///
    /// If the priority is [enum@Adw.ToastPriority.high], the toast will be
    /// displayed immediately, pushing the previous toast into the queue instead.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `timeout`
    ///  The timeout of the toast, in seconds.
    ///
    /// If timeout is 0, the toast is displayed indefinitely until manually
    /// dismissed.
    ///
    /// Toasts cannot disappear while being hovered, pressed (on touchscreen), or
    /// have keyboard focus inside them.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `title`
    ///  The title of the toast.
    ///
    /// The title can be marked up with the Pango text markup language.
    ///
    /// Setting a title will unset [`custom-title`][struct@crate::Toast#custom-title].
    ///
    /// If [`custom-title`][struct@crate::Toast#custom-title] is set, it will be used instead.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `use-markup`
    ///  Whether to use Pango markup for the toast title.
    ///
    /// See also `parse_markup()`.
    ///
    /// Readable | Writeable
    ///
    /// ## Signals
    ///
    ///
    /// #### `button-clicked`
    ///  Emitted after the button has been clicked.
    ///
    /// It can be used as an alternative to setting an action.
    ///
    ///
    ///
    ///
    /// #### `dismissed`
    ///  Emitted when the toast has been dismissed.
    ///
    ///
    ///
    /// # Implements
    ///
    /// [`trait@glib::ObjectExt`]
    #[doc(alias = "AdwToast")]
    pub struct Toast(Object<ffi::AdwToast, ffi::AdwToastClass>);

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

impl Toast {
    /// Creates a new [`Toast`][crate::Toast].
    ///
    /// The toast will use @title as its title.
    ///
    /// @title can be marked up with the Pango text markup language.
    /// ## `title`
    /// the title to be displayed
    ///
    /// # Returns
    ///
    /// the new created [`Toast`][crate::Toast]
    #[doc(alias = "adw_toast_new")]
    pub fn new(title: &str) -> Toast {
        assert_initialized_main_thread!();
        unsafe { from_glib_full(ffi::adw_toast_new(title.to_glib_none().0)) }
    }

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

    /// Dismisses @self.
    ///
    /// Does nothing if @self has already been dismissed, or hasn't been added to an
    /// [`ToastOverlay`][crate::ToastOverlay].
    #[doc(alias = "adw_toast_dismiss")]
    pub fn dismiss(&self) {
        unsafe {
            ffi::adw_toast_dismiss(self.to_glib_none().0);
        }
    }

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

    /// Gets the parameter for action invocations.
    ///
    /// # Returns
    ///
    /// the action target
    #[doc(alias = "adw_toast_get_action_target_value")]
    #[doc(alias = "get_action_target_value")]
    #[doc(alias = "action-target")]
    pub fn action_target_value(&self) -> Option<glib::Variant> {
        unsafe {
            from_glib_none(ffi::adw_toast_get_action_target_value(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets the label to show on the button.
    ///
    /// # Returns
    ///
    /// the button label
    #[doc(alias = "adw_toast_get_button_label")]
    #[doc(alias = "get_button_label")]
    #[doc(alias = "button-label")]
    pub fn button_label(&self) -> Option<glib::GString> {
        unsafe { from_glib_none(ffi::adw_toast_get_button_label(self.to_glib_none().0)) }
    }

    /// Gets the custom title widget of @self.
    ///
    /// # Returns
    ///
    /// the custom title widget
    #[cfg(feature = "v1_2")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_2")))]
    #[doc(alias = "adw_toast_get_custom_title")]
    #[doc(alias = "get_custom_title")]
    #[doc(alias = "custom-title")]
    pub fn custom_title(&self) -> Option<gtk::Widget> {
        unsafe { from_glib_none(ffi::adw_toast_get_custom_title(self.to_glib_none().0)) }
    }

    /// Gets priority for @self.
    ///
    /// # Returns
    ///
    /// the priority
    #[doc(alias = "adw_toast_get_priority")]
    #[doc(alias = "get_priority")]
    pub fn priority(&self) -> ToastPriority {
        unsafe { from_glib(ffi::adw_toast_get_priority(self.to_glib_none().0)) }
    }

    /// Gets timeout for @self.
    ///
    /// # Returns
    ///
    /// the timeout
    #[doc(alias = "adw_toast_get_timeout")]
    #[doc(alias = "get_timeout")]
    pub fn timeout(&self) -> u32 {
        unsafe { ffi::adw_toast_get_timeout(self.to_glib_none().0) }
    }

    /// Gets the title that will be displayed on the toast.
    ///
    /// If a custom title has been set with [`set_custom_title()`][Self::set_custom_title()]
    /// the return value will be [`None`].
    ///
    /// # Returns
    ///
    /// the title
    #[doc(alias = "adw_toast_get_title")]
    #[doc(alias = "get_title")]
    pub fn title(&self) -> Option<glib::GString> {
        unsafe { from_glib_none(ffi::adw_toast_get_title(self.to_glib_none().0)) }
    }

    /// Gets whether to use Pango markup for the toast title.
    ///
    /// # Returns
    ///
    /// whether the toast uses markup
    #[cfg(feature = "v1_4")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_4")))]
    #[doc(alias = "adw_toast_get_use_markup")]
    #[doc(alias = "get_use_markup")]
    #[doc(alias = "use-markup")]
    pub fn uses_markup(&self) -> bool {
        unsafe { from_glib(ffi::adw_toast_get_use_markup(self.to_glib_none().0)) }
    }

    /// Sets the name of the associated action.
    ///
    /// It will be activated when clicking the button.
    ///
    /// See [`action-target`][struct@crate::Toast#action-target].
    /// ## `action_name`
    /// the action name
    #[doc(alias = "adw_toast_set_action_name")]
    #[doc(alias = "action-name")]
    pub fn set_action_name(&self, action_name: Option<&str>) {
        unsafe {
            ffi::adw_toast_set_action_name(self.to_glib_none().0, action_name.to_glib_none().0);
        }
    }

    /// Sets the parameter for action invocations.
    ///
    /// If the @action_target variant has a floating reference this function
    /// will sink it.
    /// ## `action_target`
    /// the action target
    #[doc(alias = "adw_toast_set_action_target_value")]
    #[doc(alias = "action-target")]
    pub fn set_action_target_value(&self, action_target: Option<&glib::Variant>) {
        unsafe {
            ffi::adw_toast_set_action_target_value(
                self.to_glib_none().0,
                action_target.to_glib_none().0,
            );
        }
    }

    /// Sets the label to show on the button.
    ///
    /// Underlines in the button text can be used to indicate a mnemonic.
    ///
    /// If set to `NULL`, the button won't be shown.
    ///
    /// See [`action-name`][struct@crate::Toast#action-name].
    /// ## `button_label`
    /// a button label
    #[doc(alias = "adw_toast_set_button_label")]
    #[doc(alias = "button-label")]
    pub fn set_button_label(&self, button_label: Option<&str>) {
        unsafe {
            ffi::adw_toast_set_button_label(self.to_glib_none().0, button_label.to_glib_none().0);
        }
    }

    /// Sets the custom title widget of @self.
    ///
    /// It will be displayed instead of the title if set. In this case,
    /// [`title`][struct@crate::Toast#title] is ignored.
    ///
    /// Setting a custom title will unset [`title`][struct@crate::Toast#title].
    /// ## `widget`
    /// the custom title widget
    #[cfg(feature = "v1_2")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_2")))]
    #[doc(alias = "adw_toast_set_custom_title")]
    #[doc(alias = "custom-title")]
    pub fn set_custom_title(&self, widget: Option<&impl IsA<gtk::Widget>>) {
        unsafe {
            ffi::adw_toast_set_custom_title(
                self.to_glib_none().0,
                widget.map(|p| p.as_ref()).to_glib_none().0,
            );
        }
    }

    /// Sets the action name and its parameter.
    ///
    /// @detailed_action_name is a string in the format accepted by
    /// `Gio::Action::parse_detailed_name()`.
    /// ## `detailed_action_name`
    /// the detailed action name
    #[doc(alias = "adw_toast_set_detailed_action_name")]
    pub fn set_detailed_action_name(&self, detailed_action_name: Option<&str>) {
        unsafe {
            ffi::adw_toast_set_detailed_action_name(
                self.to_glib_none().0,
                detailed_action_name.to_glib_none().0,
            );
        }
    }

    /// Sets priority for @self.
    ///
    /// Priority controls how the toast behaves when another toast is already
    /// being displayed.
    ///
    /// If @priority is [enum@Adw.ToastPriority.normal], the toast will be queued.
    ///
    /// If @priority is [enum@Adw.ToastPriority.high], the toast will be displayed
    /// immediately, pushing the previous toast into the queue instead.
    /// ## `priority`
    /// the priority
    #[doc(alias = "adw_toast_set_priority")]
    #[doc(alias = "priority")]
    pub fn set_priority(&self, priority: ToastPriority) {
        unsafe {
            ffi::adw_toast_set_priority(self.to_glib_none().0, priority.into_glib());
        }
    }

    /// Sets timeout for @self.
    ///
    /// If @timeout is 0, the toast is displayed indefinitely until manually
    /// dismissed.
    ///
    /// Toasts cannot disappear while being hovered, pressed (on touchscreen), or
    /// have keyboard focus inside them.
    /// ## `timeout`
    /// the timeout
    #[doc(alias = "adw_toast_set_timeout")]
    #[doc(alias = "timeout")]
    pub fn set_timeout(&self, timeout: u32) {
        unsafe {
            ffi::adw_toast_set_timeout(self.to_glib_none().0, timeout);
        }
    }

    /// Sets the title that will be displayed on the toast.
    ///
    /// The title can be marked up with the Pango text markup language.
    ///
    /// Setting a title will unset [`custom-title`][struct@crate::Toast#custom-title].
    ///
    /// If [`custom-title`][struct@crate::Toast#custom-title] is set, it will be used instead.
    /// ## `title`
    /// a title
    #[doc(alias = "adw_toast_set_title")]
    #[doc(alias = "title")]
    pub fn set_title(&self, title: &str) {
        unsafe {
            ffi::adw_toast_set_title(self.to_glib_none().0, title.to_glib_none().0);
        }
    }

    /// Whether to use Pango markup for the toast title.
    ///
    /// See also `parse_markup()`.
    /// ## `use_markup`
    /// whether to use markup
    #[cfg(feature = "v1_4")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_4")))]
    #[doc(alias = "adw_toast_set_use_markup")]
    #[doc(alias = "use-markup")]
    pub fn set_use_markup(&self, use_markup: bool) {
        unsafe {
            ffi::adw_toast_set_use_markup(self.to_glib_none().0, use_markup.into_glib());
        }
    }

    /// Emitted after the button has been clicked.
    ///
    /// It can be used as an alternative to setting an action.
    #[cfg(feature = "v1_2")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_2")))]
    #[doc(alias = "button-clicked")]
    pub fn connect_button_clicked<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn button_clicked_trampoline<F: Fn(&Toast) + 'static>(
            this: *mut ffi::AdwToast,
            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"button-clicked".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    button_clicked_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// Emitted when the toast has been dismissed.
    #[doc(alias = "dismissed")]
    pub fn connect_dismissed<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn dismissed_trampoline<F: Fn(&Toast) + 'static>(
            this: *mut ffi::AdwToast,
            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"dismissed".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    dismissed_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

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

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

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

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

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

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

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

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

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

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

    /// The name of the associated action.
    ///
    /// It will be activated when clicking the button.
    ///
    /// See [`action-target`][struct@crate::Toast#action-target].
    pub fn action_name(self, action_name: impl Into<glib::GString>) -> Self {
        Self {
            builder: self.builder.property("action-name", action_name.into()),
        }
    }

    /// The parameter for action invocations.
    pub fn action_target(self, action_target: &glib::Variant) -> Self {
        Self {
            builder: self
                .builder
                .property("action-target", action_target.clone()),
        }
    }

    /// The label to show on the button.
    ///
    /// Underlines in the button text can be used to indicate a mnemonic.
    ///
    /// If set to `NULL`, the button won't be shown.
    ///
    /// See [`action-name`][struct@crate::Toast#action-name].
    pub fn button_label(self, button_label: impl Into<glib::GString>) -> Self {
        Self {
            builder: self.builder.property("button-label", button_label.into()),
        }
    }

    /// The custom title widget.
    ///
    /// It will be displayed instead of the title if set. In this case,
    /// [`title`][struct@crate::Toast#title] is ignored.
    ///
    /// Setting a custom title will unset [`title`][struct@crate::Toast#title].
    #[cfg(feature = "v1_2")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_2")))]
    pub fn custom_title(self, custom_title: &impl IsA<gtk::Widget>) -> Self {
        Self {
            builder: self
                .builder
                .property("custom-title", custom_title.clone().upcast()),
        }
    }

    /// The priority of the toast.
    ///
    /// Priority controls how the toast behaves when another toast is already
    /// being displayed.
    ///
    /// If the priority is [enum@Adw.ToastPriority.normal], the toast will be
    /// queued.
    ///
    /// If the priority is [enum@Adw.ToastPriority.high], the toast will be
    /// displayed immediately, pushing the previous toast into the queue instead.
    pub fn priority(self, priority: ToastPriority) -> Self {
        Self {
            builder: self.builder.property("priority", priority),
        }
    }

    /// The timeout of the toast, in seconds.
    ///
    /// If timeout is 0, the toast is displayed indefinitely until manually
    /// dismissed.
    ///
    /// Toasts cannot disappear while being hovered, pressed (on touchscreen), or
    /// have keyboard focus inside them.
    pub fn timeout(self, timeout: u32) -> Self {
        Self {
            builder: self.builder.property("timeout", timeout),
        }
    }

    /// The title of the toast.
    ///
    /// The title can be marked up with the Pango text markup language.
    ///
    /// Setting a title will unset [`custom-title`][struct@crate::Toast#custom-title].
    ///
    /// If [`custom-title`][struct@crate::Toast#custom-title] is set, it will be used instead.
    pub fn title(self, title: impl Into<glib::GString>) -> Self {
        Self {
            builder: self.builder.property("title", title.into()),
        }
    }

    /// Whether to use Pango markup for the toast title.
    ///
    /// See also `parse_markup()`.
    #[cfg(feature = "v1_4")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_4")))]
    pub fn use_markup(self, use_markup: bool) -> Self {
        Self {
            builder: self.builder.property("use-markup", use_markup),
        }
    }

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