Struct android_activity::input::KeyEvent

pub struct KeyEvent { /* private fields */ }

A key event

Wraps an AInputEvent * of the [ffi::AINPUT_EVENT_TYPE_KEY] type.

For general discussion of key events in Android, see the relevant javadoc.

Implementations

impl KeyEvent

pub unsafe fn from_ptr(ptr: NonNull<AInputEvent>) -> KeyEvent

Constructs a KeyEvent from a pointer to a native [ffi::AInputEvent]

Safety

By calling this method, you assert that the pointer is a valid, non-null pointer to an [ffi::AInputEvent], and that [ffi::AInputEvent] is an AKeyEvent.

pub fn ptr(&self) -> NonNull<AInputEvent>

Returns a pointer to the native [ffi::AInputEvent]

pub fn action(&self) -> KeyAction

Returns the key action represented by this event.

See the NDK docs

pub fn source(&self) -> Source

Get the source of the event.

See the NDK docs

pub fn device_id(&self) -> i32

Get the device id associated with the event.

See the NDK docs

pub fn down_time(&self) -> i64

Returns the last time the key was pressed. This is on the scale of java.lang.System.nanoTime(), which has nanosecond precision, but no defined start time.

See the NDK docs

pub fn event_time(&self) -> i64

Returns the time this event occured. This is on the scale of java.lang.System.nanoTime(), which has nanosecond precision, but no defined start time.

See the NDK docs

pub fn key_code(&self) -> Keycode

Returns the keycode associated with this key event

See the NDK docs

pub fn repeat_count(&self) -> i32

Returns the number of repeats of a key.

See the NDK docs

pub fn scan_code(&self) -> i32

Returns the hardware keycode of a key. This varies from device to device.

See the NDK docs

impl KeyEvent

pub fn flags(&self) -> KeyEventFlags

Flags associated with this KeyEvent.

See the NDK docs

pub fn meta_state(&self) -> MetaState

Returns the state of the modifiers during this key event, represented by a bitmask.

See the NDK docs

Trait Implementations

impl Debug for KeyEvent

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

Formats the value using the given formatter.