文档管理中心
指南系统基础功能Input Kit(多模输入服务)事件拦截开发指导(C/C++)

事件拦截开发指导(C/C++)

功能介绍

从API version 12开始,多模为应用提供了创建和删除按键、输入事件(鼠标、触摸和轴事件)拦截的能力。使用场景例如:云桌面应用需要拦截按键、鼠标、触摸和轴事件。

接口说明

创建和删除事件拦截相关接口如下表所示,接口详细介绍请参考input

展开
接口名称 描述
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() 删除输入事件拦截,包含鼠标、触摸和轴事件。

开发步骤

链接动态库

调用创建和删除事件拦截前,需链接相关动态库。链接动态库的方法是,在CMakeList.txt文件中做下面例子所示的配置:

收起
自动换行
深色代码主题
复制
  1. target_link_libraries(entry PUBLIC libohinput.so)

申请所需权限

应用需要在module.json5中添加下面权限的配置,详细的配置方法参考声明权限文档

收起
自动换行
深色代码主题
复制
  1. "requestPermissions": [
  2. {
  3. "name": "ohos.permission.INTERCEPT_INPUT_EVENT"
  4. }
  5. ]

创建事件拦截

  • 按键事件
收起
自动换行
深色代码主题
复制
  1. struct KeyEvent {
  2. int32_t action;
  3. int32_t keyCode;
  4. int64_t actionTime { -1 };
  5. };
  6. // 定义按键事件回调函数
  7. void OnKeyEventCallback(const Input_KeyEvent* keyEvent)
  8. {
  9. KeyEvent event;
  10. // Input_KeyEvent的生命周期仅限于回调函数内,回调函数执行完毕后会被自动销毁
  11. event.action = OH_Input_GetKeyEventAction(keyEvent);
  12. event.keyCode = OH_Input_GetKeyEventKeyCode(keyEvent);
  13. event.actionTime = OH_Input_GetKeyEventActionTime(keyEvent);
  14. // ...
  15. }
  16. static napi_value AddKeyEventInterceptor(napi_env env, napi_callback_info info)
  17. {
  18. Input_Result ret = OH_Input_AddKeyEventInterceptor(OnKeyEventCallback, nullptr);
  19. // ...
  20. }
  21. static napi_value RemoveKeyEventInterceptor(napi_env env, napi_callback_info info)
  22. {
  23. Input_Result ret = OH_Input_RemoveKeyEventInterceptor();
  24. // ...
  25. }
  • 输入拦截(鼠标、触摸和轴事件)
收起
自动换行
深色代码主题
复制
  1. struct MouseEvent {
  2. int32_t action;
  3. int32_t displayX;
  4. int32_t displayY;
  5. int32_t button { -1 };
  6. int32_t axisType { -1 };
  7. float axisValue { 0.0f };
  8. int64_t actionTime { -1 };
  9. };
  10. struct TouchEvent {
  11. int32_t action;
  12. int32_t id;
  13. int32_t displayX;
  14. int32_t displayY;
  15. int64_t actionTime { -1 };
  16. };
  17. struct AxisEvent {
  18. int32_t axisAction;
  19. float displayX;
  20. float displayY;
  21. std::map<int32_t, double> axisValues;
  22. int64_t actionTime { -1 };
  23. int32_t sourceType;
  24. int32_t axisEventType { -1 };
  25. };
  26. // 定义鼠标事件回调函数
  27. void OnMouseEventCallback(const Input_MouseEvent* mouseEvent)
  28. {
  29. MouseEvent event;
  30. // Input_MouseEvent的生命周期仅在回调函数内,回调函数结束时被销毁
  31. event.action = OH_Input_GetMouseEventAction(mouseEvent);
  32. event.displayX = OH_Input_GetMouseEventDisplayX(mouseEvent);
  33. event.displayY = OH_Input_GetMouseEventDisplayY(mouseEvent);
  34. event.button = OH_Input_GetMouseEventButton(mouseEvent);
  35. event.axisType = OH_Input_GetMouseEventAxisType(mouseEvent);
  36. event.axisValue = OH_Input_GetMouseEventAxisValue(mouseEvent);
  37. event.actionTime = OH_Input_GetMouseEventActionTime(mouseEvent);
  38. // ...
  39. }
  40. // 定义触摸事件回调函数
  41. void OnTouchEventCallback(const Input_TouchEvent* touchEvent)
  42. {
  43. TouchEvent event;
  44. // Input_TouchEvent的生命周期仅在回调函数内,回调函数结束时被销毁
  45. event.action = OH_Input_GetTouchEventAction(touchEvent);
  46. event.id = OH_Input_GetTouchEventFingerId(touchEvent);
  47. event.displayX = OH_Input_GetTouchEventDisplayX(touchEvent);
  48. event.displayY = OH_Input_GetTouchEventDisplayY(touchEvent);
  49. event.actionTime = OH_Input_GetTouchEventActionTime(touchEvent);
  50. // ...
  51. }
  52. // 定义轴事件回调函数
  53. void OnAxisEventCallback(const Input_AxisEvent* axisEvent)
  54. {
  55. AxisEvent event;
  56. // Input_AxisEvent的生命周期仅在回调函数内,回调函数结束时被销毁
  57. InputEvent_AxisAction action;
  58. Input_Result ret = OH_Input_GetAxisEventAction(axisEvent, &action);
  59. event.axisAction = action;
  60. ret = OH_Input_GetAxisEventDisplayX(axisEvent, &event.displayX);
  61. ret = OH_Input_GetAxisEventDisplayY(axisEvent, &event.displayY);
  62. ret = OH_Input_GetAxisEventActionTime(axisEvent, &event.actionTime);
  63. InputEvent_SourceType sourceType;
  64. ret = OH_Input_GetAxisEventSourceType(axisEvent, &sourceType);
  65. event.sourceType = sourceType;
  66. InputEvent_AxisEventType axisEventType;
  67. ret = OH_Input_GetAxisEventType(axisEvent, &axisEventType);
  68. event.axisEventType = axisEventType;
  69. if (event.axisEventType == AXIS_EVENT_TYPE_PINCH) {
  70. double value = 0;
  71. ret = OH_Input_GetAxisEventAxisValue(axisEvent, AXIS_TYPE_PINCH, &value);
  72. event.axisValues.insert(std::make_pair(AXIS_TYPE_PINCH, value));
  73. ret = OH_Input_GetAxisEventAxisValue(axisEvent, AXIS_TYPE_ROTATE, &value);
  74. event.axisValues.insert(std::make_pair(AXIS_TYPE_ROTATE, value));
  75. } else if (event.axisEventType == AXIS_EVENT_TYPE_SCROLL) {
  76. double value = 0;
  77. ret = OH_Input_GetAxisEventAxisValue(axisEvent, AXIS_TYPE_SCROLL_VERTICAL, &value);
  78. event.axisValues.insert(std::make_pair(AXIS_TYPE_SCROLL_VERTICAL, value));
  79. ret = OH_Input_GetAxisEventAxisValue(axisEvent, AXIS_TYPE_SCROLL_HORIZONTAL, &value);
  80. event.axisValues.insert(std::make_pair(AXIS_TYPE_SCROLL_HORIZONTAL, value));
  81. }
  82. // ...
  83. }
  84. // 输入事件回调函数结构体
  85. Input_InterceptorEventCallback g_eventCallback;
  86. static napi_value AddEventInterceptor(napi_env env, napi_callback_info info)
  87. {
  88. // 设置鼠标事件回调函数
  89. g_eventCallback.mouseCallback = OnMouseEventCallback;
  90. // 设置触摸事件回调函数
  91. g_eventCallback.touchCallback = OnTouchEventCallback;
  92. // 设置轴事件回调函数
  93. g_eventCallback.axisCallback = OnAxisEventCallback;
  94. Input_Result ret = OH_Input_AddInputEventInterceptor(&g_eventCallback, nullptr);
  95. // ...
  96. }
  97. static napi_value RemoveEventInterceptor(napi_env env, napi_callback_info info)
  98. {
  99. Input_Result ret = OH_Input_RemoveInputEventInterceptor();
  100. // ...
  101. }
在 指南 中进行搜索
请输入您想要搜索的关键词