Struct gtk4::ShortcutController

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

ShortcutController is an event controller that manages shortcuts.

Most common shortcuts are using this controller implicitly, e.g. by adding a mnemonic underline to a Label, or by installing a key binding using WidgetClassExt::add_binding(), or by adding accelerators to global actions using GtkApplicationExt::set_accels_for_action().

But it is possible to create your own shortcut controller, and add shortcuts to it.

ShortcutController implements gio::ListModel for querying the shortcuts that have been added to it.

GtkShortcutController as GtkBuildable

ShortcutControllers can be created in Builder ui files, to set up shortcuts in the same place as the widgets.

An example of a UI definition fragment with ShortcutController:

  <object class='GtkButton'>
    <child>
      <object class='GtkShortcutController'>
        <property name='scope'>managed</property>
        <child>
          <object class='GtkShortcut'>
            <property name='trigger'>&lt;Control&gt;k</property>
            <property name='action'>activate</property>
          </object>
        </child>
      </object>
    </child>
  </object>

This example creates a ActivateAction for triggering the activate signal of the Button. See ShortcutAction::parse_string() for the syntax for other kinds of ShortcutAction. See ShortcutTrigger::parse_string() to learn more about the syntax for triggers.

Properties

item-type

The type of items. See [ListModelExtManual::item_type()][crate::gio::prelude::ListModelExtManual::item_type()].

Readable

mnemonic-modifiers

The modifiers that need to be pressed to allow mnemonics activation.

Readable | Writeable

model

A list model to take shortcuts from.

Writeable | Construct Only

n-items

The number of items. See [ListModelExtManual::n_items()][crate::gio::prelude::ListModelExtManual::n_items()].

Readable

scope

What scope the shortcuts will be handled in.

Readable | Writeable

EventController

name

The name for this controller, typically used for debugging purposes.

Readable | Writeable

propagation-limit

The limit for which events this controller will handle.

Readable | Writeable

propagation-phase

The propagation phase at which this controller will handle events.

Readable | Writeable

widget

The widget receiving the GdkEvents that the controller will handle.

Readable

Implements

EventControllerExt, glib::ObjectExt, gio::prelude::ListModelExt, BuildableExt

Implementations

impl ShortcutController

pub fn new() -> ShortcutController

Creates a new shortcut controller.

Returns

a newly created shortcut controller

pub fn for_model(model: &impl IsA<ListModel>) -> ShortcutController

Creates a new shortcut controller that takes its shortcuts from the given list model.

A controller created by this function does not let you add or remove individual shortcuts using the shortcut controller api, but you can change the contents of the model.

model

a GListModel containing shortcuts

Returns

a newly created shortcut controller

pub fn add_shortcut(&self, shortcut: Shortcut)

Adds @shortcut to the list of shortcuts handled by @self.

If this controller uses an external shortcut list, this function does nothing.

shortcut

a Shortcut

pub fn mnemonics_modifiers(&self) -> ModifierType

Gets the mnemonics modifiers for when this controller activates its shortcuts.

Returns

the controller’s mnemonics modifiers

pub fn scope(&self) -> ShortcutScope

Gets the scope for when this controller activates its shortcuts.

See set_scope() for details.

Returns

the controller’s scope

pub fn remove_shortcut(&self, shortcut: &Shortcut)

Removes @shortcut from the list of shortcuts handled by @self.

If @shortcut had not been added to @controller or this controller uses an external shortcut list, this function does nothing.

shortcut

a Shortcut

pub fn set_mnemonics_modifiers(&self, modifiers: ModifierType)

Sets the controller to use the given modifier for mnemonics.

The mnemonics modifiers determines which modifiers need to be pressed to allow activation of shortcuts with mnemonics triggers.

GTK normally uses the Alt modifier for mnemonics, except in PopoverMenus, where mnemonics can be triggered without any modifiers. It should be very rarely necessary to change this, and doing so is likely to interfere with other shortcuts.

This value is only relevant for local shortcut controllers. Global and managed shortcut controllers will have their shortcuts activated from other places which have their own modifiers for activating mnemonics.

modifiers

the new mnemonics_modifiers to use

pub fn set_scope(&self, scope: ShortcutScope)

Sets the controller to have the given @scope.

The scope allows shortcuts to be activated outside of the normal event propagation. In particular, it allows installing global keyboard shortcuts that can be activated even when a widget does not have focus.

With ShortcutScope::Local, shortcuts will only be activated when the widget has focus.

scope

the new scope to use

pub fn mnemonic_modifiers(&self) -> ModifierType

The modifiers that need to be pressed to allow mnemonics activation.

pub fn set_mnemonic_modifiers(&self, mnemonic_modifiers: ModifierType)

The modifiers that need to be pressed to allow mnemonics activation.

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

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

Trait Implementations

impl Clone for ShortcutController

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 ShortcutController

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

Formats the value using the given formatter.

impl Default for ShortcutController

fn default() -> Self

Returns the “default value” for a type.

impl Display for ShortcutController

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

Formats the value using the given formatter.

impl HasParamSpec for ShortcutController

type ParamSpec = ParamSpecObject

type SetValue = ShortcutController

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for ShortcutController

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 ShortcutController

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 ShortcutController

type Parent = EventController

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

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 ShortcutController

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 ShortcutController

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for ShortcutController

impl IsA<Buildable> for ShortcutController

impl IsA<EventController> for ShortcutController

impl IsA<ListModel> for ShortcutController