Struct gtk4::Shortcut

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

A Shortcut describes a keyboard shortcut.

It contains a description of how to trigger the shortcut via a ShortcutTrigger and a way to activate the shortcut on a widget via a ShortcutAction.

The actual work is usually done via ShortcutController, which decides if and when to activate a shortcut. Using that controller directly however is rarely necessary as various higher level convenience APIs exist on Widgets that make it easier to use shortcuts in GTK.

Shortcut does provide functionality to make it easy for users to work with shortcuts, either by providing informational strings for display purposes or by allowing shortcuts to be configured.

Implements

glib::ObjectExt

Implementations

impl Shortcut

pub fn new( trigger: Option<&impl IsA<ShortcutTrigger>>, action: Option<&impl IsA<ShortcutAction>> ) -> Shortcut

Creates a new Shortcut that is triggered by @trigger and then activates @action.

trigger

The trigger that will trigger the shortcut

action

The action that will be activated upon triggering

Returns

a new Shortcut

pub fn builder() -> ShortcutBuilder

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

This method returns an instance of ShortcutBuilder which can be used to create Shortcut objects.

pub fn action(&self) -> Option<ShortcutAction>

Gets the action that is activated by this shortcut.

Returns

the action

pub fn arguments(&self) -> Option<Variant>

Gets the arguments that are passed when activating the shortcut.

Returns

the arguments

pub fn trigger(&self) -> Option<ShortcutTrigger>

Gets the trigger used to trigger @self.

Returns

the trigger used

pub fn set_action(&self, action: Option<&impl IsA<ShortcutAction>>)

Sets the new action for @self to be @action.

action

The new action. If the @action is None, the nothing action will be used.

pub fn set_arguments(&self, args: Option<&Variant>)

Sets the arguments to pass when activating the shortcut.

args

arguments to pass when activating @self

pub fn set_trigger(&self, trigger: Option<&impl IsA<ShortcutTrigger>>)

Sets the new trigger for @self to be @trigger.

trigger

The new trigger. If the @trigger is None, the never trigger will be used.

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

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

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

impl Shortcut

pub fn with_arguments( trigger: Option<&impl IsA<ShortcutTrigger>>, action: Option<&impl IsA<ShortcutAction>>, args: &Variant ) -> Self

Creates a new Shortcut that is triggered by @trigger and then activates @action with arguments given by @format_string.

trigger

The trigger that will trigger the shortcut

action

The action that will be activated upon triggering

format_string

GVariant format string for arguments or None for no arguments

Returns

a new Shortcut

Trait Implementations

impl Clone for Shortcut

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 Shortcut

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

Formats the value using the given formatter.

impl Default for Shortcut

fn default() -> Self

Returns the “default value” for a type.

impl Display for Shortcut

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

Formats the value using the given formatter.

impl Hash for Shortcut

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 Shortcut

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 Shortcut

type Parent = Object

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

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 Shortcut

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 Shortcut

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Shortcut