Struct EventControllerKey

pub struct EventControllerKey { /* private fields */ }

EventControllerKey is an event controller that provides access to key events.

Signals

im-update

Emitted whenever the input method context filters away a keypress and prevents the @controller receiving it.

See EventControllerKey::set_im_context() and IMContextExt::filter_keypress().

key-pressed

Emitted whenever a key is pressed.

key-released

Emitted whenever a key is released.

modifiers

Emitted whenever the state of modifier keys and pointer buttons change.

Implements

EventControllerExt, [trait@glib::ObjectExt]

GLib type: GObject with reference counted clone semantics.

Implementations

impl EventControllerKey

pub fn new() -> EventControllerKey

Creates a new event controller that will handle key events.

Returns

a new EventControllerKey

pub fn builder() -> EventControllerKeyBuilder

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

This method returns an instance of EventControllerKeyBuilder which can be used to create EventControllerKey objects.

pub fn forward(&self, widget: &impl IsA<Widget>) -> bool

Forwards the current event of this @self to a @widget.

This function can only be used in handlers for the key-pressed, key-released or modifiers signals.

widget

a Widget

Returns

whether the @widget handled the event

pub fn group(&self) -> u32

Gets the key group of the current event of this @self.

See Gdk::KeyEvent::get_layout().

Returns

the key group

pub fn im_context(&self) -> Option<IMContext>

Gets the input method context of the key @self.

Returns

the IMContext

pub fn set_im_context(&self, im_context: Option<&impl IsA<IMContext>>)

Sets the input method context of the key @self.

im_context

a IMContext

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

Emitted whenever the input method context filters away a keypress and prevents the @controller receiving it.

See set_im_context() and IMContextExt::filter_keypress().

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

Emitted whenever the state of modifier keys and pointer buttons change.

state

the bitmask, representing the new state of modifier keys and pointer buttons.

Returns

whether to ignore modifiers

impl EventControllerKey

pub fn connect_key_pressed<F: Fn(&EventControllerKey, Key, u32, ModifierType) -> Propagation + 'static>( &self, f: F, ) -> SignalHandlerId

Emitted whenever a key is pressed.

keyval

the pressed key.

keycode

the raw code of the pressed key.

state

the bitmask, representing the state of modifier keys and pointer buttons.

Returns

true if the key press was handled, false otherwise.

pub fn connect_key_released<F: Fn(&EventControllerKey, Key, u32, ModifierType) + 'static>( &self, f: F, ) -> SignalHandlerId

Emitted whenever a key is released.

keyval

the released key.

keycode

the raw code of the released key.

state

the bitmask, representing the state of modifier keys and pointer buttons.

Trait Implementations

impl Clone for EventControllerKey

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for EventControllerKey

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

Formats the value using the given formatter.

impl Default for EventControllerKey

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for EventControllerKey

type ParamSpec = ParamSpecObject

type SetValue = EventControllerKey

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for EventControllerKey

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

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 EventControllerKey

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

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,

Restrict a value to a certain interval.

impl ParentClassIs for EventControllerKey

type Parent = EventController

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

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for EventControllerKey

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for EventControllerKey

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for EventControllerKey

impl IsA<EventController> for EventControllerKey