名称	描述
oh_axis_type.h	输入设备的轴事件结构和枚举。
oh_input_manager.h	提供事件注入和关键状态查询等功能。
oh_key_code.h	按键设备的键码值。

结构体

展开

名称	描述
struct Input_InterceptorEventCallback	拦截回调事件结构体，拦截鼠标事件、触摸事件和轴事件。

类型定义

展开

名称	描述
typedef enum InputEvent_AxisType InputEvent_AxisType	输入设备的轴类型。
typedef enum InputEvent_AxisEventType InputEvent_AxisEventType	输入设备的轴事件类型。
typedef enum InputEvent_AxisAction InputEvent_AxisAction	轴事件动作。
typedef enum Input_KeyStateAction Input_KeyStateAction	按键状态的枚举值。
typedef enum Input_KeyEventAction Input_KeyEventAction	按键事件类型的枚举值。
typedef enum Input_MouseEventAction Input_MouseEventAction	鼠标动作的枚举值。
typedef enum InputEvent_MouseAxis InputEvent_MouseAxis	鼠标轴事件类型。
typedef enum Input_MouseEventButton Input_MouseEventButton	鼠标按键的枚举值。
typedef enum Input_TouchEventAction Input_TouchEventAction	触摸动作的枚举值。
typedef enum InputEvent_SourceType InputEvent_SourceType	输入事件源类型。
typedef struct Input_KeyState Input_KeyState	定义按键信息，用于标识按键行为。例如，“Ctrl”按键信息包含键值和键类型。
typedef struct Input_KeyEvent Input_KeyEvent	要注入的按键事件。
typedef struct Input_MouseEvent Input_MouseEvent	要注入的鼠标事件。
typedef struct Input_TouchEvent Input_TouchEvent	要注入的触摸事件。
typedef struct Input_AxisEvent Input_AxisEvent	轴事件。
typedef enum Input_Result Input_Result	错误码枚举值。
typedef void(* Input_KeyEventCallback) (const Input_KeyEvent *keyEvent)	按键事件的回调函数，keyEvent的生命周期为回调函数内。
typedef void(* Input_MouseEventCallback) (const Input_MouseEvent *mouseEvent)	鼠标事件的回调函数，mouseEvent的生命周期为回调函数内。
typedef void(* Input_TouchEventCallback) (const Input_TouchEvent *touchEvent)	触摸事件的回调函数，touchEvent的生命周期为回调函数内。
typedef void(* Input_AxisEventCallback) (const Input_AxisEvent *axisEvent)	轴事件的回调函数，axisEvent的生命周期为回调函数内。
typedef struct Input_InterceptorEventCallback Input_InterceptorEventCallback	拦截回调事件结构体，拦截鼠标事件、触摸事件和轴事件。
typedef struct Input_InterceptorOptions Input_InterceptorOptions	事件拦截选项。

枚举

展开

名称	描述
InputEvent_AxisType { AXIS_TYPE_UNKNOWN, AXIS_TYPE_SCROLL_VERTICAL, AXIS_TYPE_SCROLL_HORIZONTAL, AXIS_TYPE_PINCH, AXIS_TYPE_ROTATE }	输入设备的轴类型。
InputEvent_AxisEventType { AXIS_EVENT_TYPE_PINCH = 1, AXIS_EVENT_TYPE_SCROLL = 2 }	输入设备的轴事件类型。
InputEvent_AxisAction { AXIS_ACTION_CANCEL = 0, AXIS_ACTION_BEGIN, AXIS_ACTION_UPDATE, AXIS_ACTION_END }	轴事件动作。
Input_KeyStateAction { KEY_DEFAULT = -1, KEY_PRESSED = 0, KEY_RELEASED = 1, KEY_SWITCH_ON = 2, KEY_SWITCH_OFF = 3 }	按键状态的枚举值。
Input_KeyEventAction { KEY_ACTION_CANCEL = 0, KEY_ACTION_DOWN = 1, KEY_ACTION_UP = 2 }	按键事件类型的枚举值。
Input_MouseEventAction { MOUSE_ACTION_CANCEL = 0, MOUSE_ACTION_MOVE = 1, MOUSE_ACTION_BUTTON_DOWN = 2, MOUSE_ACTION_BUTTON_UP = 3, MOUSE_ACTION_AXIS_BEGIN = 4, MOUSE_ACTION_AXIS_UPDATE = 5, MOUSE_ACTION_AXIS_END = 6 }	鼠标动作的枚举值。
InputEvent_MouseAxis { MOUSE_AXIS_SCROLL_VERTICAL = 0, MOUSE_AXIS_SCROLL_HORIZONTAL = 1 }	鼠标轴事件类型。
Input_MouseEventButton { MOUSE_BUTTON_NONE = -1, MOUSE_BUTTON_LEFT = 0, MOUSE_BUTTON_MIDDLE = 1, MOUSE_BUTTON_RIGHT = 2, MOUSE_BUTTON_FORWARD = 3, MOUSE_BUTTON_BACK = 4 }	鼠标按键的枚举值。
Input_TouchEventAction { TOUCH_ACTION_CANCEL = 0, TOUCH_ACTION_DOWN = 1, TOUCH_ACTION_MOVE = 2, TOUCH_ACTION_UP = 3 }	触摸动作的枚举值。
InputEvent_SourceType { SOURCE_TYPE_MOUSE = 1, SOURCE_TYPE_TOUCHSCREEN = 2, SOURCE_TYPE_TOUCHPAD = 3 }	输入事件源类型。
Input_Result { INPUT_SUCCESS = 0, INPUT_PERMISSION_DENIED = 201, INPUT_NOT_SYSTEM_APPLICATION = 202, INPUT_PARAMETER_ERROR = 401, INPUT_SERVICE_EXCEPTION = 3800001, INPUT_REPEAT_INTERCEPTOR = 4200001 }	错误码枚举值。
Input_KeyCode { KEYCODE_UNKNOWN = -1, KEYCODE_FN = 0, KEYCODE_VOLUME_UP = 16, KEYCODE_VOLUME_DOWN = 17, KEYCODE_POWER = 18, KEYCODE_CAMERA = 19, KEYCODE_VOLUME_MUTE = 22, KEYCODE_MUTE = 23, KEYCODE_BRIGHTNESS_UP = 40, KEYCODE_BRIGHTNESS_DOWN = 41, KEYCODE_0 = 2000, KEYCODE_1 = 2001, KEYCODE_2 = 2002, KEYCODE_3 = 2003, KEYCODE_4 = 2004, KEYCODE_5 = 2005, KEYCODE_6 = 2006, KEYCODE_7 = 2007, KEYCODE_8 = 2008, KEYCODE_9 = 2009, KEYCODE_STAR = 2010, KEYCODE_POUND = 2011, KEYCODE_DPAD_UP = 2012, KEYCODE_DPAD_DOWN = 2013, KEYCODE_DPAD_LEFT = 2014, KEYCODE_DPAD_RIGHT = 2015, KEYCODE_DPAD_CENTER = 2016, KEYCODE_A = 2017, KEYCODE_B = 2018, KEYCODE_C = 2019, KEYCODE_D = 2020, KEYCODE_E = 2021, KEYCODE_F = 2022, KEYCODE_G = 2023, KEYCODE_H = 2024, KEYCODE_I = 2025, KEYCODE_J = 2026, KEYCODE_K = 2027, KEYCODE_L = 2028, KEYCODE_M = 2029, KEYCODE_N = 2030, KEYCODE_O = 2031, KEYCODE_P = 2032, KEYCODE_Q = 2033, KEYCODE_R = 2034, KEYCODE_S = 2035, KEYCODE_T = 2036, KEYCODE_U = 2037, KEYCODE_V = 2038, KEYCODE_W = 2039, KEYCODE_X = 2040, KEYCODE_Y = 2041, KEYCODE_Z = 2042, KEYCODE_COMMA = 2043, KEYCODE_PERIOD = 2044, KEYCODE_ALT_LEFT = 2045, KEYCODE_ALT_RIGHT = 2046, KEYCODE_SHIFT_LEFT = 2047, KEYCODE_SHIFT_RIGHT = 2048, KEYCODE_TAB = 2049, KEYCODE_SPACE = 2050, KEYCODE_SYM = 2051, KEYCODE_EXPLORER = 2052, KEYCODE_ENVELOPE = 2053, KEYCODE_ENTER = 2054, KEYCODE_DEL = 2055, KEYCODE_GRAVE = 2056, KEYCODE_MINUS = 2057, KEYCODE_EQUALS = 2058, KEYCODE_LEFT_BRACKET = 2059, KEYCODE_RIGHT_BRACKET = 2060, KEYCODE_BACKSLASH = 2061, KEYCODE_SEMICOLON = 2062, KEYCODE_APOSTROPHE = 2063, KEYCODE_SLASH = 2064, KEYCODE_AT = 2065, KEYCODE_PLUS = 2066, KEYCODE_MENU = 2067, KEYCODE_PAGE_UP = 2068, KEYCODE_PAGE_DOWN = 2069, KEYCODE_ESCAPE = 2070, KEYCODE_FORWARD_DEL = 2071, KEYCODE_CTRL_LEFT = 2072, KEYCODE_CTRL_RIGHT = 2073, KEYCODE_CAPS_LOCK = 2074, KEYCODE_SCROLL_LOCK = 2075, KEYCODE_META_LEFT = 2076, KEYCODE_META_RIGHT = 2077, KEYCODE_FUNCTION = 2078, KEYCODE_SYSRQ = 2079, KEYCODE_BREAK = 2080, KEYCODE_MOVE_HOME = 2081, KEYCODE_MOVE_END = 2082, KEYCODE_INSERT = 2083, KEYCODE_FORWARD = 2084, KEYCODE_MEDIA_PLAY = 2085, KEYCODE_MEDIA_PAUSE = 2086, KEYCODE_MEDIA_CLOSE = 2087, KEYCODE_MEDIA_EJECT = 2088, KEYCODE_MEDIA_RECORD = 2089, KEYCODE_F1 = 2090, KEYCODE_F2 = 2091, KEYCODE_F3 = 2092, KEYCODE_F4 = 2093, KEYCODE_F5 = 2094, KEYCODE_F6 = 2095, KEYCODE_F7 = 2096, KEYCODE_F8 = 2097, KEYCODE_F9 = 2098, KEYCODE_F10 = 2099, KEYCODE_F11 = 2100, KEYCODE_F12 = 2101, KEYCODE_NUM_LOCK = 2102, KEYCODE_NUMPAD_0 = 2103, KEYCODE_NUMPAD_1 = 2104, KEYCODE_NUMPAD_2 = 2105, KEYCODE_NUMPAD_3 = 2106, KEYCODE_NUMPAD_4 = 2107, KEYCODE_NUMPAD_5 = 2108, KEYCODE_NUMPAD_6 = 2109, KEYCODE_NUMPAD_7 = 2110, KEYCODE_NUMPAD_8 = 2111, KEYCODE_NUMPAD_9 = 2112, KEYCODE_NUMPAD_DIVIDE = 2113, KEYCODE_NUMPAD_MULTIPLY = 2114, KEYCODE_NUMPAD_SUBTRACT = 2115, KEYCODE_NUMPAD_ADD = 2116, KEYCODE_NUMPAD_DOT = 2117, KEYCODE_NUMPAD_COMMA = 2118, KEYCODE_NUMPAD_ENTER = 2119, KEYCODE_NUMPAD_EQUALS = 2120, KEYCODE_NUMPAD_LEFT_PAREN = 2121, KEYCODE_NUMPAD_RIGHT_PAREN = 2122 }	键码值。

函数

展开

名称	描述
Input_Result OH_Input_GetKeyState (struct Input_KeyState *keyState)	查询按键状态的枚举对象。
struct Input_KeyState * OH_Input_CreateKeyState ()	创建按键状态的枚举对象。
void OH_Input_DestroyKeyState (struct Input_KeyState **keyState)	销毁按键状态的枚举对象。
void OH_Input_SetKeyCode (struct Input_KeyState *keyState, int32_t keyCode)	设置按键状态对象的键值。
int32_t OH_Input_GetKeyCode (const struct Input_KeyState *keyState)	获取按键状态对象的键值。
void OH_Input_SetKeyPressed (struct Input_KeyState *keyState, int32_t keyAction)	设置按键状态对象的按键是否按下。
int32_t OH_Input_GetKeyPressed (const struct Input_KeyState *keyState)	获取按键状态对象的按键是否按下。
void OH_Input_SetKeySwitch (struct Input_KeyState *keyState, int32_t keySwitch)	设置按键状态对象的按键开关。
int32_t OH_Input_GetKeySwitch (const struct Input_KeyState *keyState)	获取按键状态对象的按键开关。
int32_t OH_Input_InjectKeyEvent (const struct Input_KeyEvent *keyEvent)	注入按键事件。
struct Input_KeyEvent * OH_Input_CreateKeyEvent ()	创建按键事件对象。
void OH_Input_DestroyKeyEvent (struct Input_KeyEvent **keyEvent)	销毁按键事件对象。
void OH_Input_SetKeyEventAction (struct Input_KeyEvent *keyEvent, int32_t action)	设置按键事件类型。
int32_t OH_Input_GetKeyEventAction (const struct Input_KeyEvent *keyEvent)	获取按键事件类型。
void OH_Input_SetKeyEventKeyCode (struct Input_KeyEvent *keyEvent, int32_t keyCode)	设置按键事件的键值。
int32_t OH_Input_GetKeyEventKeyCode (const struct Input_KeyEvent *keyEvent)	获取按键事件的键值。
void OH_Input_SetKeyEventActionTime (struct Input_KeyEvent *keyEvent, int64_t actionTime)	设置按键事件发生的时间。
int64_t OH_Input_GetKeyEventActionTime (const struct Input_KeyEvent *keyEvent)	获取按键事件发生的时间。
int32_t OH_Input_InjectMouseEvent (const struct Input_MouseEvent *mouseEvent)	注入鼠标事件。
struct Input_MouseEvent * OH_Input_CreateMouseEvent ()	创建鼠标事件对象。
void OH_Input_DestroyMouseEvent (struct Input_MouseEvent **mouseEvent)	销毁鼠标事件对象。
void OH_Input_SetMouseEventAction (struct Input_MouseEvent *mouseEvent, int32_t action)	设置鼠标事件的动作。
int32_t OH_Input_GetMouseEventAction (const struct Input_MouseEvent *mouseEvent)	获取鼠标事件的动作。
void OH_Input_SetMouseEventDisplayX (struct Input_MouseEvent *mouseEvent, int32_t displayX)	设置鼠标事件的屏幕X坐标。
int32_t OH_Input_GetMouseEventDisplayX (const struct Input_MouseEvent *mouseEvent)	获取鼠标事件的屏幕X坐标。
void OH_Input_SetMouseEventDisplayY (struct Input_MouseEvent *mouseEvent, int32_t displayY)	设置鼠标事件的屏幕Y坐标。
int32_t OH_Input_GetMouseEventDisplayY (const struct Input_MouseEvent *mouseEvent)	获取鼠标事件的屏幕Y坐标。
void OH_Input_SetMouseEventButton (struct Input_MouseEvent *mouseEvent, int32_t button)	设置鼠标事件的按键。
int32_t OH_Input_GetMouseEventButton (const struct Input_MouseEvent *mouseEvent)	获取鼠标事件的按键。
void OH_Input_SetMouseEventAxisType (struct Input_MouseEvent *mouseEvent, int32_t axisType)	设置鼠标轴事件的类型。
int32_t OH_Input_GetMouseEventAxisType (const struct Input_MouseEvent *mouseEvent)	获取鼠标轴事件的类型。
void OH_Input_SetMouseEventAxisValue (struct Input_MouseEvent *mouseEvent, float axisValue)	设置鼠标轴事件的值。
float OH_Input_GetMouseEventAxisValue (const struct Input_MouseEvent *mouseEvent)	获取鼠标轴事件的值。
void OH_Input_SetMouseEventActionTime (struct Input_MouseEvent *mouseEvent, int64_t actionTime)	设置鼠标事件发生的时间。
int64_t OH_Input_GetMouseEventActionTime (const struct Input_MouseEvent *mouseEvent)	获取鼠标事件发生的时间。
int32_t OH_Input_InjectTouchEvent (const struct Input_TouchEvent *touchEvent)	注入触摸事件。
struct Input_TouchEvent * OH_Input_CreateTouchEvent ()	创建触屏事件对象。
void OH_Input_DestroyTouchEvent (struct Input_TouchEvent **touchEvent)	销毁触屏事件对象。
void OH_Input_SetTouchEventAction (struct Input_TouchEvent *touchEvent, int32_t action)	设置触屏事件的动作。
int32_t OH_Input_GetTouchEventAction (const struct Input_TouchEvent *touchEvent)	获取触屏事件的动作。
void OH_Input_SetTouchEventFingerId (struct Input_TouchEvent *touchEvent, int32_t id)	设置触屏事件的手指ID。
int32_t OH_Input_GetTouchEventFingerId (const struct Input_TouchEvent *touchEvent)	获取触屏事件的手指ID。
void OH_Input_SetTouchEventDisplayX (struct Input_TouchEvent *touchEvent, int32_t displayX)	设置触屏事件的屏幕X坐标。
int32_t OH_Input_GetTouchEventDisplayX (const struct Input_TouchEvent *touchEvent)	获取触屏事件的屏幕X坐标。
void OH_Input_SetTouchEventDisplayY (struct Input_TouchEvent *touchEvent, int32_t displayY)	设置触屏事件的屏幕Y坐标。
int32_t OH_Input_GetTouchEventDisplayY (const struct Input_TouchEvent *touchEvent)	获取触屏事件的屏幕Y坐标。
void OH_Input_SetTouchEventActionTime (struct Input_TouchEvent *touchEvent, int64_t actionTime)	设置触摸事件发生的时间。
int64_t OH_Input_GetTouchEventActionTime (const struct Input_TouchEvent *touchEvent)	获取触摸事件发生的时间。
void OH_Input_CancelInjection ()	取消事件注入并撤销授权。
Input_AxisEvent * OH_Input_CreateAxisEvent (void)	创建轴事件对象实例。
Input_Result OH_Input_DestroyAxisEvent (Input_AxisEvent **axisEvent)	销毁轴事件对象实例。
Input_Result OH_Input_SetAxisEventAction (Input_AxisEvent *axisEvent, InputEvent_AxisAction action)	设置轴事件的动作。
Input_Result OH_Input_GetAxisEventAction (const Input_AxisEvent axisEvent, InputEvent_AxisAction action)	获取轴事件的动作。
Input_Result OH_Input_SetAxisEventDisplayX (Input_AxisEvent *axisEvent, float displayX)	设置轴事件的X坐标。
Input_Result OH_Input_GetAxisEventDisplayX (const Input_AxisEvent axisEvent, float displayX)	获取轴事件的X坐标。
Input_Result OH_Input_SetAxisEventDisplayY (Input_AxisEvent *axisEvent, float displayY)	设置轴事件的Y坐标。
Input_Result OH_Input_GetAxisEventDisplayY (const Input_AxisEvent axisEvent, float displayY)	获取轴事件的Y坐标。
Input_Result OH_Input_SetAxisEventAxisValue (Input_AxisEvent *axisEvent, InputEvent_AxisType axisType, double axisValue)	设置轴事件指定轴类型的轴值。
Input_Result OH_Input_GetAxisEventAxisValue (const Input_AxisEvent axisEvent, InputEvent_AxisType axisType, double axisValue)	获取轴事件指定轴类型的轴值。
Input_Result OH_Input_SetAxisEventActionTime (Input_AxisEvent *axisEvent, int64_t actionTime)	设置轴事件发生的时间。
Input_Result OH_Input_GetAxisEventActionTime (const Input_AxisEvent axisEvent, int64_t actionTime)	获取轴事件发生的时间。
Input_Result OH_Input_SetAxisEventType (Input_AxisEvent *axisEvent, InputEvent_AxisEventType axisEventType)	设置轴事件类型。
Input_Result OH_Input_GetAxisEventType (const Input_AxisEvent axisEvent, InputEvent_AxisEventType axisEventType)	获取轴事件类型。
Input_Result OH_Input_SetAxisEventSourceType (Input_AxisEvent *axisEvent, InputEvent_SourceType sourceType)	设置轴事件源类型。
Input_Result OH_Input_GetAxisEventSourceType (const Input_AxisEvent axisEvent, InputEvent_SourceType sourceType)	获取轴事件源类型。
Input_Result OH_Input_AddKeyEventMonitor (Input_KeyEventCallback callback)	添加按键事件监听。
Input_Result OH_Input_AddMouseEventMonitor (Input_MouseEventCallback callback)	添加鼠标事件监听,包含鼠标点击，移动，不包含滚轮事件，滚轮事件归属于轴事件。
Input_Result OH_Input_AddTouchEventMonitor (Input_TouchEventCallback callback)	添加触摸事件监听。
Input_Result OH_Input_AddAxisEventMonitorForAll (Input_AxisEventCallback callback)	添加所有类型轴事件监听，轴事件类型定义在InputEvent_AxisEventType中。
Input_Result OH_Input_AddAxisEventMonitor (InputEvent_AxisEventType axisEventType, Input_AxisEventCallback callback)	添加指定类型的轴事件监听，轴事件类型定义在InputEvent_AxisEventType中。
Input_Result OH_Input_RemoveKeyEventMonitor (Input_KeyEventCallback callback)	移除按键事件监听。
Input_Result OH_Input_RemoveMouseEventMonitor (Input_MouseEventCallback callback)	移除鼠标事件监听。
Input_Result OH_Input_RemoveTouchEventMonitor (Input_TouchEventCallback callback)	移除触摸事件监听。
Input_Result OH_Input_RemoveAxisEventMonitorForAll (Input_AxisEventCallback callback)	移除所有类型轴事件监听。
Input_Result OH_Input_RemoveAxisEventMonitor (InputEvent_AxisEventType axisEventType, Input_AxisEventCallback callback)	移除指定类型轴事件监听，轴事件类型定义在InputEvent_AxisEventType中。
Input_Result OH_Input_AddKeyEventInterceptor (Input_KeyEventCallback callback, Input_InterceptorOptions *option)	添加按键事件的拦截,重复添加只有第一次生效。
Input_Result OH_Input_AddInputEventInterceptor (Input_InterceptorEventCallback callback Input_InterceptorOptions option)	添加输入事件拦截，包括鼠标、触摸和轴事件，重复添加只有第一次生效。
Input_Result OH_Input_RemoveKeyEventInterceptor ()	移除按键事件拦截。
Input_Result OH_Input_RemoveInputEventInterceptor ()	移除输入事件拦截，包括鼠标、触摸和轴事件。

类型定义说明

Input_AxisEvent

收起
自动换行
深色代码主题
复制
typedef struct Input_AxisEventInput_AxisEvent

描述

轴事件。

起始版本： 12

Input_AxisEventCallback

收起
自动换行
深色代码主题
复制
typedef void(* Input_AxisEventCallback) (const Input_AxisEvent *axisEvent)

描述

轴事件的回调函数，axisEvent的生命周期为回调函数内。

起始版本： 12

Input_InterceptorEventCallback

收起
自动换行
深色代码主题
复制
typedef struct Input_InterceptorEventCallbackInput_InterceptorEventCallback

描述

拦截回调事件结构体，拦截鼠标事件、触摸事件和轴事件。

起始版本： 12

Input_InterceptorOptions

收起
自动换行
深色代码主题
复制
typedef struct Input_InterceptorOptionsInput_InterceptorOptions

描述

事件拦截选项。

起始版本： 12

Input_KeyEvent

收起
自动换行
深色代码主题
复制
typedef struct Input_KeyEventInput_KeyEvent

描述

要注入的按键事件。

起始版本： 12

Input_KeyEventAction

收起
自动换行
深色代码主题
复制
typedef enum Input_KeyEventActionInput_KeyEventAction

描述

按键事件类型的枚举值。

起始版本： 12

Input_KeyEventCallback

收起
自动换行
深色代码主题
复制
typedef void(* Input_KeyEventCallback) (const Input_KeyEvent *keyEvent)

描述

按键事件的回调函数，keyEvent的生命周期为回调函数内。

起始版本： 12

Input_KeyState

收起
自动换行
深色代码主题
复制
typedef struct Input_KeyStateInput_KeyState

描述

定义按键信息，用于标识按键行为。例如，“Ctrl”按键信息包含键值和键类型。

起始版本： 12

Input_KeyStateAction

收起
自动换行
深色代码主题
复制
typedef enum Input_KeyStateActionInput_KeyStateAction

描述

按键状态的枚举值。

起始版本： 12

Input_MouseEvent

收起
自动换行
深色代码主题
复制
typedef struct Input_MouseEventInput_MouseEvent

描述

要注入的鼠标事件。

起始版本： 12

Input_MouseEventAction

收起
自动换行
深色代码主题
复制
typedef enum Input_MouseEventActionInput_MouseEventAction

描述

鼠标动作的枚举值。

起始版本： 12

Input_MouseEventButton

收起
自动换行
深色代码主题
复制
typedef enum Input_MouseEventButtonInput_MouseEventButton

描述

鼠标按键的枚举值。

起始版本： 12

Input_MouseEventCallback

收起
自动换行
深色代码主题
复制
typedef void(* Input_MouseEventCallback) (const Input_MouseEvent *mouseEvent)

描述

鼠标事件的回调函数，mouseEvent的生命周期为回调函数内。

起始版本： 12

Input_Result

收起
自动换行
深色代码主题
复制
typedef enum Input_ResultInput_Result

描述

错误码枚举值。

起始版本： 12

Input_TouchEvent

收起
自动换行
深色代码主题
复制
typedef struct Input_TouchEventInput_TouchEvent

描述

要注入的触摸事件。

起始版本： 12

Input_TouchEventAction

收起
自动换行
深色代码主题
复制
typedef enum Input_TouchEventActionInput_TouchEventAction

描述

触摸动作的枚举值。

起始版本： 12

Input_TouchEventCallback

收起
自动换行
深色代码主题
复制
typedef void(* Input_TouchEventCallback) (const Input_TouchEvent *touchEvent)

描述

触摸事件的回调函数，touchEvent的生命周期为回调函数内。

起始版本： 12

InputEvent_AxisAction

收起
自动换行
深色代码主题
复制
typedef enum InputEvent_AxisActionInputEvent_AxisAction

描述

轴事件动作。

起始版本： 12

InputEvent_AxisEventType

收起
自动换行
深色代码主题
复制
typedef enum InputEvent_AxisEventTypeInputEvent_AxisEventType

描述

输入设备的轴事件类型。

起始版本： 12

InputEvent_AxisType

收起
自动换行
深色代码主题
复制
typedef enum InputEvent_AxisTypeInputEvent_AxisType

描述

输入设备的轴类型。

起始版本： 12

InputEvent_MouseAxis

收起
自动换行
深色代码主题
复制
typedef enum InputEvent_MouseAxisInputEvent_MouseAxis

描述

鼠标轴事件类型。

起始版本： 12

InputEvent_SourceType

收起
自动换行
深色代码主题
复制
typedef enum InputEvent_SourceTypeInputEvent_SourceType

描述

输入事件源类型。

起始版本： 12

枚举类型说明

Input_KeyCode

收起
自动换行
深色代码主题
复制
enum Input_KeyCode

描述

键码值。

起始版本： 12

展开

枚举值	描述
KEYCODE_UNKNOWN	未知按键。
KEYCODE_FN	功能（Fn）键。
KEYCODE_VOLUME_UP	音量增加键。
KEYCODE_VOLUME_DOWN	音量减小键。
KEYCODE_POWER	电源键。
KEYCODE_CAMERA	拍照键。
KEYCODE_VOLUME_MUTE	扬声器静音键。
KEYCODE_MUTE	话筒静音键。
KEYCODE_BRIGHTNESS_UP	亮度调节按键：调亮。
KEYCODE_BRIGHTNESS_DOWN	亮度调节按键：调暗。
KEYCODE_0	按键'0'。
KEYCODE_1	按键'1'。
KEYCODE_2	按键'2'。
KEYCODE_3	按键'3'。
KEYCODE_4	按键'4'。
KEYCODE_5	按键'5'。
KEYCODE_6	按键'6'。
KEYCODE_7	按键'7'。
KEYCODE_8	按键'8'。
KEYCODE_9	按键'9'。
KEYCODE_STAR	按键'*'。
KEYCODE_POUND	按键'#'。
KEYCODE_DPAD_UP	导航键：向上。
KEYCODE_DPAD_DOWN	导航键：向下。
KEYCODE_DPAD_LEFT	导航键：向左。
KEYCODE_DPAD_RIGHT	导航键：向右。
KEYCODE_DPAD_CENTER	导航键：确定键。
KEYCODE_A	按键'A'。
KEYCODE_B	按键'B'。
KEYCODE_C	按键'C'。
KEYCODE_D	按键'D'。
KEYCODE_E	按键'E'。
KEYCODE_F	按键'F'。
KEYCODE_G	按键'G'。
KEYCODE_H	按键'H'。
KEYCODE_I	按键'I'。
KEYCODE_J	按键'J'。
KEYCODE_K	按键'K'。
KEYCODE_L	按键'L'。
KEYCODE_M	按键'M'。
KEYCODE_N	按键'N'。
KEYCODE_O	按键'O'。
KEYCODE_P	按键'P'。
KEYCODE_Q	按键'Q'。
KEYCODE_R	按键'R'。
KEYCODE_S	按键'S'。
KEYCODE_T	按键'T'。
KEYCODE_U	按键'U'。
KEYCODE_V	按键'V'。
KEYCODE_W	按键'W'。
KEYCODE_X	按键'X'。
KEYCODE_Y	按键'Y'。
KEYCODE_Z	按键'Z'。
KEYCODE_COMMA	按键','。
KEYCODE_PERIOD	按键'.'。
KEYCODE_ALT_LEFT	左Alt键。
KEYCODE_ALT_RIGHT	右Alt键。
KEYCODE_SHIFT_LEFT	左Shift键。
KEYCODE_SHIFT_RIGHT	右Shift键。
KEYCODE_TAB	Tab键。
KEYCODE_SPACE	空格键。
KEYCODE_SYM	符号修改器按键。
KEYCODE_EXPLORER	浏览器功能键，此键用于启动浏览器应用程序。
KEYCODE_ENVELOPE	电子邮件功能键，此键用于启动电子邮件应用程序。
KEYCODE_ENTER	回车键。
KEYCODE_DEL	退格键。
KEYCODE_GRAVE	按键'‘’。
KEYCODE_MINUS	按键'-'。
KEYCODE_EQUALS	按键'='。
KEYCODE_LEFT_BRACKET	按键'['。
KEYCODE_RIGHT_BRACKET	按键']'。
KEYCODE_BACKSLASH	按键''。
KEYCODE_SEMICOLON	按键';'。
KEYCODE_APOSTROPHE	按键'''（单引号）。
KEYCODE_SLASH	按键'/'。
KEYCODE_AT	按键'@'。
KEYCODE_PLUS	按键'+'。
KEYCODE_MENU	菜单键。
KEYCODE_PAGE_UP	向上翻页键。
KEYCODE_PAGE_DOWN	向下翻页键。
KEYCODE_ESCAPE	ESC键。
KEYCODE_FORWARD_DEL	删除键。
KEYCODE_CTRL_LEFT	左Ctrl键。
KEYCODE_CTRL_RIGHT	右Ctrl键。
KEYCODE_CAPS_LOCK	大写锁定键。
KEYCODE_SCROLL_LOCK	滚动锁定键。
KEYCODE_META_LEFT	左元修改器键。
KEYCODE_META_RIGHT	右元修改器键。
KEYCODE_FUNCTION	功能键。
KEYCODE_SYSRQ	系统请求/打印屏幕键。
KEYCODE_BREAK	Break/Pause键。
KEYCODE_MOVE_HOME	光标移动到开始键。
KEYCODE_MOVE_END	光标移动到末尾键。
KEYCODE_INSERT	插入键。
KEYCODE_FORWARD	前进键。
KEYCODE_MEDIA_PLAY	多媒体键：播放。
KEYCODE_MEDIA_PAUSE	多媒体键：暂停。
KEYCODE_MEDIA_CLOSE	多媒体键：关闭。
KEYCODE_MEDIA_EJECT	多媒体键：弹出。
KEYCODE_MEDIA_RECORD	多媒体键：录音。
KEYCODE_F1	按键'F1'。
KEYCODE_F2	按键'F2'。
KEYCODE_F3	按键'F3'。
KEYCODE_F4	按键'F4'。
KEYCODE_F5	按键'F5'。
KEYCODE_F6	按键'F6'。
KEYCODE_F7	按键'F7'。
KEYCODE_F8	按键'F8'。
KEYCODE_F9	按键'F9'。
KEYCODE_F10	按键'F10'。
KEYCODE_F11	按键'F11'。
KEYCODE_F12	按键'F12'。
KEYCODE_NUM_LOCK	小键盘锁。
KEYCODE_NUMPAD_0	小键盘按键'0'。
KEYCODE_NUMPAD_1	小键盘按键'1'。
KEYCODE_NUMPAD_2	小键盘按键'2'。
KEYCODE_NUMPAD_3	小键盘按键'3'。
KEYCODE_NUMPAD_4	小键盘按键'4'。
KEYCODE_NUMPAD_5	小键盘按键'5'。
KEYCODE_NUMPAD_6	小键盘按键'6'。
KEYCODE_NUMPAD_7	小键盘按键'7'。
KEYCODE_NUMPAD_8	小键盘按键'8'。
KEYCODE_NUMPAD_9	小键盘按键'9'。
KEYCODE_NUMPAD_DIVIDE	小键盘按键'/'。
KEYCODE_NUMPAD_MULTIPLY	小键盘按键'*'。
KEYCODE_NUMPAD_SUBTRACT	小键盘按键'-'。
KEYCODE_NUMPAD_ADD	小键盘按键'+'。
KEYCODE_NUMPAD_DOT	小键盘按键'.'。
KEYCODE_NUMPAD_COMMA	小键盘按键','。
KEYCODE_NUMPAD_ENTER	小键盘按键回车。
KEYCODE_NUMPAD_EQUALS	小键盘按键'='。
KEYCODE_NUMPAD_LEFT_PAREN	小键盘按键'('。
KEYCODE_NUMPAD_RIGHT_PAREN	小键盘按键')'。

Input_KeyEventAction

收起
自动换行
深色代码主题
复制
enum Input_KeyEventAction

描述

按键事件类型的枚举值。

起始版本： 12

展开

枚举值	描述
KEY_ACTION_CANCEL	按键动作取消。
KEY_ACTION_DOWN	按键按下。
KEY_ACTION_UP	按键抬起。

Input_KeyStateAction

收起
自动换行
深色代码主题
复制
enum Input_KeyStateAction

描述

按键状态的枚举值。

起始版本： 12

展开

枚举值	描述
KEY_DEFAULT	默认状态。
KEY_PRESSED	按键按下。
KEY_RELEASED	按键抬起。
KEY_SWITCH_ON	按键开关使能。
KEY_SWITCH_OFF	按键开关去使能。

Input_MouseEventAction

收起
自动换行
深色代码主题
复制
enum Input_MouseEventAction

描述

鼠标动作的枚举值。

起始版本： 12

展开

枚举值	描述
MOUSE_ACTION_CANCEL	取消鼠标动作。
MOUSE_ACTION_MOVE	移动鼠标。
MOUSE_ACTION_BUTTON_DOWN	按下鼠标。
MOUSE_ACTION_BUTTON_UP	抬起鼠标按键。
MOUSE_ACTION_AXIS_BEGIN	鼠标轴事件开始。
MOUSE_ACTION_AXIS_UPDATE	更新鼠标轴事件。
MOUSE_ACTION_AXIS_END	鼠标轴事件结束。

Input_MouseEventButton

收起
自动换行
深色代码主题
复制
enum Input_MouseEventButton

描述

鼠标按键的枚举值。

起始版本： 12

展开

枚举值	描述
MOUSE_BUTTON_NONE	无效按键。
MOUSE_BUTTON_LEFT	鼠标左键。
MOUSE_BUTTON_MIDDLE	鼠标中间键。
MOUSE_BUTTON_RIGHT	鼠标右键。
MOUSE_BUTTON_FORWARD	鼠标前进键。
MOUSE_BUTTON_BACK	鼠标返回键。

Input_Result

收起
自动换行
深色代码主题
复制
enum Input_Result

描述

错误码枚举值。

起始版本： 12

展开

枚举值	描述
INPUT_SUCCESS	操作成功。
INPUT_PERMISSION_DENIED	权限验证失败。
INPUT_NOT_SYSTEM_APPLICATION	非系统应用。
INPUT_PARAMETER_ERROR	参数检查失败。
INPUT_SERVICE_EXCEPTION	服务异常。
INPUT_REPEAT_INTERCEPTOR	应用创建拦截后，再次执行创建拦截的操作。

Input_TouchEventAction

收起
自动换行
深色代码主题
复制
enum Input_TouchEventAction

描述

触摸动作的枚举值。

起始版本： 12

展开

枚举值	描述
TOUCH_ACTION_CANCEL	触摸取消。
TOUCH_ACTION_DOWN	触摸按下。
TOUCH_ACTION_MOVE	触摸移动。
TOUCH_ACTION_UP	触摸抬起。

InputEvent_AxisAction

收起
自动换行
深色代码主题
复制
enum InputEvent_AxisAction

描述

轴事件动作。

起始版本： 12

展开

枚举值	描述
AXIS_ACTION_CANCEL	取消轴输入事件。自从 12
AXIS_ACTION_BEGIN	开始轴输入事件。自从 12
AXIS_ACTION_UPDATE	轴输入事件中。自从 12
AXIS_ACTION_END	结束轴输入事件。自从 12

InputEvent_AxisEventType

收起
自动换行
深色代码主题
复制
enum InputEvent_AxisEventType

描述

输入设备的轴事件类型。

起始版本： 12

展开

枚举值	描述
AXIS_EVENT_TYPE_PINCH	双指捏合事件，包含AXIS_TYPE_PINCH和AXIS_TYPE_ROTATE两种轴类型。自从 12
AXIS_EVENT_TYPE_SCROLL	滚轴事件，包含AXIS_TYPE_SCROLL_VERTICAL和AXIS_TYPE_SCROLL_HORIZONTAL两种轴类型，其中鼠标滚轮事件仅包含AXIS_TYPE_SCROLL_VERTICAL一种轴类型。自从 12

枚举值

描述

AXIS_EVENT_TYPE_PINCH

双指捏合事件，包含AXIS_TYPE_PINCH和AXIS_TYPE_ROTATE两种轴类型。

自从

AXIS_EVENT_TYPE_SCROLL

滚轴事件，包含AXIS_TYPE_SCROLL_VERTICAL和AXIS_TYPE_SCROLL_HORIZONTAL两种轴类型，其中鼠标滚轮事件仅包含AXIS_TYPE_SCROLL_VERTICAL一种轴类型。

自从

InputEvent_AxisType

收起
自动换行
深色代码主题
复制
enum InputEvent_AxisType

描述

输入设备的轴类型。

起始版本： 12

展开

枚举值	描述
AXIS_TYPE_UNKNOWN	未知轴类型，通常作为初始值。自从 12
AXIS_TYPE_SCROLL_VERTICAL	垂直滚动轴，当您滚动鼠标滚轮或在触摸板上进行单指或双指滑动时，垂直滚动轴的状态改变。自从 12
AXIS_TYPE_SCROLL_HORIZONTAL	水平滚动轴，当您滚动鼠标滚轮或在触摸板上进行双指滑动时，水平滚动轴的状态发生变化。自从 12
AXIS_TYPE_PINCH	捏合轴，用于描述触摸板上的双指捏合手势。自从 12
AXIS_TYPE_ROTATE	旋转轴，用于描述触摸板上的双指旋转手势。自从 12

InputEvent_MouseAxis

收起
自动换行
深色代码主题
复制
enum InputEvent_MouseAxis

描述

鼠标轴事件类型。

起始版本： 12

展开

枚举值	描述
MOUSE_AXIS_SCROLL_VERTICAL	垂直滚动轴。
MOUSE_AXIS_SCROLL_HORIZONTAL	水平滚动轴。

InputEvent_SourceType

收起
自动换行
深色代码主题
复制
enum InputEvent_SourceType

描述

输入事件源类型。

起始版本： 12

展开

枚举值	描述
SOURCE_TYPE_MOUSE	表示输入源生成鼠标光标移动、按钮按下和释放以及滚轮滚动的事件。自从 12
SOURCE_TYPE_TOUCHSCREEN	表示输入源产生触摸屏多点触摸事件。自从 12
SOURCE_TYPE_TOUCHPAD	表示输入源产生触摸板多点触摸事件。自从 12

枚举值

描述

SOURCE_TYPE_MOUSE

表示输入源生成鼠标光标移动、按钮按下和释放以及滚轮滚动的事件。

自从

SOURCE_TYPE_TOUCHSCREEN

表示输入源产生触摸屏多点触摸事件。

自从

SOURCE_TYPE_TOUCHPAD

表示输入源产生触摸板多点触摸事件。

自从

函数说明

OH_Input_AddAxisEventMonitor()

收起
自动换行
深色代码主题
复制
Input_Result OH_Input_AddAxisEventMonitor (InputEvent_AxisEventType axisEventType, Input_AxisEventCallback callback )

描述

添加指定类型的轴事件监听，轴事件类型定义在InputEvent_AxisEventType中。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
axisEventType	要监听的轴事件类型，轴事件类型定义在InputEvent_AxisEventType中。
callback	回调函数，用于接收指定类型的轴事件。

Permission：

ohos.permission.INPUT_MONITORING

返回：

若添加轴事件监听成功，则返回INTO_SUCCESS；若权限校验失败，则返回INPUT_PERMISSION_DENIED；若callback为空，则返回INPUT_PARAMETER_ERROR；若服务异常，则返回INPUT_SERVICE_EXCEPTION。

OH_Input_AddAxisEventMonitorForAll()

收起
自动换行
深色代码主题
复制
Input_Result OH_Input_AddAxisEventMonitorForAll (Input_AxisEventCallback callback)

描述

添加所有类型轴事件监听，轴事件类型定义在InputEvent_AxisEventType中。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
callback	- 回调函数，用于接收轴事件。

Permission：

ohos.permission.INPUT_MONITORING

返回：

OH_Input_AddInputEventInterceptor()

收起
自动换行
深色代码主题
复制
Input_Result OH_Input_AddInputEventInterceptor (Input_InterceptorEventCallback *callback Input_InterceptorOptions * option)

描述

添加输入事件拦截，包括鼠标、触摸和轴事件，重复添加只有第一次生效。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
callback	用于回调输入事件的结构体指针，请参考定义Input_InterceptorEventCallback。
option	输入事件拦截的可选项，传null则使用默认值。

Permission：

ohos.permission.INTERCEPT_INPUT_EVENT

返回：

若添加输入事件的拦截成功，则返回INTO_SUCCESS；若权限校验失败，则返回INPUT_PERMISSION_DENIED；若callback为空，则返回INPUT_PARAMETER_ERROR；若重复添加拦截器，则返回INPUT_REPEAT_INTERCEPTOR；若服务异常；则返回INPUT_SERVICE_EXCEPTION。

OH_Input_AddKeyEventInterceptor()

收起
自动换行
深色代码主题
复制
Input_Result OH_Input_AddKeyEventInterceptor (Input_KeyEventCallback callback, Input_InterceptorOptions * option )

描述

添加按键事件的拦截,重复添加只有第一次生效。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
callback	回调函数，用于接收按键事件。
option	输入事件拦截的可选项，传null则使用默认值。

Permission：

ohos.permission.INTERCEPT_INPUT_EVENT

返回：

若添加按键事件的拦截成功，则返回INTO_SUCCESS；若权限校验失败，则返回INPUT_PERMISSION_DENIED；若callback为空，则返回INPUT_PARAMETER_ERROR；若重复添加拦截器，则返回INPUT_REPEAT_INTERCEPTOR；若服务异常；则返回INPUT_SERVICE_EXCEPTION。

OH_Input_AddKeyEventMonitor()

收起
自动换行
深色代码主题
复制
Input_Result OH_Input_AddKeyEventMonitor (Input_KeyEventCallback callback)

描述

添加按键事件监听。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
callback	回调函数，用于接收按键事件。

Permission：

ohos.permission.INPUT_MONITORING

返回：

若添加按键事件监听成功，则返回INTO_SUCCESS；若权限校验失败，则返回INPUT_PERMISSION_DENIED；若callback为空，则返回INPUT_PARAMETER_ERROR；若服务异常，则返回INPUT_SERVICE_EXCEPTION。

OH_Input_AddMouseEventMonitor()

收起
自动换行
深色代码主题
复制
Input_Result OH_Input_AddMouseEventMonitor (Input_MouseEventCallback callback)

描述

添加鼠标事件监听,包含鼠标点击，移动，不包含滚轮事件，滚轮事件归属于轴事件。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
callback	回调函数，用于接收鼠标事件。

Permission：

ohos.permission.INPUT_MONITORING

返回：

若添加鼠标事件监听成功，则返回INTO_SUCCESS；若权限校验失败，则返回INPUT_PERMISSION_DENIED；若callback为空，则返回INPUT_PARAMETER_ERROR；若服务异常，则返回INPUT_SERVICE_EXCEPTION。

OH_Input_AddTouchEventMonitor()

收起
自动换行
深色代码主题
复制
Input_Result OH_Input_AddTouchEventMonitor (Input_TouchEventCallback callback)

描述

添加触摸事件监听。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
callback	回调函数，用于接收触摸事件。

Permission：

ohos.permission.INPUT_MONITORING

返回：

若添加触摸事件监听成功，则返回INTO_SUCCESS；若权限校验失败，则返回INPUT_PERMISSION_DENIED；若callback为空，则返回INPUT_PARAMETER_ERROR；若服务异常，则返回INPUT_SERVICE_EXCEPTION。

OH_Input_CancelInjection()

收起
自动换行
深色代码主题
复制
void OH_Input_CancelInjection ()

描述

取消事件注入并撤销授权

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

OH_Input_CreateAxisEvent()

收起
自动换行
深色代码主题
复制
Input_AxisEvent* OH_Input_CreateAxisEvent (void )

描述

创建轴事件对象实例。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

返回：

成功返回Input_AxisEvent对象实例，失败则返回null。

OH_Input_CreateKeyEvent()

收起
自动换行
深色代码主题
复制
struct Input_KeyEvent* OH_Input_CreateKeyEvent ()

描述

创建按键事件对象。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

返回：

如果操作成功返回一个Input_KeyEvent指针对象，否则返回空指针。

OH_Input_CreateKeyState()

收起
自动换行
深色代码主题
复制
struct Input_KeyState* OH_Input_CreateKeyState ()

描述

创建按键状态的枚举对象。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

返回：

如果操作成功，

返回一个Input_KeyState指针对象，否则返回空指针。

OH_Input_CreateMouseEvent()

收起
自动换行
深色代码主题
复制
struct Input_MouseEvent* OH_Input_CreateMouseEvent ()

描述

创建鼠标事件对象。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

返回：

如果操作成功返回一个Input_MouseEvent指针对象，否则返回空指针。

OH_Input_CreateTouchEvent()

收起
自动换行
深色代码主题
复制
struct Input_TouchEvent* OH_Input_CreateTouchEvent ()

描述

创建触屏事件对象。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

返回：

如果操作成功返回一个Input_TouchEvent指针对象，否则返回空指针。

OH_Input_DestroyAxisEvent()

收起
自动换行
深色代码主题
复制
Input_Result OH_Input_DestroyAxisEvent (Input_AxisEvent ** axisEvent)

描述

销毁轴事件对象实例。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
axisEvent	轴事件对象实例的指针。

返回：

若销毁成功，则返回INTO_SUCCESS；若axisEvent为NULL或者*axisEvent为NULL，则返回INPUT_PARAMETER_ERROR。

OH_Input_DestroyKeyEvent()

收起
自动换行
深色代码主题
复制
void OH_Input_DestroyKeyEvent (struct Input_KeyEvent ** keyEvent)

描述

销毁按键事件对象。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
keyEvent	按键事件对象

OH_Input_DestroyKeyState()

收起
自动换行
深色代码主题
复制
void OH_Input_DestroyKeyState (struct Input_KeyState ** keyState)

描述

销毁按键状态的枚举对象。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
keyState	按键状态的枚举对象，具体请参考Input_KeyStateAction

OH_Input_DestroyMouseEvent()

收起
自动换行
深色代码主题
复制
void OH_Input_DestroyMouseEvent (struct Input_MouseEvent ** mouseEvent)

描述

销毁鼠标事件对象。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
mouseEvent	鼠标事件对象

OH_Input_DestroyTouchEvent()

收起
自动换行
深色代码主题
复制
void OH_Input_DestroyTouchEvent (struct Input_TouchEvent ** touchEvent)

描述

销毁触屏事件对象。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
touchEvent	触屏事件对象

OH_Input_GetAxisEventAction()

收起
自动换行
深色代码主题
复制
Input_Result OH_Input_GetAxisEventAction (const Input_AxisEvent * axisEvent, InputEvent_AxisAction * action )

描述

获取轴事件的动作。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
axisEvent	轴事件对象。
action	出参，返回轴事件动作，具体请参考在InputEvent_AxisAction。

返回：

若获取轴事件的动作成功，则返回INTO_SUCCESS；若axisEvent或者action为NULL，则返回INPUT_PARAMETER_ERROR。

OH_Input_GetAxisEventActionTime()

收起
自动换行
深色代码主题
复制
Input_Result OH_Input_GetAxisEventActionTime (const Input_AxisEvent * axisEvent, int64_t * actionTime )

描述

获取轴事件发生的时间。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
axisEvent	轴事件对象，请参考Input_AxisEvent。
actionTime	出参，返回轴事件发生的时间。

返回：

若获取轴事件发生的时间成功，则返回INTO_SUCCESS；若axisEvent或者actionTime为NULL，则返回INPUT_PARAMETER_ERROR。

OH_Input_GetAxisEventAxisValue()

收起
自动换行
深色代码主题
复制
Input_Result OH_Input_GetAxisEventAxisValue (const Input_AxisEvent * axisEvent, InputEvent_AxisType axisType, double * axisValue )

描述

获取轴事件指定轴类型的轴值。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
axisEvent	轴事件对象，请参考Input_AxisEvent。
axisType	轴类型，具体请参考InputEvent_AxisType。
axisValue	出参，返回轴事件轴值。

返回：

若获取轴事件指定轴类型的轴值成功，则返回INTO_SUCCESS；若axisEvent或者axisValue为NULL，则返回INPUT_PARAMETER_ERROR。

OH_Input_GetAxisEventDisplayX()

收起
自动换行
深色代码主题
复制
Input_Result OH_Input_GetAxisEventDisplayX (const Input_AxisEvent * axisEvent, float * displayX )

描述

获取轴事件的X坐标。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
axisEvent	轴事件对象。
displayX	出参，返回轴事件X坐标。

返回：

若获取轴事件的X坐标成功，则返回INTO_SUCCESS；若axisEvent或者displayX为NULL，则返回INPUT_PARAMETER_ERROR。

OH_Input_GetAxisEventDisplayY()

收起
自动换行
深色代码主题
复制
Input_Result OH_Input_GetAxisEventDisplayY (const Input_AxisEvent * axisEvent, float * displayY )

描述

获取轴事件的Y坐标。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
axisEvent	轴事件对象，请参考Input_AxisEvent。
displayY	出参，返回轴事件Y坐标。

返回：

若获取轴事件的Y坐标成功，则返回INTO_SUCCESS；若axisEvent或者displayY为NULL，则返回INPUT_PARAMETER_ERROR。

OH_Input_GetAxisEventSourceType()

收起
自动换行
深色代码主题
复制
Input_Result OH_Input_GetAxisEventSourceType (const Input_AxisEvent * axisEvent, InputEvent_SourceType * sourceType )

描述

获取轴事件源类型。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
axisEvent	轴事件对象。
sourceType	出参，返回轴事件源类型，具体请参考InputEvent_SourceType。

返回：

若获取轴事件源类型成功，则返回INTO_SUCCESS；若axisEvent或者sourceType为NULL，则返回INPUT_PARAMETER_ERROR。

OH_Input_GetAxisEventType()

收起
自动换行
深色代码主题
复制
Input_Result OH_Input_GetAxisEventType (const Input_AxisEvent * axisEvent, InputEvent_AxisEventType * axisEventType )

描述

获取轴事件类型。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
axisEvent	轴事件对象。
axisEventType	出参，返回轴事件类型，具体请参考InputEvent_AxisEventType。

返回：

若获取轴事件类型成功，则返回INTO_SUCCESS；若axisEvent或者axisEventType为NULL，则返回INPUT_PARAMETER_ERROR。

OH_Input_GetKeyCode()

收起
自动换行
深色代码主题
复制
int32_t OH_Input_GetKeyCode (const struct Input_KeyState * keyState)

描述

获取按键状态对象的键值。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
keyState	按键状态的枚举对象，具体请参考Input_KeyStateAction

返回：

返回按键状态对象的键值。

OH_Input_GetKeyEventAction()

收起
自动换行
深色代码主题
复制
int32_t OH_Input_GetKeyEventAction (const struct Input_KeyEvent * keyEvent)

描述

获取按键事件类型。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
keyEvent	按键事件对象

返回：

返回按键事件类型

OH_Input_GetKeyEventActionTime()

收起
自动换行
深色代码主题
复制
int64_t OH_Input_GetKeyEventActionTime (const struct Input_KeyEvent * keyEvent)

描述

获取按键事件发生的时间。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
keyEvent	按键事件对象

返回：

返回按键事件发生的时间

OH_Input_GetKeyEventKeyCode()

收起
自动换行
深色代码主题
复制
int32_t OH_Input_GetKeyEventKeyCode (const struct Input_KeyEvent * keyEvent)

描述

获取按键事件的键值。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
keyEvent	按键事件对象

返回：

Key code.

OH_Input_GetKeyPressed()

收起
自动换行
深色代码主题
复制
int32_t OH_Input_GetKeyPressed (const struct Input_KeyState * keyState)

描述

获取按键状态对象的按键是否按下。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
keyState	按键状态的枚举对象，具体请参考Input_KeyStateAction

返回：

返回按键状态对象的按键按下状态。

OH_Input_GetKeyState()

收起
自动换行
深色代码主题
复制
Input_Result OH_Input_GetKeyState (struct Input_KeyState * keyState)

描述

查询按键状态的枚举对象。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
keyState	按键状态的枚举对象，具体请参考Input_KeyStateAction

返回：

如果操作成功，

返回Input_Result#INPUT_SUCCESS；否则返回Input_Result中定义的其他错误代码。

OH_Input_GetKeySwitch()

收起
自动换行
深色代码主题
复制
int32_t OH_Input_GetKeySwitch (const struct Input_KeyState * keyState)

描述

获取按键状态对象的按键开关。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
keyState	按键状态的枚举对象，具体请参考Input_KeyStateAction

返回：

返回按键状态对象的按键开关。

OH_Input_GetMouseEventAction()

收起
自动换行
深色代码主题
复制
int32_t OH_Input_GetMouseEventAction (const struct Input_MouseEvent * mouseEvent)

描述

获取鼠标事件的动作。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
mouseEvent	鼠标事件对象

返回：

鼠标的动作

OH_Input_GetMouseEventActionTime()

收起
自动换行
深色代码主题
复制
int64_t OH_Input_GetMouseEventActionTime (const struct Input_MouseEvent * mouseEvent)

描述

获取鼠标事件发生的时间。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
keyEvent	鼠标事件对象

返回：

返回鼠标事件发生的时间

OH_Input_GetMouseEventAxisType()

收起
自动换行
深色代码主题
复制
int32_t OH_Input_GetMouseEventAxisType (const struct Input_MouseEvent * mouseEvent)

描述

获取鼠标轴事件的类型。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
mouseEvent	鼠标事件对象

返回：

轴类型

OH_Input_GetMouseEventAxisValue()

收起
自动换行
深色代码主题
复制
float OH_Input_GetMouseEventAxisValue (const struct Input_MouseEvent * mouseEvent)

描述

获取鼠标轴事件的值。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
mouseEvent	鼠标事件对象

返回：

轴事件的值

OH_Input_GetMouseEventButton()

收起
自动换行
深色代码主题
复制
int32_t OH_Input_GetMouseEventButton (const struct Input_MouseEvent * mouseEvent)

描述

获取鼠标事件的按键。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
mouseEvent	鼠标事件对象

返回：

鼠标按键

OH_Input_GetMouseEventDisplayX()

收起
自动换行
深色代码主题
复制
int32_t OH_Input_GetMouseEventDisplayX (const struct Input_MouseEvent * mouseEvent)

描述

获取鼠标事件的屏幕X坐标。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
mouseEvent	鼠标事件对象

返回：

屏幕X坐标

OH_Input_GetMouseEventDisplayY()

收起
自动换行
深色代码主题
复制
int32_t OH_Input_GetMouseEventDisplayY (const struct Input_MouseEvent * mouseEvent)

描述

获取鼠标事件的屏幕Y坐标。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
mouseEvent	鼠标事件对象

返回：

屏幕Y坐标

OH_Input_GetTouchEventAction()

收起
自动换行
深色代码主题
复制
int32_t OH_Input_GetTouchEventAction (const struct Input_TouchEvent * touchEvent)

描述

获取触屏事件的动作。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
touchEvent	触屏事件对象

返回：

触屏的动作

OH_Input_GetTouchEventActionTime()

收起
自动换行
深色代码主题
复制
int64_t OH_Input_GetTouchEventActionTime (const struct Input_TouchEvent * touchEvent)

描述

获取触摸事件发生的时间。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
keyEvent	触屏事件对象

返回：

返回触摸事件发生的时间

OH_Input_GetTouchEventDisplayX()

收起
自动换行
深色代码主题
复制
int32_t OH_Input_GetTouchEventDisplayX (const struct Input_TouchEvent * touchEvent)

描述

获取触屏事件的屏幕X坐标。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
touchEvent	触屏事件对象

返回：

触屏的屏幕X坐标

OH_Input_GetTouchEventDisplayY()

收起
自动换行
深色代码主题
复制
int32_t OH_Input_GetTouchEventDisplayY (const struct Input_TouchEvent * touchEvent)

描述

获取触屏事件的屏幕Y坐标。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
touchEvent	触屏事件对象

返回：

触屏的屏幕Y坐标

OH_Input_GetTouchEventFingerId()

收起
自动换行
深色代码主题
复制
int32_t OH_Input_GetTouchEventFingerId (const struct Input_TouchEvent * touchEvent)

描述

获取触屏事件的手指ID。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
touchEvent	触屏事件对象

返回：

触屏的手指ID

OH_Input_InjectKeyEvent()

收起
自动换行
深色代码主题
复制
int32_t OH_Input_InjectKeyEvent (const struct Input_KeyEvent * keyEvent)

描述

注入按键事件。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
keyEvent	- 要注入的按键事件

返回：

0 - 成功 201 - 缺少权限 401 - 参数错误

OH_Input_InjectMouseEvent()

收起
自动换行
深色代码主题
复制
int32_t OH_Input_InjectMouseEvent (const struct Input_MouseEvent * mouseEvent)

描述

注入鼠标事件。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
mouseEvent	- 要注入的鼠标事件

返回：

0 - 成功 201 - 缺少权限 401 - 参数错误

OH_Input_InjectTouchEvent()

收起
自动换行
深色代码主题
复制
int32_t OH_Input_InjectTouchEvent (const struct Input_TouchEvent * touchEvent)

描述

注入触摸事件。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
touchEvent	- 要注入的触摸事件

返回：

0 - 成功 201 - 缺少权限 401 - 参数错误

OH_Input_RemoveAxisEventMonitor()

收起
自动换行
深色代码主题
复制
Input_Result OH_Input_RemoveAxisEventMonitor (InputEvent_AxisEventType axisEventType, Input_AxisEventCallback callback )

描述

移除指定类型轴事件监听，轴事件类型定义在InputEvent_AxisEventType中。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
axisEventType	指定要移除监听的轴事件类型，轴事件类型定义在InputEvent_AxisEventType中。
callback	指定要被移除的用于指定类型轴事件监听的回调函数。

Permission：

ohos.permission.INPUT_MONITORING

返回：

若移除轴事件监听成功，则返回INTO_SUCCESS；若权限校验失败，则返回INPUT_PERMISSION_DENIED；若callback为空或者没有被添加监听，则返回INPUT_PARAMETER_ERROR；若服务异常，则返回INPUT_SERVICE_EXCEPTION。

OH_Input_RemoveAxisEventMonitorForAll()

收起
自动换行
深色代码主题
复制
Input_Result OH_Input_RemoveAxisEventMonitorForAll (Input_AxisEventCallback callback)

描述

移除所有类型轴事件监听。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
callback	指定要被移除的用于所有类型轴事件监听的回调函数。

Permission：

ohos.permission.INPUT_MONITORING

返回：

OH_Input_RemoveInputEventInterceptor()

收起
自动换行
深色代码主题
复制
Input_Result OH_Input_RemoveInputEventInterceptor ()

描述

移除输入事件拦截，包括鼠标、触摸和轴事件。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

Permission：

ohos.permission.INTERCEPT_INPUT_EVENT

返回：

若移除输入事件拦截成功，则返回INTO_SUCCESS；若权限校验失败，则返回INPUT_PERMISSION_DENIED；若服务异常，则返回INPUT_SERVICE_EXCEPTION。

OH_Input_RemoveKeyEventInterceptor()

收起
自动换行
深色代码主题
复制
Input_Result OH_Input_RemoveKeyEventInterceptor ()

描述

移除按键事件拦截。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

Permission：

ohos.permission.INTERCEPT_INPUT_EVENT

返回：

若移除按键事件拦截成功，则返回INTO_SUCCESS；若权限校验失败，则返回INPUT_PERMISSION_DENIED；若服务异常，则返回INPUT_SERVICE_EXCEPTION。

OH_Input_RemoveKeyEventMonitor()

收起
自动换行
深色代码主题
复制
Input_Result OH_Input_RemoveKeyEventMonitor (Input_KeyEventCallback callback)

描述

移除按键事件监听。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
callback	指定要被移除的用于按键事件监听的回调函数。

Permission：

ohos.permission.INPUT_MONITORING

返回：

若移除按键事件监听成功，则返回INTO_SUCCESS；若权限校验失败，则返回INPUT_PERMISSION_DENIED；若callback为空或者没有被添加监听，则返回INPUT_PARAMETER_ERROR；若服务异常，则返回INPUT_SERVICE_EXCEPTION。

OH_Input_RemoveMouseEventMonitor()

收起
自动换行
深色代码主题
复制
Input_Result OH_Input_RemoveMouseEventMonitor (Input_MouseEventCallback callback)

描述

移除鼠标事件监听。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
callback	指定要被移除的用于鼠标事件监听的回调函数。

Permission：

ohos.permission.INPUT_MONITORING

返回：

若移除鼠标事件监听成功，则返回INTO_SUCCESS；若权限校验失败，则返回INPUT_PERMISSION_DENIED；若callback为空或者没有被添加监听，则返回INPUT_PARAMETER_ERROR；若服务异常，则返回INPUT_SERVICE_EXCEPTION。

OH_Input_RemoveTouchEventMonitor()

收起
自动换行
深色代码主题
复制
Input_Result OH_Input_RemoveTouchEventMonitor (Input_TouchEventCallback callback)

描述

移除触摸事件监听。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
callback	指定要被移除的用于触摸事件监听的回调函数。

Permission：

ohos.permission.INPUT_MONITORING

返回：

若移除触摸事件监听成功，则返回INTO_SUCCESS；若权限校验失败，则返回INPUT_PERMISSION_DENIED；若callback为空或者没有被添加监听，则返回INPUT_PARAMETER_ERROR；若服务异常，则返回INPUT_SERVICE_EXCEPTION。

OH_Input_SetAxisEventAction()

收起
自动换行
深色代码主题
复制
Input_Result OH_Input_SetAxisEventAction (Input_AxisEvent * axisEvent, InputEvent_AxisAction action )

描述

设置轴事件的动作。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
axisEvent	轴事件对象。
action	轴事件动作，具体请参考InputEvent_AxisAction。

返回：

若设置轴事件的动作成功，则返回INTO_SUCCESS；若axisEvent为NULL，则返回INPUT_PARAMETER_ERROR。

OH_Input_SetAxisEventActionTime()

收起
自动换行
深色代码主题
复制
Input_Result OH_Input_SetAxisEventActionTime (Input_AxisEvent * axisEvent, int64_t actionTime )

描述

设置轴事件发生的时间。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
axisEvent	轴事件对象，请参考Input_AxisEvent。
actionTime	轴事件发生的时间。

返回：

若设置轴事件发生的时间成功，则返回INTO_SUCCESS；若axisEvent为NULL，则返回INPUT_PARAMETER_ERROR。

OH_Input_SetAxisEventAxisValue()

收起
自动换行
深色代码主题
复制
Input_Result OH_Input_SetAxisEventAxisValue (Input_AxisEvent * axisEvent, InputEvent_AxisType axisType, double axisValue )

描述

设置轴事件指定轴类型的轴值。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
axisEvent	轴事件对象，请参考Input_AxisEvent。
axisType	轴类型，具体请参考InputEvent_AxisType。
axisValue	轴事件轴值。

返回：

若设置轴事件指定轴类型的轴值成功，则返回INTO_SUCCESS；若axisEvent为NULL，则返回INPUT_PARAMETER_ERROR。

OH_Input_SetAxisEventDisplayX()

收起
自动换行
深色代码主题
复制
Input_Result OH_Input_SetAxisEventDisplayX (Input_AxisEvent * axisEvent, float displayX )

描述

设置轴事件的X坐标。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
axisEvent	轴事件对象。
displayX	轴事件X坐标。

返回：

若设置轴事件的X坐标成功，则返回INTO_SUCCESS；若axisEvent为NULL，则返回INPUT_PARAMETER_ERROR。

OH_Input_SetAxisEventDisplayY()

收起
自动换行
深色代码主题
复制
Input_Result OH_Input_SetAxisEventDisplayY (Input_AxisEvent * axisEvent, float displayY )

描述

设置轴事件的Y坐标。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
axisEvent	轴事件对象，请参考Input_AxisEvent。
displayY	轴事件Y坐标。

返回：

若设置轴事件的Y坐标成功，则返回INTO_SUCCESS；若axisEvent为NULL，则返回INPUT_PARAMETER_ERROR。

OH_Input_SetAxisEventSourceType()

收起
自动换行
深色代码主题
复制
Input_Result OH_Input_SetAxisEventSourceType (Input_AxisEvent * axisEvent, InputEvent_SourceType sourceType )

描述

设置轴事件源类型。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
axisEvent	轴事件对象。
sourceType	轴事件源类型,具体请参考InputEvent_SourceType。

返回：

若设置轴事件源类型成功，则返回INTO_SUCCESS；若axisEvent为NULL，则返回INPUT_PARAMETER_ERROR。

OH_Input_SetAxisEventType()

收起
自动换行
深色代码主题
复制
Input_Result OH_Input_SetAxisEventType (Input_AxisEvent * axisEvent, InputEvent_AxisEventType axisEventType )

描述

设置轴事件类型。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
axisEvent	轴事件对象，请参考Input_AxisEvent。
axisEventType	轴事件类型，具体请参考InputEvent_AxisEventType。

返回：

若设置轴事件类型成功，则返回INTO_SUCCESS；若axisEvent为NULL，则返回INPUT_PARAMETER_ERROR。

OH_Input_SetKeyCode()

收起
自动换行
深色代码主题
复制
void OH_Input_SetKeyCode (struct Input_KeyState * keyState, int32_t keyCode )

描述

设置按键状态对象的键值。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
keyState	按键状态的枚举对象，具体请参考Input_KeyStateAction
keyCode	按键键值。

OH_Input_SetKeyEventAction()

收起
自动换行
深色代码主题
复制
void OH_Input_SetKeyEventAction (struct Input_KeyEvent * keyEvent, int32_t action )

描述

设置按键事件类型。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
keyEvent	按键事件对象
action	按键事件类型

OH_Input_SetKeyEventActionTime()

收起
自动换行
深色代码主题
复制
void OH_Input_SetKeyEventActionTime (struct Input_KeyEvent * keyEvent, int64_t actionTime )

描述

设置按键事件发生的时间。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
keyEvent	按键事件对象
actionTime	按键事件发生的时间

OH_Input_SetKeyEventKeyCode()

收起
自动换行
深色代码主题
复制
void OH_Input_SetKeyEventKeyCode (struct Input_KeyEvent * keyEvent, int32_t keyCode )

描述

设置按键事件的键值。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
keyEvent	按键事件对象
keyCode	按键的键值

OH_Input_SetKeyPressed()

收起
自动换行
深色代码主题
复制
void OH_Input_SetKeyPressed (struct Input_KeyState * keyState, int32_t keyAction )

描述

设置按键状态对象的按键是否按下。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
keyState	按键状态的枚举对象，具体请参考Input_KeyStateAction
keyAction	按键是否按下，具体请参考Input_KeyEventAction

OH_Input_SetKeySwitch()

收起
自动换行
深色代码主题
复制
void OH_Input_SetKeySwitch (struct Input_KeyState * keyState, int32_t keySwitch )

描述

设置按键状态对象的按键开关。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
keyState	按键状态的枚举对象，具体请参考Input_KeyStateAction
keySwitch	按键开关。

OH_Input_SetMouseEventAction()

收起
自动换行
深色代码主题
复制
void OH_Input_SetMouseEventAction (struct Input_MouseEvent * mouseEvent, int32_t action )

描述

设置鼠标事件的动作。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
mouseEvent	鼠标事件对象
action	鼠标的动作

OH_Input_SetMouseEventActionTime()

收起
自动换行
深色代码主题
复制
void OH_Input_SetMouseEventActionTime (struct Input_MouseEvent * mouseEvent, int64_t actionTime )

描述

设置鼠标事件发生的时间。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
mouseEvent	鼠标事件对象
actionTime	鼠标事件发生的时间

OH_Input_SetMouseEventAxisType()

收起
自动换行
深色代码主题
复制
void OH_Input_SetMouseEventAxisType (struct Input_MouseEvent * mouseEvent, int32_t axisType )

描述

设置鼠标轴事件的类型。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
mouseEvent	鼠标事件对象
axisType	轴类型，比如垂直轴、水平轴。

OH_Input_SetMouseEventAxisValue()

收起
自动换行
深色代码主题
复制
void OH_Input_SetMouseEventAxisValue (struct Input_MouseEvent * mouseEvent, float axisValue )

描述

设置鼠标轴事件的值。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
mouseEvent	鼠标事件对象
axisValue	轴事件的值，正数向前滚动，负数向后滚动。

OH_Input_SetMouseEventButton()

收起
自动换行
深色代码主题
复制
void OH_Input_SetMouseEventButton (struct Input_MouseEvent * mouseEvent, int32_t button )

描述

设置鼠标事件的按键。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
mouseEvent	鼠标事件对象
button	鼠标按键

OH_Input_SetMouseEventDisplayX()

收起
自动换行
深色代码主题
复制
void OH_Input_SetMouseEventDisplayX (struct Input_MouseEvent * mouseEvent, int32_t displayX )

描述

设置鼠标事件的屏幕X坐标。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
mouseEvent	鼠标事件对象
displayX	屏幕X坐标

OH_Input_SetMouseEventDisplayY()

收起
自动换行
深色代码主题
复制
void OH_Input_SetMouseEventDisplayY (struct Input_MouseEvent * mouseEvent, int32_t displayY )

描述

设置鼠标事件的屏幕Y坐标。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
mouseEvent	鼠标事件对象
displayY	屏幕Y坐标

OH_Input_SetTouchEventAction()

收起
自动换行
深色代码主题
复制
void OH_Input_SetTouchEventAction (struct Input_TouchEvent * touchEvent, int32_t action )

描述

设置触屏事件的动作。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
touchEvent	触屏事件对象
触屏的动作

OH_Input_SetTouchEventActionTime()

收起
自动换行
深色代码主题
复制
void OH_Input_SetTouchEventActionTime (struct Input_TouchEvent * touchEvent, int64_t actionTime )

描述

设置触摸事件发生的时间。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
keyEvent	触屏事件对象
actionTime	触摸事件发生的时间

OH_Input_SetTouchEventDisplayX()

收起
自动换行
深色代码主题
复制
void OH_Input_SetTouchEventDisplayX (struct Input_TouchEvent * touchEvent, int32_t displayX )

描述

设置触屏事件的屏幕X坐标。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
touchEvent	触屏事件对象
触屏的屏幕X坐标

OH_Input_SetTouchEventDisplayY()

收起
自动换行
深色代码主题
复制
void OH_Input_SetTouchEventDisplayY (struct Input_TouchEvent * touchEvent, int32_t displayY )

描述

设置触屏事件的屏幕Y坐标。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
touchEvent	触屏事件对象
触屏的屏幕Y坐标

OH_Input_SetTouchEventFingerId()

收起
自动换行
深色代码主题
复制
void OH_Input_SetTouchEventFingerId (struct Input_TouchEvent * touchEvent, int32_t id )

描述

设置触屏事件的手指ID。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数:

展开

名称	描述
touchEvent	触屏事件对象
id	触屏的手指ID

模块

头文件