Struct gtk4::ShortcutsShortcut

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

A ShortcutsShortcut represents a single keyboard shortcut or gesture with a short text.

This widget is only meant to be used with ShortcutsWindow.

Implements

WidgetExt, glib::ObjectExt, AccessibleExt, BuildableExt, ConstraintTargetExt, WidgetExtManual, AccessibleExtManual

Implementations

impl ShortcutsShortcut

pub fn builder() -> ShortcutsShortcutBuilder

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

This method returns an instance of ShortcutsShortcutBuilder which can be used to create ShortcutsShortcut objects.

pub fn set_accel_size_group(&self, accel_size_group: Option<&SizeGroup>)

The size group for the accelerator portion of this shortcut.

This is used internally by GTK, and must not be modified by applications.

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

The accelerator(s) represented by this object.

This property is used if property::ShortcutsShortcut::shortcut-type is set to ShortcutType::Accelerator.

The syntax of this property is (an extension of) the syntax understood by accelerator_parse(). Multiple accelerators can be specified by separating them with a space, but keep in mind that the available width is limited.

It is also possible to specify ranges of shortcuts, using “…” between the keys. Sequences of keys can be specified using a “+” or “&” between the keys.

Examples:

• A single shortcut: delete
• Two alternative shortcuts: a Home
• A range of shortcuts: 1…9
• Several keys pressed together: Control_L&Control_R
• A sequence of shortcuts or keys: c+x

Use “+” instead of “&” when the keys may (or have to be) pressed sequentially (e.g use “t+t” for ‘press the t key twice’).

Note that <, > and & need to be escaped as <, > and & when used in .ui files.

pub fn set_accelerator(&self, accelerator: Option<&str>)

The accelerator(s) represented by this object.

This property is used if property::ShortcutsShortcut::shortcut-type is set to ShortcutType::Accelerator.

The syntax of this property is (an extension of) the syntax understood by accelerator_parse(). Multiple accelerators can be specified by separating them with a space, but keep in mind that the available width is limited.

It is also possible to specify ranges of shortcuts, using “…” between the keys. Sequences of keys can be specified using a “+” or “&” between the keys.

Examples:

• A single shortcut: delete
• Two alternative shortcuts: a Home
• A range of shortcuts: 1…9
• Several keys pressed together: Control_L&Control_R
• A sequence of shortcuts or keys: c+x

Use “+” instead of “&” when the keys may (or have to be) pressed sequentially (e.g use “t+t” for ‘press the t key twice’).

Note that <, > and & need to be escaped as <, > and & when used in .ui files.

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

A detailed action name.

If this is set for a shortcut of type ShortcutType::Accelerator, then GTK will use the accelerators that are associated with the action via GtkApplicationExt::set_accels_for_action(), and setting property::ShortcutsShortcut::accelerator is not necessary.

pub fn set_action_name(&self, action_name: Option<&str>)

A detailed action name.

If this is set for a shortcut of type ShortcutType::Accelerator, then GTK will use the accelerators that are associated with the action via GtkApplicationExt::set_accels_for_action(), and setting property::ShortcutsShortcut::accelerator is not necessary.

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

An icon to represent the shortcut or gesture.

This property is used if property::ShortcutsShortcut::shortcut-type is set to ShortcutType::Gesture.

For the other predefined gesture types, GTK provides an icon on its own.

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

An icon to represent the shortcut or gesture.

This property is used if property::ShortcutsShortcut::shortcut-type is set to ShortcutType::Gesture.

For the other predefined gesture types, GTK provides an icon on its own.

pub fn is_icon_set(&self) -> bool

true if an icon has been set.

pub fn shortcut_type(&self) -> ShortcutType

The type of shortcut that is represented.

pub fn set_shortcut_type(&self, shortcut_type: ShortcutType)

The type of shortcut that is represented.

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

The subtitle for the shortcut or gesture.

This is typically used for gestures and should be a short, one-line text that describes the gesture itself. For the predefined gesture types, GTK provides a subtitle on its own.

pub fn set_subtitle(&self, subtitle: Option<&str>)

The subtitle for the shortcut or gesture.

This is typically used for gestures and should be a short, one-line text that describes the gesture itself. For the predefined gesture types, GTK provides a subtitle on its own.

pub fn is_subtitle_set(&self) -> bool

true if a subtitle has been set.

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

The textual description for the shortcut or gesture represented by this object.

This should be a short string that can fit in a single line.

pub fn set_title(&self, title: Option<&str>)

The textual description for the shortcut or gesture represented by this object.

This should be a short string that can fit in a single line.

pub fn set_title_size_group(&self, title_size_group: Option<&SizeGroup>)

The size group for the textual portion of this shortcut.

This is used internally by GTK, and must not be modified by applications.

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

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

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

pub fn connect_direction_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_icon_set_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

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

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

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

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

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

Trait Implementations

impl Clone for ShortcutsShortcut

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 ShortcutsShortcut

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

Formats the value using the given formatter.

impl Display for ShortcutsShortcut

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

Formats the value using the given formatter.

impl Hash for ShortcutsShortcut

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 ShortcutsShortcut

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 ShortcutsShortcut

type Parent = Widget

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

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 ShortcutsShortcut

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 ShortcutsShortcut

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for ShortcutsShortcut

impl IsA<Accessible> for ShortcutsShortcut

impl IsA<Buildable> for ShortcutsShortcut

impl IsA<ConstraintTarget> for ShortcutsShortcut

impl IsA<Widget> for ShortcutsShortcut