• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2021-2023 Huawei Device Co., Ltd.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 
16 /**
17  * @addtogroup OH_NativeXComponent Native XComponent
18  * @{
19  *
20  * @brief Describes the key event held by the ArkUI XComponent, which can be used for the EGL/OpenGL ES.
21  *
22  * @since 10
23  * @version 1.0
24  */
25 
26 /**
27  * @file native_xcomponent_key_event.h
28  *
29  * @brief Declares enums for key event of Native XComponent.
30  * @library libace_ndk.z.so
31  * @syscap SystemCapability.ArkUI.ArkUI.Full
32  * @kit ArkUI
33  * @since 10
34  * @version 1.0
35  */
36 
37 #ifndef _NATIVE_INTERFACE_XCOMPONENT_KEY_EVENT_H_
38 #define _NATIVE_INTERFACE_XCOMPONENT_KEY_EVENT_H_
39 
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43 
44 /**
45  * @brief Represents the key event code.
46  *
47  * @since 10
48  * @version 1.0
49  */
50 typedef enum {
51     KEY_UNKNOWN = -1,
52     KEY_FN = 0,
53     KEY_HOME = 1,
54     KEY_BACK = 2,
55     KEY_MEDIA_PLAY_PAUSE = 10,
56     KEY_MEDIA_STOP = 11,
57     KEY_MEDIA_NEXT = 12,
58     KEY_MEDIA_PREVIOUS = 13,
59     KEY_MEDIA_REWIND = 14,
60     KEY_MEDIA_FAST_FORWARD = 15,
61     KEY_VOLUME_UP = 16,
62     KEY_VOLUME_DOWN = 17,
63     KEY_POWER = 18,
64     KEY_CAMERA = 19,
65     KEY_VOLUME_MUTE = 22,
66     KEY_MUTE = 23,
67     KEY_BRIGHTNESS_UP = 40,
68     KEY_BRIGHTNESS_DOWN = 41,
69     KEY_0 = 2000,
70     KEY_1 = 2001,
71     KEY_2 = 2002,
72     KEY_3 = 2003,
73     KEY_4 = 2004,
74     KEY_5 = 2005,
75     KEY_6 = 2006,
76     KEY_7 = 2007,
77     KEY_8 = 2008,
78     KEY_9 = 2009,
79     KEY_STAR = 2010,
80     KEY_POUND = 2011,
81     KEY_DPAD_UP = 2012,
82     KEY_DPAD_DOWN = 2013,
83     KEY_DPAD_LEFT = 2014,
84     KEY_DPAD_RIGHT = 2015,
85     KEY_DPAD_CENTER = 2016,
86     KEY_A = 2017,
87     KEY_B = 2018,
88     KEY_C = 2019,
89     KEY_D = 2020,
90     KEY_E = 2021,
91     KEY_F = 2022,
92     KEY_G = 2023,
93     KEY_H = 2024,
94     KEY_I = 2025,
95     KEY_J = 2026,
96     KEY_K = 2027,
97     KEY_L = 2028,
98     KEY_M = 2029,
99     KEY_N = 2030,
100     KEY_O = 2031,
101     KEY_P = 2032,
102     KEY_Q = 2033,
103     KEY_R = 2034,
104     KEY_S = 2035,
105     KEY_T = 2036,
106     KEY_U = 2037,
107     KEY_V = 2038,
108     KEY_W = 2039,
109     KEY_X = 2040,
110     KEY_Y = 2041,
111     KEY_Z = 2042,
112     KEY_COMMA = 2043,
113     KEY_PERIOD = 2044,
114     KEY_ALT_LEFT = 2045,
115     KEY_ALT_RIGHT = 2046,
116     KEY_SHIFT_LEFT = 2047,
117     KEY_SHIFT_RIGHT = 2048,
118     KEY_TAB = 2049,
119     KEY_SPACE = 2050,
120     KEY_SYM = 2051,
121     KEY_EXPLORER = 2052,
122     KEY_ENVELOPE = 2053,
123     KEY_ENTER = 2054,
124     KEY_DEL = 2055,
125     KEY_GRAVE = 2056,
126     KEY_MINUS = 2057,
127     KEY_EQUALS = 2058,
128     KEY_LEFT_BRACKET = 2059,
129     KEY_RIGHT_BRACKET = 2060,
130     KEY_BACKSLASH = 2061,
131     KEY_SEMICOLON = 2062,
132     KEY_APOSTROPHE = 2063,
133     KEY_SLASH = 2064,
134     KEY_AT = 2065,
135     KEY_PLUS = 2066,
136     KEY_MENU = 2067,
137     KEY_PAGE_UP = 2068,
138     KEY_PAGE_DOWN = 2069,
139     KEY_ESCAPE = 2070,
140     KEY_FORWARD_DEL = 2071,
141     KEY_CTRL_LEFT = 2072,
142     KEY_CTRL_RIGHT = 2073,
143     KEY_CAPS_LOCK = 2074,
144     KEY_SCROLL_LOCK = 2075,
145     KEY_META_LEFT = 2076,
146     KEY_META_RIGHT = 2077,
147     KEY_FUNCTION = 2078,
148     KEY_SYSRQ = 2079,
149     KEY_BREAK = 2080,
150     KEY_MOVE_HOME = 2081,
151     KEY_MOVE_END = 2082,
152     KEY_INSERT = 2083,
153     KEY_FORWARD = 2084,
154     KEY_MEDIA_PLAY = 2085,
155     KEY_MEDIA_PAUSE = 2086,
156     KEY_MEDIA_CLOSE = 2087,
157     KEY_MEDIA_EJECT = 2088,
158     KEY_MEDIA_RECORD = 2089,
159     KEY_F1 = 2090,
160     KEY_F2 = 2091,
161     KEY_F3 = 2092,
162     KEY_F4 = 2093,
163     KEY_F5 = 2094,
164     KEY_F6 = 2095,
165     KEY_F7 = 2096,
166     KEY_F8 = 2097,
167     KEY_F9 = 2098,
168     KEY_F10 = 2099,
169     KEY_F11 = 2100,
170     KEY_F12 = 2101,
171     KEY_NUM_LOCK = 2102,
172     KEY_NUMPAD_0 = 2103,
173     KEY_NUMPAD_1 = 2104,
174     KEY_NUMPAD_2 = 2105,
175     KEY_NUMPAD_3 = 2106,
176     KEY_NUMPAD_4 = 2107,
177     KEY_NUMPAD_5 = 2108,
178     KEY_NUMPAD_6 = 2109,
179     KEY_NUMPAD_7 = 2110,
180     KEY_NUMPAD_8 = 2111,
181     KEY_NUMPAD_9 = 2112,
182     KEY_NUMPAD_DIVIDE = 2113,
183     KEY_NUMPAD_MULTIPLY = 2114,
184     KEY_NUMPAD_SUBTRACT = 2115,
185     KEY_NUMPAD_ADD = 2116,
186     KEY_NUMPAD_DOT = 2117,
187     KEY_NUMPAD_COMMA = 2118,
188     KEY_NUMPAD_ENTER = 2119,
189     KEY_NUMPAD_EQUALS = 2120,
190     KEY_NUMPAD_LEFT_PAREN = 2121,
191     KEY_NUMPAD_RIGHT_PAREN = 2122,
192     KEY_VIRTUAL_MULTITASK = 2210,
193     KEY_SLEEP = 2600,
194     KEY_ZENKAKU_HANKAKU = 2601,
195     KEY_102ND = 2602,
196     KEY_RO = 2603,
197     KEY_KATAKANA = 2604,
198     KEY_HIRAGANA = 2605,
199     KEY_HENKAN = 2606,
200     KEY_KATAKANA_HIRAGANA = 2607,
201     KEY_MUHENKAN = 2608,
202     KEY_LINEFEED = 2609,
203     KEY_MACRO = 2610,
204     KEY_NUMPAD_PLUSMINUS = 2611,
205     KEY_SCALE = 2612,
206     KEY_HANGUEL = 2613,
207     KEY_HANJA = 2614,
208     KEY_YEN = 2615,
209     KEY_STOP = 2616,
210     KEY_AGAIN = 2617,
211     KEY_PROPS = 2618,
212     KEY_UNDO = 2619,
213     KEY_COPY = 2620,
214     KEY_OPEN = 2621,
215     KEY_PASTE = 2622,
216     KEY_FIND = 2623,
217     KEY_CUT = 2624,
218     KEY_HELP = 2625,
219     KEY_CALC = 2626,
220     KEY_FILE = 2627,
221     KEY_BOOKMARKS = 2628,
222     KEY_NEXT = 2629,
223     KEY_PLAYPAUSE = 2630,
224     KEY_PREVIOUS = 2631,
225     KEY_STOPCD = 2632,
226     KEY_CONFIG = 2634,
227     KEY_REFRESH = 2635,
228     KEY_EXIT = 2636,
229     KEY_EDIT = 2637,
230     KEY_SCROLLUP = 2638,
231     KEY_SCROLLDOWN = 2639,
232     KEY_NEW = 2640,
233     KEY_REDO = 2641,
234     KEY_CLOSE = 2642,
235     KEY_PLAY = 2643,
236     KEY_BASSBOOST = 2644,
237     KEY_PRINT = 2645,
238     KEY_CHAT = 2646,
239     KEY_FINANCE = 2647,
240     KEY_CANCEL = 2648,
241     KEY_KBDILLUM_TOGGLE = 2649,
242     KEY_KBDILLUM_DOWN = 2650,
243     KEY_KBDILLUM_UP = 2651,
244     KEY_SEND = 2652,
245     KEY_REPLY = 2653,
246     KEY_FORWARDMAIL = 2654,
247     KEY_SAVE = 2655,
248     KEY_DOCUMENTS = 2656,
249     KEY_VIDEO_NEXT = 2657,
250     KEY_VIDEO_PREV = 2658,
251     KEY_BRIGHTNESS_CYCLE = 2659,
252     KEY_BRIGHTNESS_ZERO = 2660,
253     KEY_DISPLAY_OFF = 2661,
254     KEY_BTN_MISC = 2662,
255     KEY_GOTO = 2663,
256     KEY_INFO = 2664,
257     KEY_PROGRAM = 2665,
258     KEY_PVR = 2666,
259     KEY_SUBTITLE = 2667,
260     KEY_FULL_SCREEN = 2668,
261     KEY_KEYBOARD = 2669,
262     KEY_ASPECT_RATIO = 2670,
263     KEY_PC = 2671,
264     KEY_TV = 2672,
265     KEY_TV2 = 2673,
266     KEY_VCR = 2674,
267     KEY_VCR2 = 2675,
268     KEY_SAT = 2676,
269     KEY_CD = 2677,
270     KEY_TAPE = 2678,
271     KEY_TUNER = 2679,
272     KEY_PLAYER = 2680,
273     KEY_DVD = 2681,
274     KEY_AUDIO = 2682,
275     KEY_VIDEO = 2683,
276     KEY_MEMO = 2684,
277     KEY_CALENDAR = 2685,
278     KEY_RED = 2686,
279     KEY_GREEN = 2687,
280     KEY_YELLOW = 2688,
281     KEY_BLUE = 2689,
282     KEY_CHANNELUP = 2690,
283     KEY_CHANNELDOWN = 2691,
284     KEY_LAST = 2692,
285     KEY_RESTART = 2693,
286     KEY_SLOW = 2694,
287     KEY_SHUFFLE = 2695,
288     KEY_VIDEOPHONE = 2696,
289     KEY_GAMES = 2697,
290     KEY_ZOOMIN = 2698,
291     KEY_ZOOMOUT = 2699,
292     KEY_ZOOMRESET = 2700,
293     KEY_WORDPROCESSOR = 2701,
294     KEY_EDITOR = 2702,
295     KEY_SPREADSHEET = 2703,
296     KEY_GRAPHICSEDITOR = 2704,
297     KEY_PRESENTATION = 2705,
298     KEY_DATABASE = 2706,
299     KEY_NEWS = 2707,
300     KEY_VOICEMAIL = 2708,
301     KEY_ADDRESSBOOK = 2709,
302     KEY_MESSENGER = 2710,
303     KEY_BRIGHTNESS_TOGGLE = 2711,
304     KEY_SPELLCHECK = 2712,
305     KEY_COFFEE = 2713,
306     KEY_MEDIA_REPEAT = 2714,
307     KEY_IMAGES = 2715,
308     KEY_BUTTONCONFIG = 2716,
309     KEY_TASKMANAGER = 2717,
310     KEY_JOURNAL = 2718,
311     KEY_CONTROLPANEL = 2719,
312     KEY_APPSELECT = 2720,
313     KEY_SCREENSAVER = 2721,
314     KEY_ASSISTANT = 2722,
315     KEY_KBD_LAYOUT_NEXT = 2723,
316     KEY_BRIGHTNESS_MIN = 2724,
317     KEY_BRIGHTNESS_MAX = 2725,
318     KEY_KBDINPUTASSIST_PREV = 2726,
319     KEY_KBDINPUTASSIST_NEXT = 2727,
320     KEY_KBDINPUTASSIST_PREVGROUP = 2728,
321     KEY_KBDINPUTASSIST_NEXTGROUP = 2729,
322     KEY_KBDINPUTASSIST_ACCEPT = 2730,
323     KEY_KBDINPUTASSIST_CANCEL = 2731,
324     KEY_FRONT = 2800,
325     KEY_SETUP = 2801,
326     KEY_WAKEUP = 2802,
327     KEY_SENDFILE = 2803,
328     KEY_DELETEFILE = 2804,
329     KEY_XFER = 2805,
330     KEY_PROG1 = 2806,
331     KEY_PROG2 = 2807,
332     KEY_MSDOS = 2808,
333     KEY_SCREENLOCK = 2809,
334     KEY_DIRECTION_ROTATE_DISPLAY = 2810,
335     KEY_CYCLEWINDOWS = 2811,
336     KEY_COMPUTER = 2812,
337     KEY_EJECTCLOSECD = 2813,
338     KEY_ISO = 2814,
339     KEY_MOVE = 2815,
340     KEY_F13 = 2816,
341     KEY_F14 = 2817,
342     KEY_F15 = 2818,
343     KEY_F16 = 2819,
344     KEY_F17 = 2820,
345     KEY_F18 = 2821,
346     KEY_F19 = 2822,
347     KEY_F20 = 2823,
348     KEY_F21 = 2824,
349     KEY_F22 = 2825,
350     KEY_F23 = 2826,
351     KEY_F24 = 2827,
352     KEY_PROG3 = 2828,
353     KEY_PROG4 = 2829,
354     KEY_DASHBOARD = 2830,
355     KEY_SUSPEND = 2831,
356     KEY_HP = 2832,
357     KEY_SOUND = 2833,
358     KEY_QUESTION = 2834,
359     KEY_CONNECT = 2836,
360     KEY_SPORT = 2837,
361     KEY_SHOP = 2838,
362     KEY_ALTERASE = 2839,
363     KEY_SWITCHVIDEOMODE = 2841,
364     KEY_BATTERY = 2842,
365     KEY_BLUETOOTH = 2843,
366     KEY_WLAN = 2844,
367     KEY_UWB = 2845,
368     KEY_WWAN_WIMAX = 2846,
369     KEY_RFKILL = 2847,
370     KEY_CHANNEL = 3001,
371     KEY_BTN_0 = 3100,
372     KEY_BTN_1 = 3101,
373     KEY_BTN_2 = 3102,
374     KEY_BTN_3 = 3103,
375     KEY_BTN_4 = 3104,
376     KEY_BTN_5 = 3105,
377     KEY_BTN_6 = 3106,
378     KEY_BTN_7 = 3107,
379     KEY_BTN_8 = 3108,
380     KEY_BTN_9 = 3109,
381 } OH_NativeXComponent_KeyCode;
382 
383 /**
384  * @brief Represents the key event action.
385  *
386  * @since 10
387  * @version 1.0
388  */
389 typedef enum {
390     OH_NATIVEXCOMPONENT_KEY_ACTION_UNKNOWN = -1,
391     OH_NATIVEXCOMPONENT_KEY_ACTION_DOWN = 0,
392     OH_NATIVEXCOMPONENT_KEY_ACTION_UP,
393 } OH_NativeXComponent_KeyAction;
394 
395 #ifdef __cplusplus
396 };
397 #endif
398 #endif // _NATIVE_INTERFACE_XCOMPONENT_KEY_EVENT_H_
399 /** @} */