1# native_key_event.h 2 3 4## Overview 5 6Declares the APIs of **NativeKeyEvent**. 7 8**Library**: libace_ndk.z.so 9 10**File to include**: <arkui/native_key_event.h> 11 12**System capability**: SystemCapability.ArkUI.ArkUI.Full 13 14**Since**: 14 15 16**Related module**: [ArkUI_NativeModule](_ark_u_i___native_module.md) 17 18 19## Summary 20 21 22### Enums 23 24| Name| Description| 25| -------- | -------- | 26| [ArkUI_KeyCode](_ark_u_i___native_module.md#arkui_keycode) {<br>[ARKUI_KEYCODE_UNKNOWN](_ark_u_i___native_module.md) = -1, [ARKUI_KEYCODE_FN](_ark_u_i___native_module.md) = 0, [ARKUI_KEYCODE_VOLUME_UP](_ark_u_i___native_module.md) = 16, [ARKUI_KEYCODE_VOLUME_DOWN](_ark_u_i___native_module.md) = 17,<br>[ARKUI_KEYCODE_POWER](_ark_u_i___native_module.md) = 18, [ARKUI_KEYCODE_CAMERA](_ark_u_i___native_module.md) = 19, [ARKUI_KEYCODE_VOLUME_MUTE](_ark_u_i___native_module.md) = 22, [ARKUI_KEYCODE_MUTE](_ark_u_i___native_module.md) = 23,<br>[ARKUI_KEYCODE_BRIGHTNESS_UP](_ark_u_i___native_module.md) = 40, [ARKUI_KEYCODE_BRIGHTNESS_DOWN](_ark_u_i___native_module.md) = 41, [ARKUI_KEYCODE_0](_ark_u_i___native_module.md) = 2000, [ARKUI_KEYCODE_1](_ark_u_i___native_module.md) = 2001,<br>[ARKUI_KEYCODE_2](_ark_u_i___native_module.md) = 2002, [ARKUI_KEYCODE_3](_ark_u_i___native_module.md) = 2003, [ARKUI_KEYCODE_4](_ark_u_i___native_module.md) = 2004, [ARKUI_KEYCODE_5](_ark_u_i___native_module.md) = 2005,<br>[ARKUI_KEYCODE_6](_ark_u_i___native_module.md) = 2006, [ARKUI_KEYCODE_7](_ark_u_i___native_module.md) = 2007, [ARKUI_KEYCODE_8](_ark_u_i___native_module.md) = 2008, [ARKUI_KEYCODE_9](_ark_u_i___native_module.md) = 2009,<br>[ARKUI_KEYCODE_STAR](_ark_u_i___native_module.md) = 2010, [ARKUI_KEYCODE_POUND](_ark_u_i___native_module.md) = 2011, [ARKUI_KEYCODE_DPAD_UP](_ark_u_i___native_module.md) = 2012, [ARKUI_KEYCODE_DPAD_DOWN](_ark_u_i___native_module.md) = 2013,<br>[ARKUI_KEYCODE_DPAD_LEFT](_ark_u_i___native_module.md) = 2014, [ARKUI_KEYCODE_DPAD_RIGHT](_ark_u_i___native_module.md) = 2015, [ARKUI_KEYCODE_DPAD_CENTER](_ark_u_i___native_module.md) = 2016, [ARKUI_KEYCODE_A](_ark_u_i___native_module.md) = 2017,<br>[ARKUI_KEYCODE_B](_ark_u_i___native_module.md) = 2018, [ARKUI_KEYCODE_C](_ark_u_i___native_module.md) = 2019, [ARKUI_KEYCODE_D](_ark_u_i___native_module.md) = 2020, [ARKUI_KEYCODE_E](_ark_u_i___native_module.md) = 2021,<br>[ARKUI_KEYCODE_F](_ark_u_i___native_module.md) = 2022, [ARKUI_KEYCODE_G](_ark_u_i___native_module.md) = 2023, [ARKUI_KEYCODE_H](_ark_u_i___native_module.md) = 2024, [ARKUI_KEYCODE_I](_ark_u_i___native_module.md) = 2025,<br>[ARKUI_KEYCODE_J](_ark_u_i___native_module.md) = 2026, [ARKUI_KEYCODE_K](_ark_u_i___native_module.md) = 2027, [ARKUI_KEYCODE_L](_ark_u_i___native_module.md) = 2028, [ARKUI_KEYCODE_M](_ark_u_i___native_module.md) = 2029,<br>[ARKUI_KEYCODE_N](_ark_u_i___native_module.md) = 2030, [ARKUI_KEYCODE_O](_ark_u_i___native_module.md) = 2031, [ARKUI_KEYCODE_P](_ark_u_i___native_module.md) = 2032, [ARKUI_KEYCODE_Q](_ark_u_i___native_module.md) = 2033,<br>[ARKUI_KEYCODE_R](_ark_u_i___native_module.md) = 2034, [ARKUI_KEYCODE_S](_ark_u_i___native_module.md) = 2035, [ARKUI_KEYCODE_T](_ark_u_i___native_module.md) = 2036, [ARKUI_KEYCODE_U](_ark_u_i___native_module.md) = 2037,<br>[ARKUI_KEYCODE_V](_ark_u_i___native_module.md) = 2038, [ARKUI_KEYCODE_W](_ark_u_i___native_module.md) = 2039, [ARKUI_KEYCODE_X](_ark_u_i___native_module.md) = 2040, [ARKUI_KEYCODE_Y](_ark_u_i___native_module.md) = 2041,<br>[ARKUI_KEYCODE_Z](_ark_u_i___native_module.md) = 2042, [ARKUI_KEYCODE_COMMA](_ark_u_i___native_module.md) = 2043, [ARKUI_KEYCODE_PERIOD](_ark_u_i___native_module.md) = 2044, [ARKUI_KEYCODE_ALT_LEFT](_ark_u_i___native_module.md) = 2045,<br>[ARKUI_KEYCODE_ALT_RIGHT](_ark_u_i___native_module.md) = 2046, [ARKUI_KEYCODE_SHIFT_LEFT](_ark_u_i___native_module.md) = 2047, [ARKUI_KEYCODE_SHIFT_RIGHT](_ark_u_i___native_module.md) = 2048, [ARKUI_KEYCODE_TAB](_ark_u_i___native_module.md) = 2049,<br>[ARKUI_KEYCODE_SPACE](_ark_u_i___native_module.md) = 2050, [ARKUI_KEYCODE_SYM](_ark_u_i___native_module.md) = 2051, [ARKUI_KEYCODE_EXPLORER](_ark_u_i___native_module.md) = 2052, [ARKUI_KEYCODE_ENVELOPE](_ark_u_i___native_module.md) = 2053,<br>[ARKUI_KEYCODE_ENTER](_ark_u_i___native_module.md) = 2054, [ARKUI_KEYCODE_DEL](_ark_u_i___native_module.md) = 2055, [ARKUI_KEYCODE_GRAVE](_ark_u_i___native_module.md) = 2056, [ARKUI_KEYCODE_MINUS](_ark_u_i___native_module.md) = 2057,<br>[ARKUI_KEYCODE_EQUALS](_ark_u_i___native_module.md) = 2058, [ARKUI_KEYCODE_LEFT_BRACKET](_ark_u_i___native_module.md) = 2059, [ARKUI_KEYCODE_RIGHT_BRACKET](_ark_u_i___native_module.md) = 2060, [ARKUI_KEYCODE_BACKSLASH](_ark_u_i___native_module.md) = 2061,<br>[ARKUI_KEYCODE_SEMICOLON](_ark_u_i___native_module.md) = 2062, [ARKUI_KEYCODE_APOSTROPHE](_ark_u_i___native_module.md) = 2063, [ARKUI_KEYCODE_SLASH](_ark_u_i___native_module.md) = 2064, [ARKUI_KEYCODE_AT](_ark_u_i___native_module.md) = 2065,<br>[ARKUI_KEYCODE_PLUS](_ark_u_i___native_module.md) = 2066, [ARKUI_KEYCODE_MENU](_ark_u_i___native_module.md) = 2067, [ARKUI_KEYCODE_PAGE_UP](_ark_u_i___native_module.md) = 2068, [ARKUI_KEYCODE_PAGE_DOWN](_ark_u_i___native_module.md) = 2069,<br>[ARKUI_KEYCODE_ESCAPE](_ark_u_i___native_module.md) = 2070, [ARKUI_KEYCODE_FORWARD_DEL](_ark_u_i___native_module.md) = 2071, [ARKUI_KEYCODE_CTRL_LEFT](_ark_u_i___native_module.md) = 2072, [ARKUI_KEYCODE_CTRL_RIGHT](_ark_u_i___native_module.md) = 2073,<br>[ARKUI_KEYCODE_CAPS_LOCK](_ark_u_i___native_module.md) = 2074, [ARKUI_KEYCODE_SCROLL_LOCK](_ark_u_i___native_module.md) = 2075, [ARKUI_KEYCODE_META_LEFT](_ark_u_i___native_module.md) = 2076, [ARKUI_KEYCODE_META_RIGHT](_ark_u_i___native_module.md) = 2077,<br>[ARKUI_KEYCODE_FUNCTION](_ark_u_i___native_module.md) = 2078, [ARKUI_KEYCODE_SYSRQ](_ark_u_i___native_module.md) = 2079, [ARKUI_KEYCODE_BREAK](_ark_u_i___native_module.md) = 2080, [ARKUI_KEYCODE_MOVE_HOME](_ark_u_i___native_module.md) = 2081,<br>[ARKUI_KEYCODE_MOVE_END](_ark_u_i___native_module.md) = 2082, [ARKUI_KEYCODE_INSERT](_ark_u_i___native_module.md) = 2083, [ARKUI_KEYCODE_FORWARD](_ark_u_i___native_module.md) = 2084, [ARKUI_KEYCODE_MEDIA_PLAY](_ark_u_i___native_module.md) = 2085,<br>[ARKUI_KEYCODE_MEDIA_PAUSE](_ark_u_i___native_module.md) = 2086, [ARKUI_KEYCODE_MEDIA_CLOSE](_ark_u_i___native_module.md) = 2087, [ARKUI_KEYCODE_MEDIA_EJECT](_ark_u_i___native_module.md) = 2088, [ARKUI_KEYCODE_MEDIA_RECORD](_ark_u_i___native_module.md) = 2089,<br>[ARKUI_KEYCODE_F1](_ark_u_i___native_module.md) = 2090, [ARKUI_KEYCODE_F2](_ark_u_i___native_module.md) = 2091, [ARKUI_KEYCODE_F3](_ark_u_i___native_module.md) = 2092, [ARKUI_KEYCODE_F4](_ark_u_i___native_module.md) = 2093,<br>[ARKUI_KEYCODE_F5](_ark_u_i___native_module.md) = 2094, [ARKUI_KEYCODE_F6](_ark_u_i___native_module.md) = 2095, [ARKUI_KEYCODE_F7](_ark_u_i___native_module.md) = 2096, [ARKUI_KEYCODE_F8](_ark_u_i___native_module.md) = 2097,<br>[ARKUI_KEYCODE_F9](_ark_u_i___native_module.md) = 2098, [ARKUI_KEYCODE_F10](_ark_u_i___native_module.md) = 2099, [ARKUI_KEYCODE_F11](_ark_u_i___native_module.md) = 2100, [ARKUI_KEYCODE_F12](_ark_u_i___native_module.md) = 2101,<br>[ARKUI_KEYCODE_NUM_LOCK](_ark_u_i___native_module.md) = 2102, [ARKUI_KEYCODE_NUMPAD_0](_ark_u_i___native_module.md) = 2103, [ARKUI_KEYCODE_NUMPAD_1](_ark_u_i___native_module.md) = 2104, [ARKUI_KEYCODE_NUMPAD_2](_ark_u_i___native_module.md) = 2105,<br>[ARKUI_KEYCODE_NUMPAD_3](_ark_u_i___native_module.md) = 2106, [ARKUI_KEYCODE_NUMPAD_4](_ark_u_i___native_module.md) = 2107, [ARKUI_KEYCODE_NUMPAD_5](_ark_u_i___native_module.md) = 2108, [ARKUI_KEYCODE_NUMPAD_6](_ark_u_i___native_module.md) = 2109,<br>[ARKUI_KEYCODE_NUMPAD_7](_ark_u_i___native_module.md) = 2110, [ARKUI_KEYCODE_NUMPAD_8](_ark_u_i___native_module.md) = 2111, [ARKUI_KEYCODE_NUMPAD_9](_ark_u_i___native_module.md) = 2112, [ARKUI_KEYCODE_NUMPAD_DIVIDE](_ark_u_i___native_module.md) = 2113,<br>[ARKUI_KEYCODE_NUMPAD_MULTIPLY](_ark_u_i___native_module.md) = 2114, [ARKUI_KEYCODE_NUMPAD_SUBTRACT](_ark_u_i___native_module.md) = 2115, [ARKUI_KEYCODE_NUMPAD_ADD](_ark_u_i___native_module.md) = 2116, [ARKUI_KEYCODE_NUMPAD_DOT](_ark_u_i___native_module.md) = 2117,<br>[ARKUI_KEYCODE_NUMPAD_COMMA](_ark_u_i___native_module.md) = 2118, [ARKUI_KEYCODE_NUMPAD_ENTER](_ark_u_i___native_module.md) = 2119, [ARKUI_KEYCODE_NUMPAD_EQUALS](_ark_u_i___native_module.md) = 2120, [ARKUI_KEYCODE_NUMPAD_LEFT_PAREN](_ark_u_i___native_module.md) = 2121,<br>[ARKUI_KEYCODE_NUMPAD_RIGHT_PAREN](_ark_u_i___native_module.md) = 2122<br>} | Enumerates the key codes for key events. | 27| [ArkUI_KeyEventType](_ark_u_i___native_module.md#arkui_keyeventtype) {<br>[ARKUI_KEY_EVENT_UNKNOWN](_ark_u_i___native_module.md) = -1, [ARKUI_KEY_EVENT_DOWN](_ark_u_i___native_module.md) = 0, [ARKUI_KEY_EVENT_UP](_ark_u_i___native_module.md) = 1, [ARKUI_KEY_EVENT_LONG_PRESS](_ark_u_i___native_module.md) = 2,<br>[ARKUI_KEY_EVENT_CLICK](_ark_u_i___native_module.md) = 3<br>} | Enumerates the types of key events. | 28| [ArkUI_KeySourceType](_ark_u_i___native_module.md#arkui_keysourcetype) { [ARKUI_KEY_SOURCE_UNKNOWN](_ark_u_i___native_module.md) = 0, [ARKUI_KEY_SOURCE_TYPE_MOUSE](_ark_u_i___native_module.md) = 1, [ARKUI_KEY_SOURCE_TYPE_KEYBOARD](_ark_u_i___native_module.md) = 4, [ARKUI_KEY_SOURCE_TYPE_JOYSTICK](_ark_u_i___native_module.md) = 5 } | Enumerates the types of input devices that trigger key events. | 29| [ArkUI_KeyIntension](_ark_u_i___native_module.md#arkui_keyintension) {<br>[ARKUI_KEY_INTENSION_UNKNOWN](_ark_u_i___native_module.md) = -1, [ARKUI_KEY_INTENSION_UP](_ark_u_i___native_module.md) = 1, [ARKUI_KEY_INTENSION_DOWN](_ark_u_i___native_module.md) = 2, [ARKUI_KEY_INTENSION_LEFT](_ark_u_i___native_module.md) = 3,<br>[ARKUI_KEY_INTENSION_RIGHT](_ark_u_i___native_module.md) = 4, [ARKUI_KEY_INTENSION_SELECT](_ark_u_i___native_module.md) = 5, [ARKUI_KEY_INTENSION_ESCAPE](_ark_u_i___native_module.md) = 6, [ARKUI_KEY_INTENSION_BACK](_ark_u_i___native_module.md) = 7,<br>[ARKUI_KEY_INTENSION_FORWARD](_ark_u_i___native_module.md) = 8, [ARKUI_KEY_INTENSION_MENU](_ark_u_i___native_module.md) = 9, [ARKUI_KEY_INTENSION_HOME](_ark_u_i___native_module.md) = 10, [ARKUI_KEY_INTENSION_PAGE_UP](_ark_u_i___native_module.md) = 11,<br>[ARKUI_KEY_INTENSION_PAGE_DOWN](_ark_u_i___native_module.md) = 12, [ARKUI_KEY_INTENSION_ZOOM_OUT](_ark_u_i___native_module.md) = 13, [ARKUI_KEY_INTENSION_ZOOM_IN](_ark_u_i___native_module.md) = 14, [ARKUI_KEY_INTENTION_MEDIA_PLAY_PAUSE](_ark_u_i___native_module.md) = 100,<br>[ARKUI_KEY_INTENTION_MEDIA_FAST_FORWARD](_ark_u_i___native_module.md) = 101, [ARKUI_KEY_INTENTION_MEDIA_FAST_PLAYBACK](_ark_u_i___native_module.md) = 103, [ARKUI_KEY_INTENTION_MEDIA_NEXT](_ark_u_i___native_module.md) = 104, [ARKUI_KEY_INTENTION_MEDIA_PREVIOUS](_ark_u_i___native_module.md) = 105,<br>[ARKUI_KEY_INTENTION_MEDIA_MUTE](_ark_u_i___native_module.md) = 106, [ARKUI_KEY_INTENTION_VOLUME_UP](_ark_u_i___native_module.md) = 107, [ARKUI_KEY_INTENTION_VOLUME_DOWN](_ark_u_i___native_module.md) = 108, [ARKUI_KEY_INTENTION_CALL](_ark_u_i___native_module.md) = 200,<br>[ARKUI_KEY_INTENTION_CAMERA](_ark_u_i___native_module.md) = 300<br>} | Enumerates the intentions corresponding to key events. | 30 31 32### Functions 33 34| Name| Description| 35| -------- | -------- | 36| [ArkUI_KeyEventType](_ark_u_i___native_module.md#arkui_keyeventtype) [OH_ArkUI_KeyEvent_GetType](_ark_u_i___native_module.md#oh_arkui_keyevent_gettype) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event) | Obtains the type of a key event. | 37| int32_t [OH_ArkUI_KeyEvent_GetKeyCode](_ark_u_i___native_module.md#oh_arkui_keyevent_getkeycode) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event) | Obtains the key code from a key event. | 38| const char \* [OH_ArkUI_KeyEvent_GetKeyText](_ark_u_i___native_module.md#oh_arkui_keyevent_getkeytext) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event) | Obtains the key value from a key event. | 39| [ArkUI_KeySourceType](_ark_u_i___native_module.md#arkui_keysourcetype) [OH_ArkUI_KeyEvent_GetKeySource](_ark_u_i___native_module.md#oh_arkui_keyevent_getkeysource) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event) | Obtains the type of input device that triggers a key event. | 40| void [OH_ArkUI_KeyEvent_StopPropagation](_ark_u_i___native_module.md#oh_arkui_keyevent_stoppropagation) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event, bool stopPropagation) | Stops a key event from bubbling upwards or downwards. | 41| [ArkUI_KeyIntension](_ark_u_i___native_module.md#arkui_keyintension) [OH_ArkUI_KeyEvent_GetKeyIntensionCode](_ark_u_i___native_module.md#oh_arkui_keyevent_getkeyintensioncode) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event) | Obtains the intention code associated with a key event. | 42| uint32_t [OH_ArkUI_KeyEvent_GetUnicode](_ark_u_i___native_module.md#oh_arkui_keyevent_getunicode) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event) | Obtains the Unicode value of a key event. Non-space basic Latin characters in the 0x0021-0x007E range are supported. Characters with a value of 0 are not supported. In the case of key combination, this API returns the Unicode value of the key corresponding to the key event. | 43| void [OH_ArkUI_KeyEvent_SetConsumed](_ark_u_i___native_module.md#oh_arkui_keyevent_setconsumed) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event, bool isConsumed) | Sets whether a key event is consumed in the key event callback. | 44| void [OH_ArkUI_KeyEvent_Dispatch](_ark_u_i___native_module.md#oh_arkui_keyevent_dispatch) ([ArkUI_NodeHandle](_ark_u_i___native_module.md#arkui_nodehandle) \*node, const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event) | Dispatches a key event to a specific node. | 45