Struct EventControllerKey 

pub struct EventControllerKey { /* private fields */ }

Available on crate feature v3_24 only.

EventControllerKey is an event controller meant for situations where you need access to key events.

This object was added in 3.24.

Signals

focus-in

focus-out

im-update

key-pressed

This signal is emitted whenever a key is pressed.

key-released

This signal is emitted whenever a key is released.

modifiers

Implements

EventControllerExt, [trait@glib::ObjectExt]

GLib type: GObject with reference counted clone semantics.

Implementations

impl EventControllerKey

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

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

pub fn group(&self) -> u32

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

Gets the IM context of a key controller.

Returns

the IM context

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

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

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

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

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

This signal is 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. See gdk::ModifierType.

Returns

true if the key press was handled, false otherwise.

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

This signal is 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. See gdk::ModifierType.

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

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 Eq for EventControllerKey

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 IsA<EventController> for EventControllerKey

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

Inequality operator !=.

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.