gtk/auto/

model_button.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::{
    Actionable, Align, Bin, Buildable, Button, ButtonRole, Container, PositionType, ReliefStyle,
    ResizeMode, Widget,
};
use glib::{
    prelude::*,
    signal::{connect_raw, SignalHandlerId},
    translate::*,
};
use std::{boxed::Box as Box_, fmt, mem::transmute};

glib::wrapper! {
    /// GtkModelButton is a button class that can use a `GAction` as its model.
    /// In contrast to [`ToggleButton`][crate::ToggleButton] or [`RadioButton`][crate::RadioButton], which can also
    /// be backed by a `GAction` via the [`action-name`][struct@crate::Actionable#action-name] property,
    /// GtkModelButton will adapt its appearance according to the kind of
    /// action it is backed by, and appear either as a plain, check or
    /// radio button.
    ///
    /// Model buttons are used when popovers from a menu model with
    /// [`Popover::from_model()`][crate::Popover::from_model()]; they can also be used manually in
    /// a [`PopoverMenu`][crate::PopoverMenu].
    ///
    /// When the action is specified via the [`action-name`][struct@crate::Actionable#action-name]
    /// and [`action-target`][struct@crate::Actionable#action-target] properties, the role of the button
    /// (i.e. whether it is a plain, check or radio button) is determined by
    /// the type of the action and doesn't have to be explicitly specified
    /// with the [`role`][struct@crate::ModelButton#role] property.
    ///
    /// The content of the button is specified by the [`text`][struct@crate::ModelButton#text]
    /// and [`icon`][struct@crate::ModelButton#icon] properties.
    ///
    /// The appearance of model buttons can be influenced with the
    /// [`centered`][struct@crate::ModelButton#centered] and [`iconic`][struct@crate::ModelButton#iconic] properties.
    ///
    /// Model buttons have built-in support for submenus in [`PopoverMenu`][crate::PopoverMenu].
    /// To make a GtkModelButton that opens a submenu when activated, set
    /// the [`menu-name`][struct@crate::ModelButton#menu-name] property. To make a button that goes
    /// back to the parent menu, you should set the [`inverted`][struct@crate::ModelButton#inverted]
    /// property to place the submenu indicator at the opposite side.
    ///
    /// # Example
    ///
    ///
    ///
    /// **⚠️ The following code is in plain ⚠️**
    ///
    /// ```plain
    /// modelbutton
    /// ├── <child>
    /// ╰── check
    /// ```
    ///
    ///
    ///
    /// **⚠️ The following code is in plain ⚠️**
    ///
    /// ```plain
    /// modelbutton
    /// ├── <child>
    /// ╰── radio
    /// ```
    ///
    ///
    ///
    /// **⚠️ The following code is in plain ⚠️**
    ///
    /// ```plain
    /// modelbutton
    /// ├── <child>
    /// ╰── arrow
    /// ```
    ///
    /// GtkModelButton has a main CSS node with name modelbutton, and a subnode,
    /// which will have the name check, radio or arrow, depending on the role
    /// of the button and whether it has a menu name set.
    ///
    /// The subnode is positioned before or after the content nodes and gets the
    /// .left or .right style class, depending on where it is located.
    ///
    ///
    ///
    /// **⚠️ The following code is in plain ⚠️**
    ///
    /// ```plain
    /// button.model
    /// ├── <child>
    /// ╰── check
    /// ```
    ///
    /// Iconic model buttons (see [`iconic`][struct@crate::ModelButton#iconic]) change the name of
    /// their main node to button and add a .model style class to it. The indicator
    /// subnode is invisible in this case.
    ///
    /// ## Properties
    ///
    ///
    /// #### `active`
    ///  The state of the button. This is reflecting the state of the associated
    /// `GAction`.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `centered`
    ///  Whether to render the button contents centered instead of left-aligned.
    /// This property should be set for title-like items.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `icon`
    ///  A [`gio::Icon`][crate::gio::Icon] that will be used if iconic appearance for the button is
    /// desired.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `iconic`
    ///  If this property is set, the button will show an icon if one is set.
    /// If no icon is set, the text will be used. This is typically used for
    /// horizontal sections of linked buttons.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `inverted`
    ///  Whether to show the submenu indicator at the opposite side than normal.
    /// This property should be set for model buttons that 'go back' to a parent
    /// menu.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `menu-name`
    ///  The name of a submenu to open when the button is activated.
    /// If this is set, the button should not have an action associated with it.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `role`
    ///  Specifies whether the button is a plain, check or radio button.
    /// When [`action-name`][struct@crate::Actionable#action-name] is set, the role will be determined
    /// from the action and does not have to be set explicitly.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `text`
    ///  The label for the button.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `use-markup`
    ///  If [`true`], XML tags in the text of the button are interpreted as by
    /// `pango_parse_markup()` to format the enclosed spans of text. If [`false`], the
    /// text will be displayed verbatim.
    ///
    /// Readable | Writeable
    /// <details><summary><h4>Button</h4></summary>
    ///
    ///
    /// #### `always-show-image`
    ///  If [`true`], the button will ignore the [`gtk-button-images`][struct@crate::Settings#gtk-button-images]
    /// setting and always show the image, if available.
    ///
    /// Use this property if the button would be useless or hard to use
    /// without the image.
    ///
    /// Readable | Writeable | Construct
    ///
    ///
    /// #### `image`
    ///  The child widget to appear next to the button text.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `image-position`
    ///  The position of the image relative to the text inside the button.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `label`
    ///  Readable | Writeable | Construct
    ///
    ///
    /// #### `relief`
    ///  Readable | Writeable
    ///
    ///
    /// #### `use-stock`
    ///  Readable | Writeable | Construct
    ///
    ///
    /// #### `use-underline`
    ///  Readable | Writeable | Construct
    ///
    ///
    /// #### `xalign`
    ///  If the child of the button is a [`Misc`][crate::Misc] or `GtkAlignment`, this property
    /// can be used to control its horizontal alignment. 0.0 is left aligned,
    /// 1.0 is right aligned.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `yalign`
    ///  If the child of the button is a [`Misc`][crate::Misc] or `GtkAlignment`, this property
    /// can be used to control its vertical alignment. 0.0 is top aligned,
    /// 1.0 is bottom aligned.
    ///
    /// Readable | Writeable
    /// </details>
    /// <details><summary><h4>Container</h4></summary>
    ///
    ///
    /// #### `border-width`
    ///  Readable | Writeable
    ///
    ///
    /// #### `child`
    ///  Writeable
    ///
    ///
    /// #### `resize-mode`
    ///  Readable | Writeable
    /// </details>
    /// <details><summary><h4>Widget</h4></summary>
    ///
    ///
    /// #### `app-paintable`
    ///  Readable | Writeable
    ///
    ///
    /// #### `can-default`
    ///  Readable | Writeable
    ///
    ///
    /// #### `can-focus`
    ///  Readable | Writeable
    ///
    ///
    /// #### `composite-child`
    ///  Readable
    ///
    ///
    /// #### `double-buffered`
    ///  Whether the widget is double buffered.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `events`
    ///  Readable | Writeable
    ///
    ///
    /// #### `expand`
    ///  Whether to expand in both directions. Setting this sets both [`hexpand`][struct@crate::Widget#hexpand] and [`vexpand`][struct@crate::Widget#vexpand]
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `focus-on-click`
    ///  Whether the widget should grab focus when it is clicked with the mouse.
    ///
    /// This property is only relevant for widgets that can take focus.
    ///
    /// Before 3.20, several widgets (GtkButton, GtkFileChooserButton,
    /// GtkComboBox) implemented this property individually.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `halign`
    ///  How to distribute horizontal space if widget gets extra space, see [`Align`][crate::Align]
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `has-default`
    ///  Readable | Writeable
    ///
    ///
    /// #### `has-focus`
    ///  Readable | Writeable
    ///
    ///
    /// #### `has-tooltip`
    ///  Enables or disables the emission of [`query-tooltip`][struct@crate::Widget#query-tooltip] on `widget`.
    /// A value of [`true`] indicates that `widget` can have a tooltip, in this case
    /// the widget will be queried using [`query-tooltip`][struct@crate::Widget#query-tooltip] to determine
    /// whether it will provide a tooltip or not.
    ///
    /// Note that setting this property to [`true`] for the first time will change
    /// the event masks of the GdkWindows of this widget to include leave-notify
    /// and motion-notify events. This cannot and will not be undone when the
    /// property is set to [`false`] again.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `height-request`
    ///  Readable | Writeable
    ///
    ///
    /// #### `hexpand`
    ///  Whether to expand horizontally. See [`WidgetExt::set_hexpand()`][crate::prelude::WidgetExt::set_hexpand()].
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `hexpand-set`
    ///  Whether to use the [`hexpand`][struct@crate::Widget#hexpand] property. See [`WidgetExt::is_hexpand_set()`][crate::prelude::WidgetExt::is_hexpand_set()].
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `is-focus`
    ///  Readable | Writeable
    ///
    ///
    /// #### `margin`
    ///  Sets all four sides' margin at once. If read, returns max
    /// margin on any side.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `margin-bottom`
    ///  Margin on bottom side of widget.
    ///
    /// This property adds margin outside of the widget's normal size
    /// request, the margin will be added in addition to the size from
    /// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `margin-end`
    ///  Margin on end of widget, horizontally. This property supports
    /// left-to-right and right-to-left text directions.
    ///
    /// This property adds margin outside of the widget's normal size
    /// request, the margin will be added in addition to the size from
    /// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `margin-left`
    ///  Margin on left side of widget.
    ///
    /// This property adds margin outside of the widget's normal size
    /// request, the margin will be added in addition to the size from
    /// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `margin-right`
    ///  Margin on right side of widget.
    ///
    /// This property adds margin outside of the widget's normal size
    /// request, the margin will be added in addition to the size from
    /// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `margin-start`
    ///  Margin on start of widget, horizontally. This property supports
    /// left-to-right and right-to-left text directions.
    ///
    /// This property adds margin outside of the widget's normal size
    /// request, the margin will be added in addition to the size from
    /// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `margin-top`
    ///  Margin on top side of widget.
    ///
    /// This property adds margin outside of the widget's normal size
    /// request, the margin will be added in addition to the size from
    /// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `name`
    ///  Readable | Writeable
    ///
    ///
    /// #### `no-show-all`
    ///  Readable | Writeable
    ///
    ///
    /// #### `opacity`
    ///  The requested opacity of the widget. See [`WidgetExt::set_opacity()`][crate::prelude::WidgetExt::set_opacity()] for
    /// more details about window opacity.
    ///
    /// Before 3.8 this was only available in GtkWindow
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `parent`
    ///  Readable | Writeable
    ///
    ///
    /// #### `receives-default`
    ///  Readable | Writeable
    ///
    ///
    /// #### `scale-factor`
    ///  The scale factor of the widget. See [`WidgetExt::scale_factor()`][crate::prelude::WidgetExt::scale_factor()] for
    /// more details about widget scaling.
    ///
    /// Readable
    ///
    ///
    /// #### `sensitive`
    ///  Readable | Writeable
    ///
    ///
    /// #### `style`
    ///  The style of the widget, which contains information about how it will look (colors, etc).
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `tooltip-markup`
    ///  Sets the text of tooltip to be the given string, which is marked up
    /// with the [Pango text markup language][PangoMarkupFormat].
    /// Also see [`Tooltip::set_markup()`][crate::Tooltip::set_markup()].
    ///
    /// This is a convenience property which will take care of getting the
    /// tooltip shown if the given string is not [`None`]: [`has-tooltip`][struct@crate::Widget#has-tooltip]
    /// will automatically be set to [`true`] and there will be taken care of
    /// [`query-tooltip`][struct@crate::Widget#query-tooltip] in the default signal handler.
    ///
    /// Note that if both [`tooltip-text`][struct@crate::Widget#tooltip-text] and [`tooltip-markup`][struct@crate::Widget#tooltip-markup]
    /// are set, the last one wins.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `tooltip-text`
    ///  Sets the text of tooltip to be the given string.
    ///
    /// Also see [`Tooltip::set_text()`][crate::Tooltip::set_text()].
    ///
    /// This is a convenience property which will take care of getting the
    /// tooltip shown if the given string is not [`None`]: [`has-tooltip`][struct@crate::Widget#has-tooltip]
    /// will automatically be set to [`true`] and there will be taken care of
    /// [`query-tooltip`][struct@crate::Widget#query-tooltip] in the default signal handler.
    ///
    /// Note that if both [`tooltip-text`][struct@crate::Widget#tooltip-text] and [`tooltip-markup`][struct@crate::Widget#tooltip-markup]
    /// are set, the last one wins.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `valign`
    ///  How to distribute vertical space if widget gets extra space, see [`Align`][crate::Align]
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `vexpand`
    ///  Whether to expand vertically. See [`WidgetExt::set_vexpand()`][crate::prelude::WidgetExt::set_vexpand()].
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `vexpand-set`
    ///  Whether to use the [`vexpand`][struct@crate::Widget#vexpand] property. See [`WidgetExt::is_vexpand_set()`][crate::prelude::WidgetExt::is_vexpand_set()].
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `visible`
    ///  Readable | Writeable
    ///
    ///
    /// #### `width-request`
    ///  Readable | Writeable
    ///
    ///
    /// #### `window`
    ///  The widget's window if it is realized, [`None`] otherwise.
    ///
    /// Readable
    /// </details>
    /// <details><summary><h4>Actionable</h4></summary>
    ///
    ///
    /// #### `action-name`
    ///  Readable | Writeable
    ///
    ///
    /// #### `action-target`
    ///  Readable | Writeable
    /// </details>
    /// <details><summary><h4>Activatable</h4></summary>
    ///
    ///
    /// #### `related-action`
    ///  The action that this activatable will activate and receive
    /// updates from for various states and possibly appearance.
    ///
    /// > `GtkActivatable` implementors need to handle the this property and
    /// > call `gtk_activatable_do_set_related_action()` when it changes.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `use-action-appearance`
    ///  Whether this activatable should reset its layout
    /// and appearance when setting the related action or when
    /// the action changes appearance.
    ///
    /// See the `GtkAction` documentation directly to find which properties
    /// should be ignored by the `GtkActivatable` when this property is [`false`].
    ///
    /// > `GtkActivatable` implementors need to handle this property
    /// > and call `gtk_activatable_sync_action_properties()` on the activatable
    /// > widget when it changes.
    ///
    /// Readable | Writeable
    /// </details>
    ///
    /// # Implements
    ///
    /// [`ButtonExt`][trait@crate::prelude::ButtonExt], [`BinExt`][trait@crate::prelude::BinExt], [`ContainerExt`][trait@crate::prelude::ContainerExt], [`WidgetExt`][trait@crate::prelude::WidgetExt], [`trait@glib::ObjectExt`], [`BuildableExt`][trait@crate::prelude::BuildableExt], [`ActionableExt`][trait@crate::prelude::ActionableExt], [`ContainerExtManual`][trait@crate::prelude::ContainerExtManual], [`WidgetExtManual`][trait@crate::prelude::WidgetExtManual], [`BuildableExtManual`][trait@crate::prelude::BuildableExtManual]
    #[doc(alias = "GtkModelButton")]
    pub struct ModelButton(Object<ffi::GtkModelButton>) @extends Button, Bin, Container, Widget, @implements Buildable, Actionable;

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

impl ModelButton {
    /// Creates a new GtkModelButton.
    ///
    /// # Returns
    ///
    /// the newly created [`ModelButton`][crate::ModelButton] widget
    #[doc(alias = "gtk_model_button_new")]
    pub fn new() -> ModelButton {
        assert_initialized_main_thread!();
        unsafe { Widget::from_glib_none(ffi::gtk_model_button_new()).unsafe_cast() }
    }

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

    /// The state of the button. This is reflecting the state of the associated
    /// `GAction`.
    pub fn is_active(&self) -> bool {
        ObjectExt::property(self, "active")
    }

    /// The state of the button. This is reflecting the state of the associated
    /// `GAction`.
    pub fn set_active(&self, active: bool) {
        ObjectExt::set_property(self, "active", active)
    }

    /// Whether to render the button contents centered instead of left-aligned.
    /// This property should be set for title-like items.
    pub fn is_centered(&self) -> bool {
        ObjectExt::property(self, "centered")
    }

    /// Whether to render the button contents centered instead of left-aligned.
    /// This property should be set for title-like items.
    pub fn set_centered(&self, centered: bool) {
        ObjectExt::set_property(self, "centered", centered)
    }

    /// A [`gio::Icon`][crate::gio::Icon] that will be used if iconic appearance for the button is
    /// desired.
    pub fn icon(&self) -> Option<gio::Icon> {
        ObjectExt::property(self, "icon")
    }

    /// A [`gio::Icon`][crate::gio::Icon] that will be used if iconic appearance for the button is
    /// desired.
    pub fn set_icon<P: IsA<gio::Icon>>(&self, icon: Option<&P>) {
        ObjectExt::set_property(self, "icon", icon)
    }

    /// If this property is set, the button will show an icon if one is set.
    /// If no icon is set, the text will be used. This is typically used for
    /// horizontal sections of linked buttons.
    pub fn is_iconic(&self) -> bool {
        ObjectExt::property(self, "iconic")
    }

    /// If this property is set, the button will show an icon if one is set.
    /// If no icon is set, the text will be used. This is typically used for
    /// horizontal sections of linked buttons.
    pub fn set_iconic(&self, iconic: bool) {
        ObjectExt::set_property(self, "iconic", iconic)
    }

    /// Whether to show the submenu indicator at the opposite side than normal.
    /// This property should be set for model buttons that 'go back' to a parent
    /// menu.
    pub fn is_inverted(&self) -> bool {
        ObjectExt::property(self, "inverted")
    }

    /// Whether to show the submenu indicator at the opposite side than normal.
    /// This property should be set for model buttons that 'go back' to a parent
    /// menu.
    pub fn set_inverted(&self, inverted: bool) {
        ObjectExt::set_property(self, "inverted", inverted)
    }

    /// The name of a submenu to open when the button is activated.
    /// If this is set, the button should not have an action associated with it.
    #[doc(alias = "menu-name")]
    pub fn menu_name(&self) -> Option<glib::GString> {
        ObjectExt::property(self, "menu-name")
    }

    /// The name of a submenu to open when the button is activated.
    /// If this is set, the button should not have an action associated with it.
    #[doc(alias = "menu-name")]
    pub fn set_menu_name(&self, menu_name: Option<&str>) {
        ObjectExt::set_property(self, "menu-name", menu_name)
    }

    /// Specifies whether the button is a plain, check or radio button.
    /// When [`action-name`][struct@crate::Actionable#action-name] is set, the role will be determined
    /// from the action and does not have to be set explicitly.
    pub fn role(&self) -> ButtonRole {
        ObjectExt::property(self, "role")
    }

    /// Specifies whether the button is a plain, check or radio button.
    /// When [`action-name`][struct@crate::Actionable#action-name] is set, the role will be determined
    /// from the action and does not have to be set explicitly.
    pub fn set_role(&self, role: ButtonRole) {
        ObjectExt::set_property(self, "role", role)
    }

    /// The label for the button.
    pub fn text(&self) -> Option<glib::GString> {
        ObjectExt::property(self, "text")
    }

    /// The label for the button.
    pub fn set_text(&self, text: Option<&str>) {
        ObjectExt::set_property(self, "text", text)
    }

    /// If [`true`], XML tags in the text of the button are interpreted as by
    /// `pango_parse_markup()` to format the enclosed spans of text. If [`false`], the
    /// text will be displayed verbatim.
    #[cfg(feature = "v3_24")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v3_24")))]
    #[doc(alias = "use-markup")]
    pub fn uses_markup(&self) -> bool {
        ObjectExt::property(self, "use-markup")
    }

    /// If [`true`], XML tags in the text of the button are interpreted as by
    /// `pango_parse_markup()` to format the enclosed spans of text. If [`false`], the
    /// text will be displayed verbatim.
    #[cfg(feature = "v3_24")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v3_24")))]
    #[doc(alias = "use-markup")]
    pub fn set_use_markup(&self, use_markup: bool) {
        ObjectExt::set_property(self, "use-markup", use_markup)
    }

    #[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(&ModelButton) + 'static>(
            this: *mut ffi::GtkModelButton,
            _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 _,
                b"notify::active\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_active_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "centered")]
    pub fn connect_centered_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_centered_trampoline<F: Fn(&ModelButton) + 'static>(
            this: *mut ffi::GtkModelButton,
            _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 _,
                b"notify::centered\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_centered_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "icon")]
    pub fn connect_icon_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_icon_trampoline<F: Fn(&ModelButton) + 'static>(
            this: *mut ffi::GtkModelButton,
            _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 _,
                b"notify::icon\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_icon_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "iconic")]
    pub fn connect_iconic_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_iconic_trampoline<F: Fn(&ModelButton) + 'static>(
            this: *mut ffi::GtkModelButton,
            _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 _,
                b"notify::iconic\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_iconic_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "inverted")]
    pub fn connect_inverted_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_inverted_trampoline<F: Fn(&ModelButton) + 'static>(
            this: *mut ffi::GtkModelButton,
            _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 _,
                b"notify::inverted\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_inverted_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "menu-name")]
    pub fn connect_menu_name_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_menu_name_trampoline<F: Fn(&ModelButton) + 'static>(
            this: *mut ffi::GtkModelButton,
            _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 _,
                b"notify::menu-name\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_menu_name_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "role")]
    pub fn connect_role_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_role_trampoline<F: Fn(&ModelButton) + 'static>(
            this: *mut ffi::GtkModelButton,
            _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 _,
                b"notify::role\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_role_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "text")]
    pub fn connect_text_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_text_trampoline<F: Fn(&ModelButton) + 'static>(
            this: *mut ffi::GtkModelButton,
            _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 _,
                b"notify::text\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_text_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[cfg(feature = "v3_24")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v3_24")))]
    #[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(&ModelButton) + 'static>(
            this: *mut ffi::GtkModelButton,
            _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 _,
                b"notify::use-markup\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_use_markup_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

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

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

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

    /// The state of the button. This is reflecting the state of the associated
    /// `GAction`.
    pub fn active(self, active: bool) -> Self {
        Self {
            builder: self.builder.property("active", active),
        }
    }

    /// Whether to render the button contents centered instead of left-aligned.
    /// This property should be set for title-like items.
    pub fn centered(self, centered: bool) -> Self {
        Self {
            builder: self.builder.property("centered", centered),
        }
    }

    /// A [`gio::Icon`][crate::gio::Icon] that will be used if iconic appearance for the button is
    /// desired.
    pub fn icon(self, icon: &impl IsA<gio::Icon>) -> Self {
        Self {
            builder: self.builder.property("icon", icon.clone().upcast()),
        }
    }

    /// If this property is set, the button will show an icon if one is set.
    /// If no icon is set, the text will be used. This is typically used for
    /// horizontal sections of linked buttons.
    pub fn iconic(self, iconic: bool) -> Self {
        Self {
            builder: self.builder.property("iconic", iconic),
        }
    }

    /// Whether to show the submenu indicator at the opposite side than normal.
    /// This property should be set for model buttons that 'go back' to a parent
    /// menu.
    pub fn inverted(self, inverted: bool) -> Self {
        Self {
            builder: self.builder.property("inverted", inverted),
        }
    }

    /// The name of a submenu to open when the button is activated.
    /// If this is set, the button should not have an action associated with it.
    pub fn menu_name(self, menu_name: impl Into<glib::GString>) -> Self {
        Self {
            builder: self.builder.property("menu-name", menu_name.into()),
        }
    }

    /// Specifies whether the button is a plain, check or radio button.
    /// When [`action-name`][struct@crate::Actionable#action-name] is set, the role will be determined
    /// from the action and does not have to be set explicitly.
    pub fn role(self, role: ButtonRole) -> Self {
        Self {
            builder: self.builder.property("role", role),
        }
    }

    /// The label for the button.
    pub fn text(self, text: impl Into<glib::GString>) -> Self {
        Self {
            builder: self.builder.property("text", text.into()),
        }
    }

    /// If [`true`], XML tags in the text of the button are interpreted as by
    /// `pango_parse_markup()` to format the enclosed spans of text. If [`false`], the
    /// text will be displayed verbatim.
    #[cfg(feature = "v3_24")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v3_24")))]
    pub fn use_markup(self, use_markup: bool) -> Self {
        Self {
            builder: self.builder.property("use-markup", use_markup),
        }
    }

    /// If [`true`], the button will ignore the [`gtk-button-images`][struct@crate::Settings#gtk-button-images]
    /// setting and always show the image, if available.
    ///
    /// Use this property if the button would be useless or hard to use
    /// without the image.
    pub fn always_show_image(self, always_show_image: bool) -> Self {
        Self {
            builder: self
                .builder
                .property("always-show-image", always_show_image),
        }
    }

    /// The child widget to appear next to the button text.
    pub fn image(self, image: &impl IsA<Widget>) -> Self {
        Self {
            builder: self.builder.property("image", image.clone().upcast()),
        }
    }

    /// The position of the image relative to the text inside the button.
    pub fn image_position(self, image_position: PositionType) -> Self {
        Self {
            builder: self.builder.property("image-position", image_position),
        }
    }

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

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

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

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

    pub fn child(self, child: &impl IsA<Widget>) -> Self {
        Self {
            builder: self.builder.property("child", child.clone().upcast()),
        }
    }

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

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

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

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

    pub fn events(self, events: gdk::EventMask) -> Self {
        Self {
            builder: self.builder.property("events", events),
        }
    }

    /// Whether to expand in both directions. Setting this sets both [`hexpand`][struct@crate::Widget#hexpand] and [`vexpand`][struct@crate::Widget#vexpand]
    pub fn expand(self, expand: bool) -> Self {
        Self {
            builder: self.builder.property("expand", expand),
        }
    }

    /// Whether the widget should grab focus when it is clicked with the mouse.
    ///
    /// This property is only relevant for widgets that can take focus.
    ///
    /// Before 3.20, several widgets (GtkButton, GtkFileChooserButton,
    /// GtkComboBox) implemented this property individually.
    pub fn focus_on_click(self, focus_on_click: bool) -> Self {
        Self {
            builder: self.builder.property("focus-on-click", focus_on_click),
        }
    }

    /// How to distribute horizontal space if widget gets extra space, see [`Align`][crate::Align]
    pub fn halign(self, halign: Align) -> Self {
        Self {
            builder: self.builder.property("halign", halign),
        }
    }

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

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

    /// Enables or disables the emission of [`query-tooltip`][struct@crate::Widget#query-tooltip] on `widget`.
    /// A value of [`true`] indicates that `widget` can have a tooltip, in this case
    /// the widget will be queried using [`query-tooltip`][struct@crate::Widget#query-tooltip] to determine
    /// whether it will provide a tooltip or not.
    ///
    /// Note that setting this property to [`true`] for the first time will change
    /// the event masks of the GdkWindows of this widget to include leave-notify
    /// and motion-notify events. This cannot and will not be undone when the
    /// property is set to [`false`] again.
    pub fn has_tooltip(self, has_tooltip: bool) -> Self {
        Self {
            builder: self.builder.property("has-tooltip", has_tooltip),
        }
    }

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

    /// Whether to expand horizontally. See [`WidgetExt::set_hexpand()`][crate::prelude::WidgetExt::set_hexpand()].
    pub fn hexpand(self, hexpand: bool) -> Self {
        Self {
            builder: self.builder.property("hexpand", hexpand),
        }
    }

    /// Whether to use the [`hexpand`][struct@crate::Widget#hexpand] property. See [`WidgetExt::is_hexpand_set()`][crate::prelude::WidgetExt::is_hexpand_set()].
    pub fn hexpand_set(self, hexpand_set: bool) -> Self {
        Self {
            builder: self.builder.property("hexpand-set", hexpand_set),
        }
    }

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

    /// Sets all four sides' margin at once. If read, returns max
    /// margin on any side.
    pub fn margin(self, margin: i32) -> Self {
        Self {
            builder: self.builder.property("margin", margin),
        }
    }

    /// Margin on bottom side of widget.
    ///
    /// This property adds margin outside of the widget's normal size
    /// request, the margin will be added in addition to the size from
    /// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
    pub fn margin_bottom(self, margin_bottom: i32) -> Self {
        Self {
            builder: self.builder.property("margin-bottom", margin_bottom),
        }
    }

    /// Margin on end of widget, horizontally. This property supports
    /// left-to-right and right-to-left text directions.
    ///
    /// This property adds margin outside of the widget's normal size
    /// request, the margin will be added in addition to the size from
    /// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
    pub fn margin_end(self, margin_end: i32) -> Self {
        Self {
            builder: self.builder.property("margin-end", margin_end),
        }
    }

    /// Margin on start of widget, horizontally. This property supports
    /// left-to-right and right-to-left text directions.
    ///
    /// This property adds margin outside of the widget's normal size
    /// request, the margin will be added in addition to the size from
    /// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
    pub fn margin_start(self, margin_start: i32) -> Self {
        Self {
            builder: self.builder.property("margin-start", margin_start),
        }
    }

    /// Margin on top side of widget.
    ///
    /// This property adds margin outside of the widget's normal size
    /// request, the margin will be added in addition to the size from
    /// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
    pub fn margin_top(self, margin_top: i32) -> Self {
        Self {
            builder: self.builder.property("margin-top", margin_top),
        }
    }

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

    pub fn no_show_all(self, no_show_all: bool) -> Self {
        Self {
            builder: self.builder.property("no-show-all", no_show_all),
        }
    }

    /// The requested opacity of the widget. See [`WidgetExt::set_opacity()`][crate::prelude::WidgetExt::set_opacity()] for
    /// more details about window opacity.
    ///
    /// Before 3.8 this was only available in GtkWindow
    pub fn opacity(self, opacity: f64) -> Self {
        Self {
            builder: self.builder.property("opacity", opacity),
        }
    }

    pub fn parent(self, parent: &impl IsA<Container>) -> Self {
        Self {
            builder: self.builder.property("parent", parent.clone().upcast()),
        }
    }

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

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

    /// Sets the text of tooltip to be the given string, which is marked up
    /// with the [Pango text markup language][PangoMarkupFormat].
    /// Also see [`Tooltip::set_markup()`][crate::Tooltip::set_markup()].
    ///
    /// This is a convenience property which will take care of getting the
    /// tooltip shown if the given string is not [`None`]: [`has-tooltip`][struct@crate::Widget#has-tooltip]
    /// will automatically be set to [`true`] and there will be taken care of
    /// [`query-tooltip`][struct@crate::Widget#query-tooltip] in the default signal handler.
    ///
    /// Note that if both [`tooltip-text`][struct@crate::Widget#tooltip-text] and [`tooltip-markup`][struct@crate::Widget#tooltip-markup]
    /// are set, the last one wins.
    pub fn tooltip_markup(self, tooltip_markup: impl Into<glib::GString>) -> Self {
        Self {
            builder: self
                .builder
                .property("tooltip-markup", tooltip_markup.into()),
        }
    }

    /// Sets the text of tooltip to be the given string.
    ///
    /// Also see [`Tooltip::set_text()`][crate::Tooltip::set_text()].
    ///
    /// This is a convenience property which will take care of getting the
    /// tooltip shown if the given string is not [`None`]: [`has-tooltip`][struct@crate::Widget#has-tooltip]
    /// will automatically be set to [`true`] and there will be taken care of
    /// [`query-tooltip`][struct@crate::Widget#query-tooltip] in the default signal handler.
    ///
    /// Note that if both [`tooltip-text`][struct@crate::Widget#tooltip-text] and [`tooltip-markup`][struct@crate::Widget#tooltip-markup]
    /// are set, the last one wins.
    pub fn tooltip_text(self, tooltip_text: impl Into<glib::GString>) -> Self {
        Self {
            builder: self.builder.property("tooltip-text", tooltip_text.into()),
        }
    }

    /// How to distribute vertical space if widget gets extra space, see [`Align`][crate::Align]
    pub fn valign(self, valign: Align) -> Self {
        Self {
            builder: self.builder.property("valign", valign),
        }
    }

    /// Whether to expand vertically. See [`WidgetExt::set_vexpand()`][crate::prelude::WidgetExt::set_vexpand()].
    pub fn vexpand(self, vexpand: bool) -> Self {
        Self {
            builder: self.builder.property("vexpand", vexpand),
        }
    }

    /// Whether to use the [`vexpand`][struct@crate::Widget#vexpand] property. See [`WidgetExt::is_vexpand_set()`][crate::prelude::WidgetExt::is_vexpand_set()].
    pub fn vexpand_set(self, vexpand_set: bool) -> Self {
        Self {
            builder: self.builder.property("vexpand-set", vexpand_set),
        }
    }

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

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

    pub fn action_name(self, action_name: impl Into<glib::GString>) -> Self {
        Self {
            builder: self.builder.property("action-name", action_name.into()),
        }
    }

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

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

impl fmt::Display for ModelButton {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        f.write_str("ModelButton")
    }
}