Struct gtk4::ShortcutTrigger

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

ShortcutTrigger tracks how a Shortcut should be activated.

To find out if a ShortcutTrigger triggers, you can call ShortcutTriggerExt::trigger() on a gdk::Event.

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

All GtkShortcutTriggers are immutable, you can only specify their properties during construction. If you want to change a trigger, you have to replace it with a new one.

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

Implements

ShortcutTriggerExt, glib::ObjectExt, ShortcutTriggerExtManual

Implementations

impl ShortcutTrigger

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

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

Tries to parse the given string into a trigger.

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

The accepted strings are:

• never, for NeverTrigger
• a string parsed by gtk_accelerator_parse(), for a KeyvalTrigger, e.g. <Control>C
• underscore, followed by a single character, for MnemonicTrigger, e.g. _l
• two valid trigger strings, separated by a | character, for a AlternativeTrigger: <Control>q|<Control>w

Note that you will have to escape the < and > characters when specifying triggers in XML files, such as GtkBuilder ui files. Use < instead of < and > instead of >.

string

the string to parse

Returns

a new ShortcutTrigger

Trait Implementations

impl Clone for ShortcutTrigger

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 ShortcutTrigger

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

Formats the value using the given formatter.

impl Display for ShortcutTrigger

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

Formats the value using the given formatter.

impl HasParamSpec for ShortcutTrigger

type ParamSpec = ParamSpecObject

type SetValue = ShortcutTrigger

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for ShortcutTrigger

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 ShortcutTrigger

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 ShortcutTrigger

type Parent = Object

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

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 ShortcutTrigger

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 ShortcutTrigger

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for ShortcutTrigger

impl IsA<ShortcutTrigger> for AlternativeTrigger

impl IsA<ShortcutTrigger> for KeyvalTrigger

impl IsA<ShortcutTrigger> for MnemonicTrigger

impl IsA<ShortcutTrigger> for NeverTrigger