组合按键开发指导

场景介绍

组合按键提供订阅组合按键、设置屏蔽按键拦截状态等能力。使用场景例如：当用户需要组合按键实现快捷功能时，开发者可以订阅组合按键，通过组合按键启用快捷功能。

导入模块

import { inputConsumer } from '@kit.InputKit';

接口说明

组合按键管理常用接口如下表所示，接口详细介绍请参考ohos.multimodalInput.inputConsumer-sys文档和ohos.multimodalInput.inputConsumer文档。

接口名称	描述
on(type: 'key', keyOptions: KeyOptions, callback: Callback<KeyOptions>): void	订阅组合按键。
off(type: 'key', keyOptions: KeyOptions, callback?: Callback<KeyOptions>): void	取消订阅组合按键。
setShieldStatus(shieldMode: ShieldMode, isShield: boolean): void	设置屏蔽按键拦截状态。
getShieldStatus(shieldMode: ShieldMode): boolean	获取屏蔽按键拦截是否生效。
getAllSystemHotkeys(): Promise<Array<HotkeyOptions>>	获取所有系统组合按键。
on(type: 'hotkeyChange', hotkeyOptions: HotkeyOptions, callback: Callback<HotkeyOptions>): void	订阅全局组合按键。
off(type: 'hotkeyChange', hotkeyOptions: HotkeyOptions, callback?: Callback<HotkeyOptions>): void	取消订阅全局组合按键。

开发步骤

特定组合按键的应用开启时调用on方法订阅组合键，应用关闭时再用off方法取消订阅组合键。

let leftAltKey = 2045;
let tabKey = 2049;
let callback = (keyOptions: inputConsumer.KeyOptions) => {
  console.log(`keyOptions: ${JSON.stringify(keyOptions)}`);
}
//应用开启
let keyOption: inputConsumer.KeyOptions = {preKeys: [leftAltKey], finalKey: tabKey, isFinalKeyDown: true, finalKeyDownDuration: 0};
try {
  inputConsumer.on("key", keyOption, callback);//订阅组合键
} catch (error) {
  console.log(`Execute failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
//应用关闭
try {
  inputConsumer.off("key", keyOption, callback);//取消订阅组合键
  console.log(`Unsubscribe success`);
} catch (error) {
  console.log(`Execute failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

let leftCtrlKey = 2072;
let zKey = 2042;
let hotkeyCallback = (hotkeyOptions: inputConsumer.HotkeyOptions) => {
  console.log(`keyOptions: ${JSON.stringify(hotkeyOptions)}`);
}
let hotkeyOption: inputConsumer.HotkeyOptions = {preKeys: [leftCtrlKey], finalKey: zKey, isRepeat: false};
//在订阅全局组合键之前，需要先获取所有系统组合键，查询需要订阅的组合键是否存在于系统组合键列表中，避免冲突
inputConsumer.getAllSystemHotkeys().then((data: Array<inputConsumer.HotkeyOptions>) => {//获取所有系统组合键
  console.log(`List of system hotkeys : ${JSON.stringify(data)}`);
});
//应用开启
try {
  inputConsumer.on("hotkeyChange", hotkeyOption, hotkeyCallback);//订阅全局组合键
} catch (error) {
  console.log(`Execute failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
//应用关闭
try {
  inputConsumer.off("hotkeyChange", hotkeyOption, hotkeyCallback);//取消订阅全局组合键
  console.log(`Unsubscribe success`);
} catch (error) {
  console.log(`Execute failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}