Struct gtk::ModelButton

#[repr(transparent)]
pub struct ModelButton { /* private fields */ }

GtkModelButton is a button class that can use a GAction as its model. In contrast to ToggleButton or RadioButton, which can also be backed by a GAction via the property::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(); they can also be used manually in a PopoverMenu.

When the action is specified via the property::Actionable::action-name and property::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 property::ModelButton::role property.

The content of the button is specified by the property::ModelButton::text and property::ModelButton::icon properties.

The appearance of model buttons can be influenced with the property::ModelButton::centered and property::ModelButton::iconic properties.

Model buttons have built-in support for submenus in PopoverMenu. To make a GtkModelButton that opens a submenu when activated, set the property::ModelButton::menu-name property. To make a button that goes back to the parent menu, you should set the property::ModelButton::inverted property to place the submenu indicator at the opposite side.

Example

⚠️ The following code is in plain ⚠️

modelbutton
├── <child>
╰── check

⚠️ The following code is in plain ⚠️

modelbutton
├── <child>
╰── radio

⚠️ The following code is in 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 ⚠️

button.model
├── <child>
╰── check

Iconic model buttons (see property::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.

Implements

ButtonExt, BinExt, ContainerExt, WidgetExt, glib::ObjectExt, BuildableExt, ActionableExt, ContainerExtManual, WidgetExtManual, BuildableExtManual

Implementations

impl ModelButton

pub fn new() -> ModelButton

Creates a new GtkModelButton.

Returns

the newly created ModelButton widget

pub fn builder() -> ModelButtonBuilder

Creates a new builder-pattern struct instance to construct ModelButton objects.

This method returns an instance of ModelButtonBuilder which can be used to create ModelButton objects.

pub fn is_active(&self) -> bool

The state of the button. This is reflecting the state of the associated GAction.

pub fn set_active(&self, active: bool)

The state of the button. This is reflecting the state of the associated GAction.

pub fn is_centered(&self) -> bool

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)

Whether to render the button contents centered instead of left-aligned. This property should be set for title-like items.

pub fn icon(&self) -> Option<Icon>

A gio::Icon that will be used if iconic appearance for the button is desired.

pub fn set_icon<P: IsA<Icon>>(&self, icon: Option<&P>)

A gio::Icon that will be used if iconic appearance for the button is desired.

pub fn is_iconic(&self) -> bool

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)

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_inverted(&self) -> bool

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)

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 menu_name(&self) -> Option<GString>

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 set_menu_name(&self, menu_name: Option<&str>)

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 role(&self) -> ButtonRole

Specifies whether the button is a plain, check or radio button. When property::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)

Specifies whether the button is a plain, check or radio button. When property::Actionable::action-name is set, the role will be determined from the action and does not have to be set explicitly.

pub fn text(&self) -> Option<GString>

The label for the button.

pub fn set_text(&self, text: Option<&str>)

The label for the button.

pub fn uses_markup(&self) -> bool

Available on crate feature v3_24 only.

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.

pub fn set_use_markup(&self, use_markup: bool)

Available on crate feature v3_24 only.

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.

pub fn connect_active_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_centered_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_icon_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_iconic_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_inverted_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_menu_name_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_role_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_text_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_use_markup_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

Available on crate feature v3_24 only.

Trait Implementations

impl Clone for ModelButton

fn clone(&self) -> Self

Returns a copy of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ModelButton

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ModelButton

fn default() -> Self

Returns the “default value” for a type.

impl Display for ModelButton

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for ModelButton

fn hash<H>(&self, state: &mut H)where
    H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,

Feeds a slice of this type into the given Hasher.

impl Ord for ModelButton

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

const fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

const fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

const fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for ModelButton

type Parent = Button

impl<OT: ObjectType> PartialEq<OT> for ModelButton

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for ModelButton

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

const fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

const fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

const fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

const fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for ModelButton

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for ModelButton

impl IsA<Actionable> for ModelButton

impl IsA<Bin> for ModelButton

impl IsA<Buildable> for ModelButton

impl IsA<Button> for ModelButton

impl IsA<Container> for ModelButton

impl IsA<Widget> for ModelButton