1# 事件拦截开发指导（C/C++）
2
3## 功能介绍
4
5多模为应用提供了创建和删除按键、输入事件（鼠标、触摸和轴事件）拦截的能力。使用场景例如：云桌面应用需要拦截按键、鼠标、触摸和轴事件。
6
7## 接口说明
8
9创建和删除事件拦截相关接口如下表所示，接口详细介绍请参考[Input文档](../../reference/apis-input-kit/input.md)。
10
11| 接口名称  | 描述 |
12| ------------------------------------------------------------ | -------------------------- |
13| Input_Result OH_Input_AddKeyEventInterceptor(Input_KeyEventCallback callback, Input_InterceptorOptions *option) |创建按键事件拦截。  |
14| Input_Result OH_Input_AddInputEventInterceptor(Input_InterceptorEventCallback *callback, Input_InterceptorOptions *option) |创建输入事件拦截，包含鼠标、触摸和轴事件。  |
15| Input_Result OH_Input_RemoveKeyEventInterceptor() |删除按键事件拦截。  |
16| Input_Result OH_Input_RemoveInputEventInterceptor() |删除输入事件拦截，包含鼠标、触摸和轴事件。  |
17
18## 开发步骤
19
20### 链接动态库
21
22调用创建和删除事件拦截前，需链接相关动态库。链接动态库的方法是，在CMakeList.txt文件中做下面例子所示的配置：
23
24```txt
25   target_link_libraries(entry PUBLIC libohinput.so)
26```
27
28### 申请所需权限
29
30应用需要在module.json5中添加下面权限的配置，详细的配置方法参考声明[声明权限文档](../../security/AccessToken/declare-permissions.md)。
31
32```json
33"requestPermissions": [
34    {
35        "name": "ohos.permission.INTERCEPT_INPUT_EVENT"
36    }
37]
38```
39
40### 创建事件拦截
41
42#### 按键事件
43
44```c++
45#include "multimodalinput/oh_input_manager.h"
46
47struct KeyEvent {
48    int32_t action;
49    int32_t keyCode;
50    int64_t actionTime { -1 };
51};
52
53//定义按键事件回调函数
54void OnKeyEventCallback(const Input_KeyEvent* keyEvent)
55{
56    KeyEvent event;
57    //Input_KeyEvent的生命周期仅在回调函数内，出了回调函数会被销毁
58    event.action = OH_Input_GetKeyEventAction(keyEvent);
59    event.keyCode = OH_Input_GetKeyEventKeyCode(keyEvent);
60    event.actionTime = OH_Input_GetKeyEventActionTime(keyEvent);
61}
62
63void TestInterceptor()
64{
65    //添加按键事件拦截
66    Input_Result ret = OH_Input_AddKeyEventInterceptor(OnKeyEventCallback, nullptr);
67    //移除按键事件监听
68    ret = OH_Input_RemoveKeyEventInterceptor();
69}
70```
71
72#### 输入拦截（鼠标、触摸和轴事件）
73
74```c++
75#include "multimodalinput/oh_input_manager.h"
76#include <map>
77
78struct MouseEvent {
79    int32_t action;
80    int32_t displayX;
81    int32_t displayY;
82    int32_t button { -1 };
83    int32_t axisType { -1 };
84    float axisValue { 0.0f };
85    int64_t actionTime { -1 };
86};
87
88struct TouchEvent {
89    int32_t action;
90    int32_t id;
91    int32_t displayX;
92    int32_t displayY;
93    int64_t actionTime { -1 };
94};
95
96struct AxisEvent {
97    int32_t axisAction;
98    float displayX;
99    float displayY;
100    std::map<int32_t, double> axisValues;
101    int64_t actionTime { -1 };
102    int32_t sourceType;
103    int32_t axisEventType { -1 };
104};
105
106//定义鼠标事件回调函数
107void OnMouseEventCallback(const Input_MouseEvent* mouseEvent)
108{
109    MouseEvent event;
110    //Input_MouseEvent的生命周期仅在回调函数内，出了回调函数会被销毁
111    event.action = OH_Input_GetMouseEventAction(mouseEvent);
112    event.displayX = OH_Input_GetMouseEventDisplayX(mouseEvent);
113    event.displayY = OH_Input_GetMouseEventDisplayY(mouseEvent);
114    event.button = OH_Input_GetMouseEventButton(mouseEvent);
115    event.axisType = OH_Input_GetMouseEventAxisType(mouseEvent);
116    event.axisValue = OH_Input_GetMouseEventAxisValue(mouseEvent);
117    event.actionTime = OH_Input_GetMouseEventActionTime(mouseEvent);
118}
119
120//定义触摸事件回调函数
121void OnTouchEventCallback(const Input_TouchEvent* touchEvent)
122{
123    TouchEvent event;
124    //Input_TouchEvent的生命周期仅在回调函数内，出了回调函数会被销毁
125    event.action = OH_Input_GetTouchEventAction(touchEvent);
126    event.id = OH_Input_GetTouchEventFingerId(touchEvent);
127    event.displayX = OH_Input_GetTouchEventDisplayX(touchEvent);
128    event.displayY = OH_Input_GetTouchEventDisplayY(touchEvent);
129    event.actionTime = OH_Input_GetTouchEventActionTime(touchEvent);
130}
131
132//定义轴事件回调函数
133void OnAxisEventCallback(const Input_AxisEvent* axisEvent)
134{
135    AxisEvent event;
136
137    //Input_AxisEvent的生命周期仅在回调函数内，出了回调函数会被销毁
138    InputEvent_AxisAction action;
139    Input_Result ret = OH_Input_GetAxisEventAction(axisEvent, &action);
140    event.axisAction = action;
141    ret = OH_Input_GetAxisEventDisplayX(axisEvent, &event.displayX);
142    ret = OH_Input_GetAxisEventDisplayY(axisEvent, &event.displayY);
143    ret = OH_Input_GetAxisEventActionTime(axisEvent, &event.actionTime);
144    InputEvent_SourceType sourceType;
145    ret = OH_Input_GetAxisEventSourceType(axisEvent, &sourceType);
146    event.sourceType = sourceType;
147    InputEvent_AxisEventType axisEventType;
148    ret = OH_Input_GetAxisEventType(axisEvent, &axisEventType);
149    event.axisEventType = axisEventType;
150    if (event.axisEventType == AXIS_EVENT_TYPE_PINCH) {
151        double value = 0;
152        ret = OH_Input_GetAxisEventAxisValue(axisEvent, AXIS_TYPE_PINCH, &value);
153        event.axisValues.insert(std::make_pair(AXIS_TYPE_PINCH, value));
154        ret = OH_Input_GetAxisEventAxisValue(axisEvent, AXIS_TYPE_ROTATE, &value);
155        event.axisValues.insert(std::make_pair(AXIS_TYPE_ROTATE, value));
156    } else if (event.axisEventType == AXIS_EVENT_TYPE_SCROLL) {
157        double value = 0;
158        ret = OH_Input_GetAxisEventAxisValue(axisEvent, AXIS_TYPE_SCROLL_VERTICAL, &value);
159        event.axisValues.insert(std::make_pair(AXIS_TYPE_SCROLL_VERTICAL, value));
160        ret = OH_Input_GetAxisEventAxisValue(axisEvent, AXIS_TYPE_SCROLL_HORIZONTAL, &value);
161        event.axisValues.insert(std::make_pair(AXIS_TYPE_SCROLL_HORIZONTAL, value));
162    }
163}
164
165//输入事件回调函数结构体
166Input_InterceptorEventCallback g_eventCallback;
167
168void TestInterceptor()
169{
170    //设置鼠标事件回调函数
171    g_eventCallback.mouseCallback = OnMouseEventCallback;
172    //设置触摸事件回调函数
173    g_eventCallback.touchCallback = OnTouchEventCallback;
174    //设置轴事件回调函数
175    g_eventCallback.axisCallback = OnAxisEventCallback;
176
177    //添加输入事件拦截
178    Input_Result ret = OH_Input_AddInputEventInterceptor(&g_eventCallback, nullptr);
179    //移除输入事件监听
180    ret = OH_Input_RemoveInputEventInterceptor();
181}
182```
183