使用WindowManager管理多模输入事件（C/C++）
==============================

#### 场景介绍

[WindowManager](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-windowmanager)提供应用窗口的管理能力，可以用于管理多模输入事件。

当前支持使用WindowManager进行多模输入事件的过滤，还可以将多模触摸事件注入目标窗口，具体开发步骤可见下文。

#### 过滤多模输入事件

使用WindowManager模块提供的能力去拦截按键事件，让按键事件不往应用内部组件分发。

#### \[h2\]在CMake脚本中链接动态库

target\_link\_libraries(entry PUBLIC libnative\_window\_manager.so libohinput.so)

#### \[h2\]添加头文件

#include "multimodalinput/oh\_input\_manager.h"
#include "multimodalinput/oh\_key\_code.h"
#include "window\_manager/oh\_window\_comm.h"
#include "window\_manager/oh\_window\_event\_filter.h"

#### \[h2\]接口使用说明

| 接口名 | 描述 |
| :-- | :-- |
| OH\_NativeWindowManager\_RegisterKeyEventFilter(int32\_t windowId, OH\_NativeWindowManager\_KeyEventFilter keyEventFilter) | 为指定的窗口注册过滤回调函数keyEventFilter。 |
| OH\_NativeWindowManager\_UnregisterKeyEventFilter(int32\_t windowId) | 取消指定窗口上的过滤回调函数。 |

*   应用窗口创建后，使用窗口ID绑定按键事件过滤函数。
*   应用窗口需要收到按键事件时，才触发按键事件的拦截。
*   当回调函数返回true表示拦截，false表示不拦截。
*   同一个窗口ID注册的回调函数只允许一个，最后注册的回调函数会覆盖之前注册过的回调函数。如需过滤多个按键的组合场景，建议在一个回调函数里面处理。

#### \[h2\]示例代码

以下示例代码中介绍了如何注册过滤函数和取消过滤函数，以过滤ESC退出按键和数字按键为例。

#include "napi/native\_api.h"
#include "window\_manager/oh\_window\_comm.h"
#include "window\_manager/oh\_window\_event\_filter.h"
#include "multimodalinput/oh\_input\_manager.h"
#include "multimodalinput/oh\_key\_code.h"

// 设置过滤函数
static bool filterFunc(Input\_KeyEvent \*event) {
  auto keyCode = OH\_Input\_GetKeyEventKeyCode(event);
  auto action = OH\_Input\_GetKeyEventAction(event);
  // case1: 过滤escape
  // return keyCode == Input\_KeyCode::KEYCODE\_ESCAPE;

  // case2: 过滤数字键的按下，抬起不过滤
  // return keyCode >= Input\_KeyCode::KEYCODE\_0 && keyCode <= Input\_KeyCode::KEYCODE\_9
  //  && action == Input\_KeyEventAction::KEY\_ACTION\_DOWN;
  
  // 过滤escape和数字键的按下(case1 || case2)
  return (keyCode >= Input\_KeyCode::KEYCODE\_0 && keyCode <= Input\_KeyCode::KEYCODE\_9
     && action == Input\_KeyEventAction::KEY\_ACTION\_DOWN) || (keyCode == Input\_KeyCode::KEYCODE\_ESCAPE);
}

static napi\_value registerFilter(napi\_env env, napi\_callback\_info info) {
  size\_t argc = 1;
  napi\_value args\[1\] = {nullptr};
  napi\_get\_cb\_info(env, info, &argc, args, nullptr, nullptr);
  
  int32\_t windowId;
  napi\_get\_value\_int32(env, args\[0\], &windowId);
  
  // 向windowId对应的窗口注册filterFunc的过滤函数
  auto res = OH\_NativeWindowManager\_RegisterKeyEventFilter(windowId, filterFunc);
  
  napi\_value errCode;
  napi\_create\_int32(env, res, &errCode);
  return errCode;
}

static napi\_value clearFilter(napi\_env env, napi\_callback\_info info) {
  size\_t argc = 1;
  napi\_value args\[1\] = {nullptr};
  napi\_get\_cb\_info(env, info, &argc, args, nullptr, nullptr);

  int32\_t windowId;
  napi\_get\_value\_int32(env, args\[0\], &windowId);

  auto res = OH\_NativeWindowManager\_UnregisterKeyEventFilter(windowId);
  napi\_value errCode;
  napi\_create\_int32(env, res, &errCode);
  return errCode;

}

EXTERN\_C\_START
static napi\_value Init(napi\_env env, napi\_value exports) {
  napi\_property\_descriptor desc\[\] = {
    {"registerFilter", nullptr, registerFilter, nullptr, nullptr, nullptr, napi\_default, nullptr},
    {"clearFilter", nullptr, clearFilter, nullptr, nullptr, nullptr, napi\_default, nullptr}};
  napi\_define\_properties(env, exports, sizeof(desc) / sizeof(desc\[0\]), desc);
  return exports;
}
EXTERN\_C\_END

#### 将多模触摸事件注入给目标窗口

使用WindowManager模块提供的能力为指定窗口注入触摸事件，仅支持同进程窗口。此操作不会触发窗口焦点、层级变化或拖拽，事件会直接发送给ArkUI。

#### \[h2\]在CMake脚本中链接动态库

target\_link\_libraries(entry PUBLIC libnative\_window\_manager.so libohinput.so)

#### \[h2\]添加头文件

#include "multimodalinput/oh\_input\_manager.h"
#include "window\_manager/oh\_window.h"
#include "napi/native\_api.h"

#### \[h2\]接口使用说明

| 接口名 | 描述 |
| :-- | :-- |
| OH\_WindowManager\_InjectTouchEvent(int32\_t windowId, Input\_TouchEvent\* touchEvent, int32\_t windowX, int32\_t windowY) | 为指定的窗口注入触摸事件。 |

*   构造事件参数，向目标窗口ID注入事件。
    
*   仅支持注入同进程窗口。注入不会触发窗口焦点、层级变化或拖拽，事件直接发送给ArkUI。
    
*   接口需要在指定窗口加载UI后调用。
    
*   完成窗口和多模触摸事件校验，确保事件参数正确，再将事件发送给ArkUI。具体参数说明如下：
    
    | 参数名 | 描述 |
    | :-- | :-- |
    | windowId | 目标窗口ID，仅支持同进程的窗口，否则返回错误码1300002。窗口需完成UI加载，否则返回错误码1300003。 |
    | touchEvent | 多模触摸事件，具体可见[Input\_TouchEvent](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-input-input-touchevent)，事件定义在oh\_input\_manager.h中。调用[OH\_Input\_CreateTouchEvent](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-oh-input-manager-h#oh_input_createtouchevent)接口创建touchEvent对象，使用完后调用[OH\_Input\_DestroyTouchEvent](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-oh-input-manager-h#oh_input_destroytouchevent)接口销毁该对象。具体参数说明见下表。 |
    | windowX | 注入事件相对于注入窗口的落点横坐标。参数应为大于等于0的整数，否则返回错误码1300003。 |
    | windowY | 注入事件相对于注入窗口的落点纵坐标。参数应为大于等于0的整数，否则返回错误码1300003。 |
    
    其中，touchEvent多模触摸事件具体参数说明如下：
    
    | 参数名 | 方法 | 描述 |
    | :-- | :-- | :-- |
    | action | [OH\_Input\_SetTouchEventAction](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-oh-input-manager-h#oh_input_settoucheventaction) | 
    表示事件行为，默认值为0。
    
    当前只支持0-3的行为，分别表示为：
    
    \- 0：cancel，表示取消事件。
    
    \- 1：down，表示按下事件。
    
    \- 2：move，表示移动事件。
    
    \- 3：up，表示抬起事件。
    
    \- 其他行为会返回错误码1300003。
    
     |
    | id | [OH\_Input\_SetTouchEventFingerId](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-oh-input-manager-h#oh_input_settoucheventfingerid) | 
    
    表示手指ID，默认值为0。
    
    应为大于等于0的整数，否则返回错误码1300003。
    
     |
    | displayX | [OH\_Input\_SetTouchEventDisplayX](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-oh-input-manager-h#oh_input_settoucheventdisplayx) | 
    
    表示事件落点相对于屏幕的横坐标，默认值为0。
    
    参数应为非负整数，否则返回错误码1300003。建议与windowX保持对应关系，即使不一致也不会返回错误码，仅校验入参合法范围。转换方法推荐使用[getWindowProperties()](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/arkts-apis-window-window#getwindowproperties9)方法获取windowRect属性，通过displayX减去windowRect中窗口左上角横坐标计算对应的windowX。
    
     |
    | displayY | [OH\_Input\_SetTouchEventDisplayY](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-oh-input-manager-h#oh_input_settoucheventdisplayy) | 
    
    表示事件落点相对于屏幕的纵坐标，默认值为0。
    
    参数应为非负整数，否则返回错误码1300003。建议与windowY保持对应关系，即使不一致也不会返回错误码，仅校验入参合法范围。转换方法推荐使用[getWindowProperties()](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/arkts-apis-window-window#getwindowproperties9)方法获取windowRect属性，通过displayY减去windowRect中窗口左上角纵坐标计算对应的windowY。
    
     |
    | actionTime | [OH\_Input\_SetTouchEventActionTime](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-oh-input-manager-h#oh_input_settoucheventactiontime) | 表示时间戳，默认值为-1。参数应为非负整数，否则返回错误码1300003。 |
    | windowId | [OH\_Input\_SetTouchEventWindowId](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-oh-input-manager-h#oh_input_settoucheventwindowid) | 表示事件注入窗口ID，默认值为-1。若参数不为默认值且不等于[OH\_WindowManager\_InjectTouchEvent](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-oh-window-h#oh_windowmanager_injecttouchevent)接口参数windowId，将校验传入参数错误。 |
    | displayId | [OH\_Input\_SetTouchEventDisplayId](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-oh-input-manager-h#oh_input_settoucheventdisplayid) | 表示事件注入屏幕ID，默认值为-1。无限制，但是应该尽量保证与[OH\_WindowManager\_InjectTouchEvent](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-oh-window-h#oh_windowmanager_injecttouchevent)接口参数windowId有相互对应关系，推荐使用[getWindowProperties()](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/arkts-apis-window-window#getwindowproperties9)方法获取displayId属性。 |
    

#### \[h2\]示例代码

以下示例代码介绍了如何将多模触摸事件注入目标窗口，以单次事件注入为例。

#include "napi/native\_api.h"
#include "window\_manager/oh\_window.h"
#include "multimodalinput/oh\_input\_manager.h"

static napi\_value injectEvent(napi\_env env, napi\_callback\_info info) {
  size\_t argc = 10;
  napi\_value args\[10\] = {nullptr};
  napi\_get\_cb\_info(env, info, &argc, args, nullptr, nullptr);

  int32\_t windowId;
  napi\_get\_value\_int32(env, args\[0\], &windowId);

  int32\_t displayId;
  napi\_get\_value\_int32(env, args\[1\], &displayId);

  int32\_t windowX;
  napi\_get\_value\_int32(env, args\[2\], &windowX);

  int32\_t windowY;
  napi\_get\_value\_int32(env, args\[3\], &windowY);

  int32\_t action;
  napi\_get\_value\_int32(env, args\[4\], &action);

  int32\_t fingerId;
  napi\_get\_value\_int32(env, args\[5\], &fingerId);

  int32\_t displayX;
  napi\_get\_value\_int32(env, args\[6\], &displayX);

  int32\_t displayY;
  napi\_get\_value\_int32(env, args\[7\], &displayY);

  int32\_t actionTime;
  napi\_get\_value\_int32(env, args\[8\], &actionTime);

  int32\_t TE\_WindowId;
  napi\_get\_value\_int32(env, args\[9\], &TE\_WindowId);
  
  // 构造多模事件touchEvent
  Input\_TouchEvent\* touchEvent = OH\_Input\_CreateTouchEvent();
  OH\_Input\_SetTouchEventAction(touchEvent, action);
  OH\_Input\_SetTouchEventFingerId(touchEvent, fingerId);
  OH\_Input\_SetTouchEventDisplayX(touchEvent, displayX);
  OH\_Input\_SetTouchEventDisplayY(touchEvent, displayY);
  OH\_Input\_SetTouchEventActionTime(touchEvent, actionTime);
  OH\_Input\_SetTouchEventWindowId(touchEvent, TE\_WindowId);
  OH\_Input\_SetTouchEventDisplayId(touchEvent, displayId);

  // 向windowId对应的窗口注入多模触摸事件
  auto res = OH\_WindowManager\_InjectTouchEvent(windowId, touchEvent, windowX, windowY);

  // 使用完touchEvent后销毁对象
  OH\_Input\_DestroyTouchEvent(&touchEvent);
  
  napi\_value errCode;
  napi\_create\_int32(env, res, &errCode);
  return errCode;
}

EXTERN\_C\_START
static napi\_value Init(napi\_env env, napi\_value exports) {
  napi\_property\_descriptor desc\[\] = {
    {"injectEvent", nullptr, injectEvent, nullptr, nullptr, nullptr, napi\_default, nullptr}};
  napi\_define\_properties(env, exports, sizeof(desc) / sizeof(desc\[0\]), desc);
  return exports;
}
EXTERN\_C\_END