arkui_sys/native_key_event/
native_key_event_ffi.rs

1// automatically generated by rust-bindgen 0.71.1
2
3#![allow(non_upper_case_globals)]
4#![allow(non_camel_case_types)]
5#![allow(non_snake_case)]
6use crate::native_type::*;
7use crate::ui_input_event::ArkUI_UIInputEvent;
8
9#[cfg(feature = "api-14")]
10#[cfg_attr(docsrs, doc(cfg(feature = "api-14")))]
11impl ArkUI_KeyCode {
12    /// Unknown (or unrecognized) key
13    pub const ARKUI_KEYCODE_UNKNOWN: ArkUI_KeyCode = ArkUI_KeyCode(-1);
14    /// Function (Fn) key
15    pub const ARKUI_KEYCODE_FN: ArkUI_KeyCode = ArkUI_KeyCode(0);
16    /// Volume Up key
17    pub const ARKUI_KEYCODE_VOLUME_UP: ArkUI_KeyCode = ArkUI_KeyCode(16);
18    /// Volume Down key
19    pub const ARKUI_KEYCODE_VOLUME_DOWN: ArkUI_KeyCode = ArkUI_KeyCode(17);
20    /// Power key
21    pub const ARKUI_KEYCODE_POWER: ArkUI_KeyCode = ArkUI_KeyCode(18);
22    /// Shutter key
23    pub const ARKUI_KEYCODE_CAMERA: ArkUI_KeyCode = ArkUI_KeyCode(19);
24    /// Speaker Mute key
25    pub const ARKUI_KEYCODE_VOLUME_MUTE: ArkUI_KeyCode = ArkUI_KeyCode(22);
26    /// Mute key
27    pub const ARKUI_KEYCODE_MUTE: ArkUI_KeyCode = ArkUI_KeyCode(23);
28    /// Brightness Up key
29    pub const ARKUI_KEYCODE_BRIGHTNESS_UP: ArkUI_KeyCode = ArkUI_KeyCode(40);
30    /// Brightness Down key
31    pub const ARKUI_KEYCODE_BRIGHTNESS_DOWN: ArkUI_KeyCode = ArkUI_KeyCode(41);
32    /// Key 0
33    pub const ARKUI_KEYCODE_0: ArkUI_KeyCode = ArkUI_KeyCode(2000);
34    /// Key 1
35    pub const ARKUI_KEYCODE_1: ArkUI_KeyCode = ArkUI_KeyCode(2001);
36    /// Key 2
37    pub const ARKUI_KEYCODE_2: ArkUI_KeyCode = ArkUI_KeyCode(2002);
38    /// Key 3
39    pub const ARKUI_KEYCODE_3: ArkUI_KeyCode = ArkUI_KeyCode(2003);
40    /// Key 4
41    pub const ARKUI_KEYCODE_4: ArkUI_KeyCode = ArkUI_KeyCode(2004);
42    /// Key 5
43    pub const ARKUI_KEYCODE_5: ArkUI_KeyCode = ArkUI_KeyCode(2005);
44    /// Key 6
45    pub const ARKUI_KEYCODE_6: ArkUI_KeyCode = ArkUI_KeyCode(2006);
46    /// Key 7
47    pub const ARKUI_KEYCODE_7: ArkUI_KeyCode = ArkUI_KeyCode(2007);
48    /// Key 8
49    pub const ARKUI_KEYCODE_8: ArkUI_KeyCode = ArkUI_KeyCode(2008);
50    /// Key 9
51    pub const ARKUI_KEYCODE_9: ArkUI_KeyCode = ArkUI_KeyCode(2009);
52    /// Key +
53    pub const ARKUI_KEYCODE_STAR: ArkUI_KeyCode = ArkUI_KeyCode(2010);
54    /// Key #
55    pub const ARKUI_KEYCODE_POUND: ArkUI_KeyCode = ArkUI_KeyCode(2011);
56    /// Up key on D-pad
57    pub const ARKUI_KEYCODE_DPAD_UP: ArkUI_KeyCode = ArkUI_KeyCode(2012);
58    /// Down key on D-pad
59    pub const ARKUI_KEYCODE_DPAD_DOWN: ArkUI_KeyCode = ArkUI_KeyCode(2013);
60    /// Left key on D-pad
61    pub const ARKUI_KEYCODE_DPAD_LEFT: ArkUI_KeyCode = ArkUI_KeyCode(2014);
62    /// Right key on D-pad
63    pub const ARKUI_KEYCODE_DPAD_RIGHT: ArkUI_KeyCode = ArkUI_KeyCode(2015);
64    /// OK key on D-pad
65    pub const ARKUI_KEYCODE_DPAD_CENTER: ArkUI_KeyCode = ArkUI_KeyCode(2016);
66    /// Key A
67    pub const ARKUI_KEYCODE_A: ArkUI_KeyCode = ArkUI_KeyCode(2017);
68    /// Key B
69    pub const ARKUI_KEYCODE_B: ArkUI_KeyCode = ArkUI_KeyCode(2018);
70    /// Key C
71    pub const ARKUI_KEYCODE_C: ArkUI_KeyCode = ArkUI_KeyCode(2019);
72    /// Key D
73    pub const ARKUI_KEYCODE_D: ArkUI_KeyCode = ArkUI_KeyCode(2020);
74    /// Key E
75    pub const ARKUI_KEYCODE_E: ArkUI_KeyCode = ArkUI_KeyCode(2021);
76    /// Key F
77    pub const ARKUI_KEYCODE_F: ArkUI_KeyCode = ArkUI_KeyCode(2022);
78    /// Key G
79    pub const ARKUI_KEYCODE_G: ArkUI_KeyCode = ArkUI_KeyCode(2023);
80    /// Key H
81    pub const ARKUI_KEYCODE_H: ArkUI_KeyCode = ArkUI_KeyCode(2024);
82    /// Key I
83    pub const ARKUI_KEYCODE_I: ArkUI_KeyCode = ArkUI_KeyCode(2025);
84    /// Key J
85    pub const ARKUI_KEYCODE_J: ArkUI_KeyCode = ArkUI_KeyCode(2026);
86    /// Key K
87    pub const ARKUI_KEYCODE_K: ArkUI_KeyCode = ArkUI_KeyCode(2027);
88    /// Key L
89    pub const ARKUI_KEYCODE_L: ArkUI_KeyCode = ArkUI_KeyCode(2028);
90    /// Key M
91    pub const ARKUI_KEYCODE_M: ArkUI_KeyCode = ArkUI_KeyCode(2029);
92    /// Key N
93    pub const ARKUI_KEYCODE_N: ArkUI_KeyCode = ArkUI_KeyCode(2030);
94    /// Key O
95    pub const ARKUI_KEYCODE_O: ArkUI_KeyCode = ArkUI_KeyCode(2031);
96    /// Key P
97    pub const ARKUI_KEYCODE_P: ArkUI_KeyCode = ArkUI_KeyCode(2032);
98    /// Key R
99    pub const ARKUI_KEYCODE_Q: ArkUI_KeyCode = ArkUI_KeyCode(2033);
100    /// Key R
101    pub const ARKUI_KEYCODE_R: ArkUI_KeyCode = ArkUI_KeyCode(2034);
102    /// Key S
103    pub const ARKUI_KEYCODE_S: ArkUI_KeyCode = ArkUI_KeyCode(2035);
104    /// Key T
105    pub const ARKUI_KEYCODE_T: ArkUI_KeyCode = ArkUI_KeyCode(2036);
106    /// Key U
107    pub const ARKUI_KEYCODE_U: ArkUI_KeyCode = ArkUI_KeyCode(2037);
108    /// Key V
109    pub const ARKUI_KEYCODE_V: ArkUI_KeyCode = ArkUI_KeyCode(2038);
110    /// Key W
111    pub const ARKUI_KEYCODE_W: ArkUI_KeyCode = ArkUI_KeyCode(2039);
112    /// Key X
113    pub const ARKUI_KEYCODE_X: ArkUI_KeyCode = ArkUI_KeyCode(2040);
114    /// Key Y
115    pub const ARKUI_KEYCODE_Y: ArkUI_KeyCode = ArkUI_KeyCode(2041);
116    /// Key Z
117    pub const ARKUI_KEYCODE_Z: ArkUI_KeyCode = ArkUI_KeyCode(2042);
118    /// Key #
119    pub const ARKUI_KEYCODE_COMMA: ArkUI_KeyCode = ArkUI_KeyCode(2043);
120    /// Key #
121    pub const ARKUI_KEYCODE_PERIOD: ArkUI_KeyCode = ArkUI_KeyCode(2044);
122    /// Left Alt key
123    pub const ARKUI_KEYCODE_ALT_LEFT: ArkUI_KeyCode = ArkUI_KeyCode(2045);
124    /// Right Alt key
125    pub const ARKUI_KEYCODE_ALT_RIGHT: ArkUI_KeyCode = ArkUI_KeyCode(2046);
126    /// Left Shift key
127    pub const ARKUI_KEYCODE_SHIFT_LEFT: ArkUI_KeyCode = ArkUI_KeyCode(2047);
128    /// Right Shift key
129    pub const ARKUI_KEYCODE_SHIFT_RIGHT: ArkUI_KeyCode = ArkUI_KeyCode(2048);
130    /// Tab key
131    pub const ARKUI_KEYCODE_TAB: ArkUI_KeyCode = ArkUI_KeyCode(2049);
132    /// Space key
133    pub const ARKUI_KEYCODE_SPACE: ArkUI_KeyCode = ArkUI_KeyCode(2050);
134    /// Symbol key
135    pub const ARKUI_KEYCODE_SYM: ArkUI_KeyCode = ArkUI_KeyCode(2051);
136    /// Explorer key, used to start the explorer application
137    pub const ARKUI_KEYCODE_EXPLORER: ArkUI_KeyCode = ArkUI_KeyCode(2052);
138    /// Email key, used to start the email application
139    pub const ARKUI_KEYCODE_ENVELOPE: ArkUI_KeyCode = ArkUI_KeyCode(2053);
140    /// Enter key
141    pub const ARKUI_KEYCODE_ENTER: ArkUI_KeyCode = ArkUI_KeyCode(2054);
142    /// Backspace key
143    pub const ARKUI_KEYCODE_DEL: ArkUI_KeyCode = ArkUI_KeyCode(2055);
144    /// Key `
145    pub const ARKUI_KEYCODE_GRAVE: ArkUI_KeyCode = ArkUI_KeyCode(2056);
146    /// Key -
147    pub const ARKUI_KEYCODE_MINUS: ArkUI_KeyCode = ArkUI_KeyCode(2057);
148    /// Key =
149    pub const ARKUI_KEYCODE_EQUALS: ArkUI_KeyCode = ArkUI_KeyCode(2058);
150    /// Key [
151    pub const ARKUI_KEYCODE_LEFT_BRACKET: ArkUI_KeyCode = ArkUI_KeyCode(2059);
152    /// Key ]
153    pub const ARKUI_KEYCODE_RIGHT_BRACKET: ArkUI_KeyCode = ArkUI_KeyCode(2060);
154    /// Key
155    pub const ARKUI_KEYCODE_BACKSLASH: ArkUI_KeyCode = ArkUI_KeyCode(2061);
156    /// Key ;
157    pub const ARKUI_KEYCODE_SEMICOLON: ArkUI_KeyCode = ArkUI_KeyCode(2062);
158    /// Key '
159    pub const ARKUI_KEYCODE_APOSTROPHE: ArkUI_KeyCode = ArkUI_KeyCode(2063);
160    /// Key /
161    pub const ARKUI_KEYCODE_SLASH: ArkUI_KeyCode = ArkUI_KeyCode(2064);
162    /// Key
163    pub const ARKUI_KEYCODE_AT: ArkUI_KeyCode = ArkUI_KeyCode(2065);
164    /// Key +
165    pub const ARKUI_KEYCODE_PLUS: ArkUI_KeyCode = ArkUI_KeyCode(2066);
166    /// Menu key
167    pub const ARKUI_KEYCODE_MENU: ArkUI_KeyCode = ArkUI_KeyCode(2067);
168    /// Page Up key
169    pub const ARKUI_KEYCODE_PAGE_UP: ArkUI_KeyCode = ArkUI_KeyCode(2068);
170    /// Page Down key
171    pub const ARKUI_KEYCODE_PAGE_DOWN: ArkUI_KeyCode = ArkUI_KeyCode(2069);
172    /// ESC key
173    pub const ARKUI_KEYCODE_ESCAPE: ArkUI_KeyCode = ArkUI_KeyCode(2070);
174    /// Delete key
175    pub const ARKUI_KEYCODE_FORWARD_DEL: ArkUI_KeyCode = ArkUI_KeyCode(2071);
176    /// Left Ctrl key
177    pub const ARKUI_KEYCODE_CTRL_LEFT: ArkUI_KeyCode = ArkUI_KeyCode(2072);
178    /// Right Ctrl key
179    pub const ARKUI_KEYCODE_CTRL_RIGHT: ArkUI_KeyCode = ArkUI_KeyCode(2073);
180    /// Caps Lock key
181    pub const ARKUI_KEYCODE_CAPS_LOCK: ArkUI_KeyCode = ArkUI_KeyCode(2074);
182    /// Scroll Lock key
183    pub const ARKUI_KEYCODE_SCROLL_LOCK: ArkUI_KeyCode = ArkUI_KeyCode(2075);
184    /// Left Meta key
185    pub const ARKUI_KEYCODE_META_LEFT: ArkUI_KeyCode = ArkUI_KeyCode(2076);
186    /// Right Meta key
187    pub const ARKUI_KEYCODE_META_RIGHT: ArkUI_KeyCode = ArkUI_KeyCode(2077);
188    /// Function key
189    pub const ARKUI_KEYCODE_FUNCTION: ArkUI_KeyCode = ArkUI_KeyCode(2078);
190    /// System Request/Print Screen key
191    pub const ARKUI_KEYCODE_SYSRQ: ArkUI_KeyCode = ArkUI_KeyCode(2079);
192    /// Break/Pause key
193    pub const ARKUI_KEYCODE_BREAK: ArkUI_KeyCode = ArkUI_KeyCode(2080);
194    /// Move to Home key
195    pub const ARKUI_KEYCODE_MOVE_HOME: ArkUI_KeyCode = ArkUI_KeyCode(2081);
196    /// Move to End key
197    pub const ARKUI_KEYCODE_MOVE_END: ArkUI_KeyCode = ArkUI_KeyCode(2082);
198    /// Insert key
199    pub const ARKUI_KEYCODE_INSERT: ArkUI_KeyCode = ArkUI_KeyCode(2083);
200    /// Forward key
201    pub const ARKUI_KEYCODE_FORWARD: ArkUI_KeyCode = ArkUI_KeyCode(2084);
202    /// Play key
203    pub const ARKUI_KEYCODE_MEDIA_PLAY: ArkUI_KeyCode = ArkUI_KeyCode(2085);
204    /// Pause key
205    pub const ARKUI_KEYCODE_MEDIA_PAUSE: ArkUI_KeyCode = ArkUI_KeyCode(2086);
206    /// Close key
207    pub const ARKUI_KEYCODE_MEDIA_CLOSE: ArkUI_KeyCode = ArkUI_KeyCode(2087);
208    /// Eject key
209    pub const ARKUI_KEYCODE_MEDIA_EJECT: ArkUI_KeyCode = ArkUI_KeyCode(2088);
210    /// Record key
211    pub const ARKUI_KEYCODE_MEDIA_RECORD: ArkUI_KeyCode = ArkUI_KeyCode(2089);
212    /// F1 key
213    pub const ARKUI_KEYCODE_F1: ArkUI_KeyCode = ArkUI_KeyCode(2090);
214    /// F2 key
215    pub const ARKUI_KEYCODE_F2: ArkUI_KeyCode = ArkUI_KeyCode(2091);
216    /// F3 key
217    pub const ARKUI_KEYCODE_F3: ArkUI_KeyCode = ArkUI_KeyCode(2092);
218    /// F4 key
219    pub const ARKUI_KEYCODE_F4: ArkUI_KeyCode = ArkUI_KeyCode(2093);
220    /// F5 key
221    pub const ARKUI_KEYCODE_F5: ArkUI_KeyCode = ArkUI_KeyCode(2094);
222    /// F6 key
223    pub const ARKUI_KEYCODE_F6: ArkUI_KeyCode = ArkUI_KeyCode(2095);
224    /// F7 key
225    pub const ARKUI_KEYCODE_F7: ArkUI_KeyCode = ArkUI_KeyCode(2096);
226    /// F8 key
227    pub const ARKUI_KEYCODE_F8: ArkUI_KeyCode = ArkUI_KeyCode(2097);
228    /// F9 key
229    pub const ARKUI_KEYCODE_F9: ArkUI_KeyCode = ArkUI_KeyCode(2098);
230    /// F10 key
231    pub const ARKUI_KEYCODE_F10: ArkUI_KeyCode = ArkUI_KeyCode(2099);
232    /// F11 key
233    pub const ARKUI_KEYCODE_F11: ArkUI_KeyCode = ArkUI_KeyCode(2100);
234    /// F12 key
235    pub const ARKUI_KEYCODE_F12: ArkUI_KeyCode = ArkUI_KeyCode(2101);
236    /// Number Lock key on numeric keypad
237    pub const ARKUI_KEYCODE_NUM_LOCK: ArkUI_KeyCode = ArkUI_KeyCode(2102);
238    /// Key 0 on numeric keypad
239    pub const ARKUI_KEYCODE_NUMPAD_0: ArkUI_KeyCode = ArkUI_KeyCode(2103);
240    /// Key 1 on numeric keypad
241    pub const ARKUI_KEYCODE_NUMPAD_1: ArkUI_KeyCode = ArkUI_KeyCode(2104);
242    /// Key 2 on numeric keypad
243    pub const ARKUI_KEYCODE_NUMPAD_2: ArkUI_KeyCode = ArkUI_KeyCode(2105);
244    /// Key 3 on numeric keypad
245    pub const ARKUI_KEYCODE_NUMPAD_3: ArkUI_KeyCode = ArkUI_KeyCode(2106);
246    /// Key 4 on numeric keypad
247    pub const ARKUI_KEYCODE_NUMPAD_4: ArkUI_KeyCode = ArkUI_KeyCode(2107);
248    /// Key 5 on numeric keypad
249    pub const ARKUI_KEYCODE_NUMPAD_5: ArkUI_KeyCode = ArkUI_KeyCode(2108);
250    /// Key 6 on numeric keypad
251    pub const ARKUI_KEYCODE_NUMPAD_6: ArkUI_KeyCode = ArkUI_KeyCode(2109);
252    /// Key 7 on numeric keypad
253    pub const ARKUI_KEYCODE_NUMPAD_7: ArkUI_KeyCode = ArkUI_KeyCode(2110);
254    /// Key 8 on numeric keypad
255    pub const ARKUI_KEYCODE_NUMPAD_8: ArkUI_KeyCode = ArkUI_KeyCode(2111);
256    /// Key 9 on numeric keypad
257    pub const ARKUI_KEYCODE_NUMPAD_9: ArkUI_KeyCode = ArkUI_KeyCode(2112);
258    /// Key / on numeric keypad
259    pub const ARKUI_KEYCODE_NUMPAD_DIVIDE: ArkUI_KeyCode = ArkUI_KeyCode(2113);
260    /// Key ) on numeric keypad
261    pub const ARKUI_KEYCODE_NUMPAD_MULTIPLY: ArkUI_KeyCode = ArkUI_KeyCode(2114);
262    /// Key - on numeric keypad
263    pub const ARKUI_KEYCODE_NUMPAD_SUBTRACT: ArkUI_KeyCode = ArkUI_KeyCode(2115);
264    /// Key + on numeric keypad
265    pub const ARKUI_KEYCODE_NUMPAD_ADD: ArkUI_KeyCode = ArkUI_KeyCode(2116);
266    /// Key . on numeric keypad
267    pub const ARKUI_KEYCODE_NUMPAD_DOT: ArkUI_KeyCode = ArkUI_KeyCode(2117);
268    /// Key , on numeric keypad
269    pub const ARKUI_KEYCODE_NUMPAD_COMMA: ArkUI_KeyCode = ArkUI_KeyCode(2118);
270    /// Enter key on numeric keypad
271    pub const ARKUI_KEYCODE_NUMPAD_ENTER: ArkUI_KeyCode = ArkUI_KeyCode(2119);
272    /// Key = on numeric keypad
273    pub const ARKUI_KEYCODE_NUMPAD_EQUALS: ArkUI_KeyCode = ArkUI_KeyCode(2120);
274    /// Key ( on numeric keypad
275    pub const ARKUI_KEYCODE_NUMPAD_LEFT_PAREN: ArkUI_KeyCode = ArkUI_KeyCode(2121);
276    /// Key ) on numeric keypad
277    pub const ARKUI_KEYCODE_NUMPAD_RIGHT_PAREN: ArkUI_KeyCode = ArkUI_KeyCode(2122);
278    /// Joystick key A
279    ///
280    /// Available since API-level: 15
281    #[cfg(feature = "api-15")]
282    #[cfg_attr(docsrs, doc(cfg(feature = "api-15")))]
283    pub const ARKUI_KEYCODE_BUTTON_A: ArkUI_KeyCode = ArkUI_KeyCode(2301);
284    /// Joystick key B
285    ///
286    /// Available since API-level: 15
287    #[cfg(feature = "api-15")]
288    #[cfg_attr(docsrs, doc(cfg(feature = "api-15")))]
289    pub const ARKUI_KEYCODE_BUTTON_B: ArkUI_KeyCode = ArkUI_KeyCode(2302);
290    /// Joystick key X
291    ///
292    /// Available since API-level: 15
293    #[cfg(feature = "api-15")]
294    #[cfg_attr(docsrs, doc(cfg(feature = "api-15")))]
295    pub const ARKUI_KEYCODE_BUTTON_X: ArkUI_KeyCode = ArkUI_KeyCode(2304);
296    /// Joystick key Y
297    ///
298    /// Available since API-level: 15
299    #[cfg(feature = "api-15")]
300    #[cfg_attr(docsrs, doc(cfg(feature = "api-15")))]
301    pub const ARKUI_KEYCODE_BUTTON_Y: ArkUI_KeyCode = ArkUI_KeyCode(2305);
302    /// Joystick key L1
303    ///
304    /// Available since API-level: 15
305    #[cfg(feature = "api-15")]
306    #[cfg_attr(docsrs, doc(cfg(feature = "api-15")))]
307    pub const ARKUI_KEYCODE_BUTTON_L1: ArkUI_KeyCode = ArkUI_KeyCode(2307);
308    /// Joystick key R1
309    ///
310    /// Available since API-level: 15
311    #[cfg(feature = "api-15")]
312    #[cfg_attr(docsrs, doc(cfg(feature = "api-15")))]
313    pub const ARKUI_KEYCODE_BUTTON_R1: ArkUI_KeyCode = ArkUI_KeyCode(2308);
314    /// Joystick key L2
315    ///
316    /// Available since API-level: 15
317    #[cfg(feature = "api-15")]
318    #[cfg_attr(docsrs, doc(cfg(feature = "api-15")))]
319    pub const ARKUI_KEYCODE_BUTTON_L2: ArkUI_KeyCode = ArkUI_KeyCode(2309);
320    /// Joystick key R2
321    ///
322    /// Available since API-level: 15
323    #[cfg(feature = "api-15")]
324    #[cfg_attr(docsrs, doc(cfg(feature = "api-15")))]
325    pub const ARKUI_KEYCODE_BUTTON_R2: ArkUI_KeyCode = ArkUI_KeyCode(2310);
326    /// Joystick key Select
327    ///
328    /// Available since API-level: 15
329    #[cfg(feature = "api-15")]
330    #[cfg_attr(docsrs, doc(cfg(feature = "api-15")))]
331    pub const ARKUI_KEYCODE_BUTTON_SELECT: ArkUI_KeyCode = ArkUI_KeyCode(2311);
332    /// Joystick key Start
333    ///
334    /// Available since API-level: 15
335    #[cfg(feature = "api-15")]
336    #[cfg_attr(docsrs, doc(cfg(feature = "api-15")))]
337    pub const ARKUI_KEYCODE_BUTTON_START: ArkUI_KeyCode = ArkUI_KeyCode(2312);
338    /// Joystick key Mode
339    ///
340    /// Available since API-level: 15
341    #[cfg(feature = "api-15")]
342    #[cfg_attr(docsrs, doc(cfg(feature = "api-15")))]
343    pub const ARKUI_KEYCODE_BUTTON_MODE: ArkUI_KeyCode = ArkUI_KeyCode(2313);
344    /// Joystick key THUMBL
345    ///
346    /// Available since API-level: 15
347    #[cfg(feature = "api-15")]
348    #[cfg_attr(docsrs, doc(cfg(feature = "api-15")))]
349    pub const ARKUI_KEYCODE_BUTTON_THUMBL: ArkUI_KeyCode = ArkUI_KeyCode(2314);
350    /// Joystick key THUMBR
351    ///
352    /// Available since API-level: 15
353    #[cfg(feature = "api-15")]
354    #[cfg_attr(docsrs, doc(cfg(feature = "api-15")))]
355    pub const ARKUI_KEYCODE_BUTTON_THUMBR: ArkUI_KeyCode = ArkUI_KeyCode(2315);
356}
357#[repr(transparent)]
358/// Defines an enum for the key codes in key events.
359///
360///
361/// Available since API-level: 14
362#[cfg(feature = "api-14")]
363#[cfg_attr(docsrs, doc(cfg(feature = "api-14")))]
364#[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
365pub struct ArkUI_KeyCode(pub ::core::ffi::c_int);
366#[cfg(feature = "api-14")]
367#[cfg_attr(docsrs, doc(cfg(feature = "api-14")))]
368impl ArkUI_KeyEventType {
369    /// Unknown type
370    pub const ARKUI_KEY_EVENT_UNKNOWN: ArkUI_KeyEventType = ArkUI_KeyEventType(-1);
371    /// Pressing of a key
372    pub const ARKUI_KEY_EVENT_DOWN: ArkUI_KeyEventType = ArkUI_KeyEventType(0);
373    /// Release of a key
374    pub const ARKUI_KEY_EVENT_UP: ArkUI_KeyEventType = ArkUI_KeyEventType(1);
375    /// Long press of a key
376    pub const ARKUI_KEY_EVENT_LONG_PRESS: ArkUI_KeyEventType = ArkUI_KeyEventType(2);
377    /// Click of a key
378    pub const ARKUI_KEY_EVENT_CLICK: ArkUI_KeyEventType = ArkUI_KeyEventType(3);
379}
380#[repr(transparent)]
381/// Defines an enum for the key event types.
382///
383///
384/// Available since API-level: 14
385#[cfg(feature = "api-14")]
386#[cfg_attr(docsrs, doc(cfg(feature = "api-14")))]
387#[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
388pub struct ArkUI_KeyEventType(pub ::core::ffi::c_int);
389#[cfg(feature = "api-14")]
390#[cfg_attr(docsrs, doc(cfg(feature = "api-14")))]
391impl ArkUI_KeySourceType {
392    /// Unknown type
393    pub const ARKUI_KEY_SOURCE_UNKNOWN: ArkUI_KeySourceType = ArkUI_KeySourceType(0);
394    /// Mouse
395    pub const ARKUI_KEY_SOURCE_TYPE_MOUSE: ArkUI_KeySourceType = ArkUI_KeySourceType(1);
396    /// Keyboard
397    pub const ARKUI_KEY_SOURCE_TYPE_KEYBOARD: ArkUI_KeySourceType = ArkUI_KeySourceType(4);
398    /// Joystick.
399    ///
400    ///
401    /// Available since API-level: 15
402    #[cfg(feature = "api-15")]
403    #[cfg_attr(docsrs, doc(cfg(feature = "api-15")))]
404    pub const ARKUI_KEY_SOURCE_TYPE_JOYSTICK: ArkUI_KeySourceType = ArkUI_KeySourceType(5);
405}
406#[repr(transparent)]
407/// Defines an enum for the types of devices that trigger a key event.
408///
409///
410/// Available since API-level: 14
411#[cfg(feature = "api-14")]
412#[cfg_attr(docsrs, doc(cfg(feature = "api-14")))]
413#[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
414pub struct ArkUI_KeySourceType(pub ::core::ffi::c_uint);
415#[cfg(feature = "api-14")]
416#[cfg_attr(docsrs, doc(cfg(feature = "api-14")))]
417impl ArkUI_KeyIntension {
418    /// Unknown intention
419    pub const ARKUI_KEY_INTENSION_UNKNOWN: ArkUI_KeyIntension = ArkUI_KeyIntension(-1);
420    /// Upward
421    pub const ARKUI_KEY_INTENSION_UP: ArkUI_KeyIntension = ArkUI_KeyIntension(1);
422    /// Downward
423    pub const ARKUI_KEY_INTENSION_DOWN: ArkUI_KeyIntension = ArkUI_KeyIntension(2);
424    /// Leftward
425    pub const ARKUI_KEY_INTENSION_LEFT: ArkUI_KeyIntension = ArkUI_KeyIntension(3);
426    /// Rightward
427    pub const ARKUI_KEY_INTENSION_RIGHT: ArkUI_KeyIntension = ArkUI_KeyIntension(4);
428    /// Select
429    pub const ARKUI_KEY_INTENSION_SELECT: ArkUI_KeyIntension = ArkUI_KeyIntension(5);
430    /// Escape
431    pub const ARKUI_KEY_INTENSION_ESCAPE: ArkUI_KeyIntension = ArkUI_KeyIntension(6);
432    /// Back
433    pub const ARKUI_KEY_INTENSION_BACK: ArkUI_KeyIntension = ArkUI_KeyIntension(7);
434    /// Forward
435    pub const ARKUI_KEY_INTENSION_FORWARD: ArkUI_KeyIntension = ArkUI_KeyIntension(8);
436    /// Menu
437    pub const ARKUI_KEY_INTENSION_MENU: ArkUI_KeyIntension = ArkUI_KeyIntension(9);
438    /// Home
439    pub const ARKUI_KEY_INTENSION_HOME: ArkUI_KeyIntension = ArkUI_KeyIntension(10);
440    /// Page up
441    pub const ARKUI_KEY_INTENSION_PAGE_UP: ArkUI_KeyIntension = ArkUI_KeyIntension(11);
442    /// Page down
443    pub const ARKUI_KEY_INTENSION_PAGE_DOWN: ArkUI_KeyIntension = ArkUI_KeyIntension(12);
444    /// Zoom out
445    pub const ARKUI_KEY_INTENSION_ZOOM_OUT: ArkUI_KeyIntension = ArkUI_KeyIntension(13);
446    /// Zoom in
447    pub const ARKUI_KEY_INTENSION_ZOOM_IN: ArkUI_KeyIntension = ArkUI_KeyIntension(14);
448    /// Play or pause
449    pub const ARKUI_KEY_INTENTION_MEDIA_PLAY_PAUSE: ArkUI_KeyIntension = ArkUI_KeyIntension(100);
450    /// Fast-forward
451    pub const ARKUI_KEY_INTENTION_MEDIA_FAST_FORWARD: ArkUI_KeyIntension = ArkUI_KeyIntension(101);
452    /// Fast playback
453    pub const ARKUI_KEY_INTENTION_MEDIA_FAST_PLAYBACK: ArkUI_KeyIntension = ArkUI_KeyIntension(103);
454    /// Play next
455    pub const ARKUI_KEY_INTENTION_MEDIA_NEXT: ArkUI_KeyIntension = ArkUI_KeyIntension(104);
456    /// Play previous
457    pub const ARKUI_KEY_INTENTION_MEDIA_PREVIOUS: ArkUI_KeyIntension = ArkUI_KeyIntension(105);
458    /// Mute
459    pub const ARKUI_KEY_INTENTION_MEDIA_MUTE: ArkUI_KeyIntension = ArkUI_KeyIntension(106);
460    /// Volume up
461    pub const ARKUI_KEY_INTENTION_VOLUME_UP: ArkUI_KeyIntension = ArkUI_KeyIntension(107);
462    /// Volume down
463    pub const ARKUI_KEY_INTENTION_VOLUME_DOWN: ArkUI_KeyIntension = ArkUI_KeyIntension(108);
464    /// Answer a call
465    pub const ARKUI_KEY_INTENTION_CALL: ArkUI_KeyIntension = ArkUI_KeyIntension(200);
466    /// Camera
467    pub const ARKUI_KEY_INTENTION_CAMERA: ArkUI_KeyIntension = ArkUI_KeyIntension(300);
468}
469#[repr(transparent)]
470/// Defines an enum for key intentions.
471///
472///
473/// Available since API-level: 14
474#[cfg(feature = "api-14")]
475#[cfg_attr(docsrs, doc(cfg(feature = "api-14")))]
476#[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
477pub struct ArkUI_KeyIntension(pub ::core::ffi::c_int);
478extern "C" {
479    /// Obtains the type of a key event.
480    ///
481    /// # Arguments
482    ///
483    /// * `event` - Pointer to an <b>ArkUI_UIInputEvent</b> object.
484    ///
485    /// # Returns
486    ///
487    /// * Returns the key event type.
488    ///
489    /// Available since API-level: 14
490    #[cfg(feature = "api-14")]
491    #[cfg_attr(docsrs, doc(cfg(feature = "api-14")))]
492    pub fn OH_ArkUI_KeyEvent_GetType(event: *const ArkUI_UIInputEvent) -> ArkUI_KeyEventType;
493    /// Obtains the key code from a key event.
494    ///
495    /// # Arguments
496    ///
497    /// * `event` - Pointer to an <b>ArkUI_UIInputEvent</b> object.
498    ///
499    /// # Returns
500    ///
501    /// * Returns the key code.
502    ///
503    /// Available since API-level: 14
504    #[cfg(feature = "api-14")]
505    #[cfg_attr(docsrs, doc(cfg(feature = "api-14")))]
506    pub fn OH_ArkUI_KeyEvent_GetKeyCode(event: *const ArkUI_UIInputEvent) -> i32;
507    /// Obtains the key value from a key event.
508    ///
509    /// # Arguments
510    ///
511    /// * `event` - Pointer to an <b>ArkUI_UIInputEvent</b> object.
512    ///
513    /// # Returns
514    ///
515    /// * Returns the key value.
516    ///
517    /// Available since API-level: 14
518    #[cfg(feature = "api-14")]
519    #[cfg_attr(docsrs, doc(cfg(feature = "api-14")))]
520    pub fn OH_ArkUI_KeyEvent_GetKeyText(
521        event: *const ArkUI_UIInputEvent,
522    ) -> *const ::core::ffi::c_char;
523    /// Obtains the type of device that triggers a key event.
524    ///
525    /// # Arguments
526    ///
527    /// * `event` - Pointer to an <b>ArkUI_UIInputEvent</b> object.
528    ///
529    /// # Returns
530    ///
531    /// * Returns the device type.
532    ///
533    /// Available since API-level: 14
534    #[cfg(feature = "api-14")]
535    #[cfg_attr(docsrs, doc(cfg(feature = "api-14")))]
536    pub fn OH_ArkUI_KeyEvent_GetKeySource(event: *const ArkUI_UIInputEvent) -> ArkUI_KeySourceType;
537    /// Prevents a key event from bubbling up.
538    ///
539    /// # Arguments
540    ///
541    /// * `event` - Pointer to an <b>ArkUI_UIInputEvent</b> object.
542    ///
543    /// * `stopPropagation` - Whether to stop event propagation.
544    ///
545    /// Available since API-level: 14
546    #[cfg(feature = "api-14")]
547    #[cfg_attr(docsrs, doc(cfg(feature = "api-14")))]
548    pub fn OH_ArkUI_KeyEvent_StopPropagation(
549        event: *const ArkUI_UIInputEvent,
550        stopPropagation: bool,
551    );
552    /// Obtains the intention code associated with a key event.
553    ///
554    /// # Arguments
555    ///
556    /// * `event` - Pointer to an <b>ArkUI_UIInputEvent</b> object.
557    ///
558    /// # Returns
559    ///
560    /// * Returns the intention code associated with the key event.
561    ///
562    /// Available since API-level: 14
563    #[cfg(feature = "api-14")]
564    #[cfg_attr(docsrs, doc(cfg(feature = "api-14")))]
565    pub fn OH_ArkUI_KeyEvent_GetKeyIntensionCode(
566        event: *const ArkUI_UIInputEvent,
567    ) -> ArkUI_KeyIntension;
568    /// Obtains the Unicode value associated with a key event.
569    /// Non-space basic Latin characters in the 0x0021-0x007E range are supported. Characters with a value of 0 are not
570    /// supported. In the case of key combination, this API returns the Unicode value of the key corresponding to the key
571    /// event.
572    ///
573    /// # Arguments
574    ///
575    /// * `event` - Pointer to an <b>ArkUI_UIInputEvent</b> object.
576    ///
577    /// # Returns
578    ///
579    /// * Returns the Unicode value.
580    ///
581    /// Available since API-level: 14
582    #[cfg(feature = "api-14")]
583    #[cfg_attr(docsrs, doc(cfg(feature = "api-14")))]
584    pub fn OH_ArkUI_KeyEvent_GetUnicode(event: *const ArkUI_UIInputEvent) -> u32;
585    /// Sets whether a key event is consumed in the key event callback.
586    ///
587    /// # Arguments
588    ///
589    /// * `event` - Pointer to an <b>ArkUI_UIInputEvent</b> object.
590    ///
591    /// * `isConsumed` - Whether the event is consumed.
592    ///
593    /// Available since API-level: 14
594    #[cfg(feature = "api-14")]
595    #[cfg_attr(docsrs, doc(cfg(feature = "api-14")))]
596    pub fn OH_ArkUI_KeyEvent_SetConsumed(event: *const ArkUI_UIInputEvent, isConsumed: bool);
597    /// Dispatch key event to a specific component node.
598    ///
599    /// # Arguments
600    ///
601    /// * `node` - Indicates the pointer to a component node.
602    ///
603    /// * `event` - Pointer to an <b>ArkUI_UIInputEvent</b> object.
604    ///
605    /// Available since API-level: 15
606    #[cfg(feature = "api-15")]
607    #[cfg_attr(docsrs, doc(cfg(feature = "api-15")))]
608    pub fn OH_ArkUI_KeyEvent_Dispatch(node: ArkUI_NodeHandle, event: *const ArkUI_UIInputEvent);
609    /// Get the Num Lock state of the key event.
610    ///
611    /// # Arguments
612    ///
613    /// * `event` - Pointer to an <b>ArkUI_UIInputEvent</b> object.
614    ///
615    /// * `state` - Return whether the Num Lock is on.
616    ///
617    /// # Returns
618    ///
619    /// * Returns the result code.
620    /// Returns [`ARKUI_ERROR_CODE_NO_ERROR`] if the operation is successful.
621    /// Returns [`ARKUI_ERROR_CODE_PARAM_INVALID`] if a parameter error occurs.
622    ///
623    /// Available since API-level: 19
624    #[cfg(feature = "api-19")]
625    #[cfg_attr(docsrs, doc(cfg(feature = "api-19")))]
626    pub fn OH_ArkUI_KeyEvent_IsNumLockOn(
627        event: *const ArkUI_UIInputEvent,
628        state: *mut bool,
629    ) -> ArkUiResult;
630    /// Get the Caps Lock state of the key event.
631    ///
632    /// # Arguments
633    ///
634    /// * `event` - Pointer to an <b>ArkUI_UIInputEvent</b> object.
635    ///
636    /// * `state` - Return whether the Caps Lock is on.
637    ///
638    /// # Returns
639    ///
640    /// * Returns the result code.
641    /// Returns [`ARKUI_ERROR_CODE_NO_ERROR`] if the operation is successful.
642    /// Returns [`ARKUI_ERROR_CODE_PARAM_INVALID`] if a parameter error occurs.
643    ///
644    /// Available since API-level: 19
645    #[cfg(feature = "api-19")]
646    #[cfg_attr(docsrs, doc(cfg(feature = "api-19")))]
647    pub fn OH_ArkUI_KeyEvent_IsCapsLockOn(
648        event: *const ArkUI_UIInputEvent,
649        state: *mut bool,
650    ) -> ArkUiResult;
651    /// Get the Scroll Lock state of the key event.
652    ///
653    /// # Arguments
654    ///
655    /// * `event` - Pointer to an <b>ArkUI_UIInputEvent</b> object.
656    ///
657    /// * `state` - Return whether the Scroll Lock is on.
658    ///
659    /// # Returns
660    ///
661    /// * Returns the result code.
662    /// Returns [`ARKUI_ERROR_CODE_NO_ERROR`] if the operation is successful.
663    /// Returns [`ARKUI_ERROR_CODE_PARAM_INVALID`] if a parameter error occurs.
664    ///
665    /// Available since API-level: 19
666    #[cfg(feature = "api-19")]
667    #[cfg_attr(docsrs, doc(cfg(feature = "api-19")))]
668    pub fn OH_ArkUI_KeyEvent_IsScrollLockOn(
669        event: *const ArkUI_UIInputEvent,
670        state: *mut bool,
671    ) -> ArkUiResult;
672}
arkui_sys/native_key_event/native_key_event_ffi.rs

arkui_sys/native_key_event/
native_key_event_ffi.rs
