Struct gtk::ModelButton[−][src]

pub struct ModelButton(_);

Expand description

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, 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

This is supported 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)

This is supported 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

This is supported on crate feature v3_24 only.

Trait Implementations

impl Clone for ModelButton

fn clone(&self) -> ModelButton

Returns a copy of the value. Read more

1.0.0[src]

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

Performs copy-assignment from source. Read more

impl Debug for ModelButton

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

Formats the value using the given formatter. Read more

impl Default for ModelButton

fn default() -> Self

Returns the “default value” for a type. Read more

impl Display for ModelButton

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

Formats the value using the given formatter. Read more

impl Hash for ModelButton

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

Feeds this value into the given Hasher. Read more

1.3.0[src]

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

Feeds a slice of this type into the given Hasher. Read more

impl Ord for ModelButton

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

This method returns an Ordering between self and other. Read more

1.21.0[src]

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

Compares and returns the maximum of two values. Read more

1.21.0[src]

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

Compares and returns the minimum of two values. Read more

1.50.0[src]

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval. Read more

impl ParentClassIs for ModelButton

type Parent = Button

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

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

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

1.0.0[src]

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

This method tests for !=.

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

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

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

1.0.0[src]

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

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

1.0.0[src]

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

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

1.0.0[src]

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

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

1.0.0[src]

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

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

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

impl StructuralEq for ModelButton

Auto Trait Implementations

impl RefUnwindSafe for ModelButton

impl !Send for ModelButton

impl !Sync for ModelButton

impl Unpin for ModelButton

impl UnwindSafe for ModelButton

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized,

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> Cast for T where
    T: ObjectType,

fn upcast<T>(self) -> T where
    Self: IsA<T>,
    T: ObjectType,

Upcasts an object to a superclass or interface T. Read more

fn upcast_ref<T>(&self) -> &T where
    Self: IsA<T>,
    T: ObjectType,

Upcasts an object to a reference of its superclass or interface T. Read more

fn downcast<T>(self) -> Result<T, Self> where
    Self: CanDowncast<T>,
    T: ObjectType,

Tries to downcast to a subclass or interface implementor T. Read more

fn downcast_ref<T>(&self) -> Option<&T> where
    Self: CanDowncast<T>,
    T: ObjectType,

Tries to downcast to a reference of its subclass or interface implementor T. Read more

fn dynamic_cast<T>(self) -> Result<T, Self> where
    T: ObjectType,

Tries to cast to an object of type T. This handles upcasting, downcasting and casting between interface and interface implementors. All checks are performed at runtime, while downcast and upcast will do many checks at compile-time already. Read more

fn dynamic_cast_ref<T>(&self) -> Option<&T> where
    T: ObjectType,

Tries to cast to reference to an object of type T. This handles upcasting, downcasting and casting between interface and interface implementors. All checks are performed at runtime, while downcast and upcast will do many checks at compile-time already. Read more

unsafe fn unsafe_cast<T>(self) -> T where
    T: ObjectType,

Casts to T unconditionally. Read more

unsafe fn unsafe_cast_ref<T>(&self) -> &T where
    T: ObjectType,

Casts to &T unconditionally. Read more

impl<T> From<T> for T

pub fn from(t: T) -> T

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>,

pub fn into(self) -> U

Performs the conversion.

impl<T> ObjectExt for T where
    T: ObjectType,

pub fn is<U>(&self) -> bool where
    U: StaticType,

Returns true if the object is an instance of (can be cast to) T.

pub fn type_(&self) -> Type

pub fn object_class(&self) -> &Class<Object>

pub fn class(&self) -> &Class<T> where
    T: IsClass,

pub fn class_of<U>(&self) -> Option<&Class<U>> where
    U: IsClass,

pub fn interface<U>(&self) -> Option<InterfaceRef<'_, U>> where
    U: IsInterface,

pub fn set_properties(
    &self, 
    property_values: &[(&str, &dyn ToValue)]
) -> Result<(), BoolError>

pub fn set_properties_from_value(
    &self, 
    property_values: &[(&str, Value)]
) -> Result<(), BoolError>

pub fn set_property<'a, N, V>(
    &self, 
    property_name: N, 
    value: V
) -> Result<(), BoolError> where
    V: ToValue,
    N: Into<&'a str>,

pub fn set_property_from_value<'a, N>(
    &self, 
    property_name: N, 
    value: &Value
) -> Result<(), BoolError> where
    N: Into<&'a str>,

pub fn property<'a, N>(&self, property_name: N) -> Result<Value, BoolError> where
    N: Into<&'a str>,

pub unsafe fn set_qdata<QD>(&self, key: Quark, value: QD) where
    QD: 'static,

Safety Read more

pub unsafe fn qdata<QD>(&self, key: Quark) -> Option<NonNull<QD>> where
    QD: 'static,

Safety Read more

pub unsafe fn steal_qdata<QD>(&self, key: Quark) -> Option<QD> where
    QD: 'static,

Safety Read more

pub unsafe fn set_data<QD>(&self, key: &str, value: QD) where
    QD: 'static,

Safety Read more

pub unsafe fn data<QD>(&self, key: &str) -> Option<NonNull<QD>> where
    QD: 'static,

Safety Read more

pub unsafe fn steal_data<QD>(&self, key: &str) -> Option<QD> where
    QD: 'static,

Safety Read more

pub fn block_signal(&self, handler_id: &SignalHandlerId)

pub fn unblock_signal(&self, handler_id: &SignalHandlerId)

pub fn stop_signal_emission(&self, signal_name: &str)

pub fn disconnect(&self, handler_id: SignalHandlerId)

pub fn connect_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId where
    F: 'static + Fn(&T, &ParamSpec) + Send + Sync,

pub fn connect_notify_local<F>(
    &self, 
    name: Option<&str>, 
    f: F
) -> SignalHandlerId where
    F: 'static + Fn(&T, &ParamSpec),

pub unsafe fn connect_notify_unsafe<F>(
    &self, 
    name: Option<&str>, 
    f: F
) -> SignalHandlerId where
    F: Fn(&T, &ParamSpec),

pub fn notify<'a, N>(&self, property_name: N) where
    N: Into<&'a str>,

pub fn notify_by_pspec(&self, pspec: &ParamSpec)

pub fn has_property<'a, N>(&self, property_name: N, type_: Option<Type>) -> bool where
    N: Into<&'a str>,

pub fn property_type<'a, N>(&self, property_name: N) -> Option<Type> where
    N: Into<&'a str>,

pub fn find_property<'a, N>(&self, property_name: N) -> Option<ParamSpec> where
    N: Into<&'a str>,

pub fn list_properties(&self) -> Vec<ParamSpec, Global>

pub fn freeze_notify(&self) -> PropertyNotificationFreezeGuard

pub fn connect<'a, N, F>(
    &self, 
    signal_name: N, 
    after: bool, 
    callback: F
) -> Result<SignalHandlerId, BoolError> where
    F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static,
    N: Into<&'a str>,

pub fn connect_id<F>(
    &self, 
    signal_id: SignalId, 
    details: Option<Quark>, 
    after: bool, 
    callback: F
) -> Result<SignalHandlerId, BoolError> where
    F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static,

Same as connect but takes a SignalId instead of a signal name.

pub fn connect_local<'a, N, F>(
    &self, 
    signal_name: N, 
    after: bool, 
    callback: F
) -> Result<SignalHandlerId, BoolError> where
    F: Fn(&[Value]) -> Option<Value> + 'static,
    N: Into<&'a str>,

pub fn connect_local_id<F>(
    &self, 
    signal_id: SignalId, 
    details: Option<Quark>, 
    after: bool, 
    callback: F
) -> Result<SignalHandlerId, BoolError> where
    F: Fn(&[Value]) -> Option<Value> + 'static,

Same as connect_local but takes a SignalId instead of a signal name.

pub unsafe fn connect_unsafe<'a, N, F>(
    &self, 
    signal_name: N, 
    after: bool, 
    callback: F
) -> Result<SignalHandlerId, BoolError> where
    F: Fn(&[Value]) -> Option<Value>,
    N: Into<&'a str>,

pub unsafe fn connect_unsafe_id<F>(
    &self, 
    signal_id: SignalId, 
    details: Option<Quark>, 
    after: bool, 
    callback: F
) -> Result<SignalHandlerId, BoolError> where
    F: Fn(&[Value]) -> Option<Value>,

Same as connect_unsafe but takes a SignalId instead of a signal name.

pub fn emit(
    &self, 
    signal_id: SignalId, 
    args: &[&dyn ToValue]
) -> Result<Option<Value>, BoolError>

Emit signal by signal id.

pub fn emit_with_details(
    &self, 
    signal_id: SignalId, 
    details: Quark, 
    args: &[&dyn ToValue]
) -> Result<Option<Value>, BoolError>

Emit signal with details by signal id.

pub fn emit_by_name<'a, N>(
    &self, 
    signal_name: N, 
    args: &[&dyn ToValue]
) -> Result<Option<Value>, BoolError> where
    N: Into<&'a str>,

Emit signal by it’s name.

pub fn downgrade(&self) -> WeakRef<T>

pub fn bind_property<'a, O, N, M>(
    &'a self, 
    source_property: N, 
    target: &'a O, 
    target_property: M
) -> BindingBuilder<'a> where
    O: ObjectType,
    N: Into<&'a str>,
    M: Into<&'a str>,

pub fn ref_count(&self) -> u32

pub fn emit_with_values(
    &self, 
    signal_id: SignalId, 
    args: &[Value]
) -> Result<Option<Value>, BoolError>

Same as emit but takes Value for the arguments.

pub fn emit_by_name_with_values<'a, N>(
    &self, 
    signal_name: N, 
    args: &[Value]
) -> Result<Option<Value>, BoolError> where
    N: Into<&'a str>,

Same as emit_by_name but takes Value for the arguments.

pub fn emit_with_details_and_values(
    &self, 
    signal_id: SignalId, 
    details: Quark, 
    args: &[Value]
) -> Result<Option<Value>, BoolError>

Same as emit_with_details but takes Value for the arguments.

impl<T> ToOwned for T where
    T: Clone,

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToSendValue for T where
    T: Send + ToValue + ?Sized,

pub fn to_send_value(&self) -> SendValue

Returns a SendValue clone of self.

impl<T> ToString for T where
    T: Display + ?Sized,

pub default fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T where
    U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<Super, Sub> CanDowncast<Sub> for Super where
    Sub: IsA<Super>,
    Super: IsA<Super>,

impl<'a, T, C> FromValueOptional<'a> for T where
    C: ValueTypeChecker<Error = ValueTypeMismatchOrNoneError>,
    T: FromValue<'a, Checker = C>,