Struct dazzle::ShortcutController

pub struct ShortcutController { /* private fields */ }

Properties

context

Readable

current-chord

Readable

manager

Readable | Writeable

widget

Readable | Writeable | Construct Only

Signals

reset

This signal is emitted when the shortcut controller is requesting the widget to reset any state it may have regarding the shortcut controller. Such an example might be a modal system that lives outside the controller whose state should be cleared in response to the controller changing modes.

Action

set-context-named

This changes the current context on the ShortcutController to be the context matching name. This is found by looking up the context by name in the active ShortcutTheme.

Action

Implements

glib::ObjectExt

Implementations

impl ShortcutController

pub fn new(widget: &impl IsA<Widget>) -> ShortcutController

pub fn add_command_action( &self, command_id: &str, default_accel: &str, phase: ShortcutPhase, action: &str )

pub fn add_command_callback<P: Fn(&Widget) + 'static>( &self, command_id: &str, default_accel: &str, phase: ShortcutPhase, callback: P )

pub fn execute_command(&self, command: &str) -> bool

This method will locate and execute the command matching the id command.

If the command is not found, false is returned.

command

the id of the command

Returns

true if the command was found and executed.

pub fn context(&self) -> Option<ShortcutContext>

Available on crate feature v3_26 only.

This function gets the context property, which is the current context to dispatch events to. An ShortcutContext is a group of keybindings that may be activated in response to a single or series of [gdk::EventKey][crate::gdk::EventKey].

Returns

A ShortcutContext or None.

pub fn context_for_phase(&self, phase: ShortcutPhase) -> Option<ShortcutContext>

Available on crate feature v3_26 only.

Controllers can have a different context for a particular phase, which allows them to activate different keybindings depending if the event in capture, bubble, or dispatch.

phase

the phase for the shorcut delivery

Returns

A ShortcutContext or None.

pub fn manager(&self) -> Option<ShortcutManager>

Gets the ShortcutManager associated with this controller.

Generally, this will look for the root controller’s manager as mixing and matching managers in a single window hierarchy is not supported.

Returns

A ShortcutManager.

pub fn widget(&self) -> Option<Widget>

Available on crate feature v3_34 only.

Returns

the widget for the controller

pub fn remove_accel(&self, accel: &str, phase: ShortcutPhase)

pub fn set_context_by_name(&self, name: Option<&str>)

Available on crate feature v3_26 only.

Changes the context for the controller to the context matching name.

Contexts are resolved at runtime through the current theme (and possibly a parent theme if it inherits from one).

name

The name of the context

pub fn set_manager(&self, manager: Option<&impl IsA<ShortcutManager>>)

Sets the manager property.

If you set this to None, it will revert to the default ShortcutManager for the process.

manager

A ShortcutManager or None

pub fn get_property_context(&self) -> Option<ShortcutContext>

pub fn get_property_widget(&self) -> Option<Widget>

pub fn find(widget: &impl IsA<Widget>) -> Option<ShortcutController>

Finds the registered ShortcutController for a widget.

The controller is created if it does not already exist.

Returns

An ShortcutController or None.

pub fn try_find(widget: &impl IsA<Widget>) -> Option<ShortcutController>

Finds the registered ShortcutController for a widget.

If no controller is found, None is returned.

Returns

An ShortcutController or None.

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

This signal is emitted when the shortcut controller is requesting the widget to reset any state it may have regarding the shortcut controller. Such an example might be a modal system that lives outside the controller whose state should be cleared in response to the controller changing modes.

pub fn emit_reset(&self)

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

This changes the current context on the ShortcutController to be the context matching name. This is found by looking up the context by name in the active ShortcutTheme.

name

The name of the context

pub fn emit_set_context_named(&self, name: &str)

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

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

pub fn connect_manager_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 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) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for ShortcutController

type Parent = Object

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