Struct android_activity::input::KeyCharacterMap

pub struct KeyCharacterMap { /* private fields */ }

Describes the keys provided by a keyboard device and their associated labels.

Implementations

impl KeyCharacterMap

pub fn get( &self, key_code: Keycode, meta_state: MetaState ) -> Result<KeyMapChar, AppError>

Gets the Unicode character generated by the specified Keycode and MetaState combination.

Returns KeyMapChar::None if the key is not one that is used to type Unicode characters.

Returns KeyMapChar::CombiningAccent if the key is a “dead key” that should be combined with another to actually produce a character – see KeyCharacterMap::get_dead_char.

Errors

Since this API needs to use JNI internally to call into the Android JVM it may return a AppError::JavaError in case there is a spurious JNI error or an exception is caught.

pub fn get_dead_char( &self, accent_char: char, base_char: char ) -> Result<Option<char>, AppError>

Get the character that is produced by combining the dead key producing accent with the key producing character c.

For example, get_dead_char('`', 'e') returns ‘è’. get_dead_char('^', ' ') returns ‘^’ and get_dead_char('^', '^') returns ‘^’.

Errors

Since this API needs to use JNI internally to call into the Android JVM it may return a AppError::JavaError in case there is a spurious JNI error or an exception is caught.

pub fn get_keyboard_type(&self) -> Result<KeyboardType, AppError>

Gets the keyboard type.

Different keyboard types have different semantics. See KeyboardType for details.

Errors

Since this API needs to use JNI internally to call into the Android JVM it may return a AppError::JavaError in case there is a spurious JNI error or an exception is caught.

Trait Implementations

impl Clone for KeyCharacterMap

fn clone(&self) -> KeyCharacterMap

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyCharacterMap

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

Formats the value using the given formatter.