Struct gtk4::ShortcutAction

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

ShortcutAction encodes an action that can be triggered by a keyboard shortcut.

GtkShortcutActions contain functions that allow easy presentation to end users as well as being printed for debugging.

All GtkShortcutActions are immutable, you can only specify their properties during construction. If you want to change a action, you have to replace it with a new one. If you need to pass arguments to an action, these are specified by the higher-level Shortcut object.

To activate a ShortcutAction manually, ShortcutActionExt::activate() can be called.

GTK provides various actions:

• MnemonicAction: a shortcut action that calls gtk_widget_mnemonic_activate()
• CallbackAction: a shortcut action that invokes a given callback
• SignalAction: a shortcut action that emits a given signal
• ActivateAction: a shortcut action that calls gtk_widget_activate()
• NamedAction: a shortcut action that calls gtk_widget_activate_action()
• NothingAction: a shortcut action that does nothing

This is an Abstract Base Class, you cannot instantiate it.

Implements

ShortcutActionExt, glib::ObjectExt

Implementations

impl ShortcutAction

pub const NONE: Option<&'static ShortcutAction> = None

pub fn parse_string(string: &str) -> Option<ShortcutAction>

Tries to parse the given string into an action.

On success, the parsed action is returned. When parsing failed, None is returned.

The accepted strings are:

• nothing, for NothingAction
• activate, for ActivateAction
• mnemonic-activate, for MnemonicAction
• action(NAME), for a NamedAction for the action named NAME
• signal(NAME), for a SignalAction for the signal NAME

string

the string to parse

Returns

a new ShortcutAction

Trait Implementations

impl Clone for ShortcutAction

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ShortcutAction

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

Formats the value using the given formatter.

impl Display for ShortcutAction

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

Formats the value using the given formatter.

impl HasParamSpec for ShortcutAction

type ParamSpec = ParamSpecObject

type SetValue = ShortcutAction

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, ShortcutAction>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for ShortcutAction

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ShortcutAction

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl ParentClassIs for ShortcutAction

type Parent = Object

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

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

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

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 ShortcutAction

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

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

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

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

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

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

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

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

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 ShortcutAction

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for ShortcutAction

impl IsA<ShortcutAction> for ActivateAction

impl IsA<ShortcutAction> for CallbackAction

impl IsA<ShortcutAction> for MnemonicAction

impl IsA<ShortcutAction> for NamedAction

impl IsA<ShortcutAction> for NothingAction

impl IsA<ShortcutAction> for SignalAction