键盘快捷键辅助工具

键盘快捷键助手可让用户发现平台和打开的应用的键盘快捷键。在键盘快捷键帮助程序中发布应用的快捷键，以提高用户的工作效率和易用性。

用户按 Meta+/ 即可打开键盘快捷键屏幕，该屏幕在 Android 7.0（API 级别 24）及更高版本中可用。

设备上打开的应用，显示系统快捷键。
图 1. 键盘快捷键辅助工具。

为键盘快捷键辅助工具提供快捷键

您可以通过替换 onProvideKeyboardShortcuts() 窗口回调，向键盘快捷键助手提供可用的键盘快捷键列表。以下代码段演示了 onProvideKeyboardShortcuts() 的实现，用于添加一组四个快捷方式：

class MainActivity : ComponentActivity() {
    // Activity codes such as overridden onStart method.

    override fun onProvideKeyboardShortcuts(
        data: MutableList<KeyboardShortcutGroup>?,
        menu: Menu?,
        deviceId: Int
    ) {
        val shortcutGroup =
            KeyboardShortcutGroup(
                "Cursor movement",
                listOf(
                    KeyboardShortcutInfo("Up", KeyEvent.KEYCODE_P, KeyEvent.META_CTRL_ON),
                    KeyboardShortcutInfo("Down", KeyEvent.KEYCODE_N, KeyEvent.META_CTRL_ON),
                    KeyboardShortcutInfo("Forward", KeyEvent.KEYCODE_F, KeyEvent.META_CTRL_ON),
                    KeyboardShortcutInfo("Backward", KeyEvent.KEYCODE_B, KeyEvent.META_CTRL_ON),
                )
            )
        data?.add(shortcutGroup)
    }
}

KeyboardShortcutInfo 用于描述键盘快捷键。键盘快捷键列表封装为 KeyboardShortcutGroup 对象。应用通过将 KeyboardShortcutGroup 对象添加到作为该方法的第一个参数传递的可变列表中，向键盘快捷键助手通知可用的键盘快捷键。

使用分组整理键盘快捷键

键盘快捷键助手会按不同的组显示键盘快捷键，以便用户按用例或应用界面查找快捷键。图 2 显示了分为两组的键盘快捷键：光标移动和消息编辑。

设备上打开的应用，其中显示了快捷键组。
图 2. 键盘快捷键辅助工具中的类别。

您的应用通过为每个组创建一个 KeyboardShortcutGroup 对象来注册两个或更多个键盘快捷键组。 在以下代码段中，两个 KeyboardShortCutGroup 对象被添加到传递给 onProvideKeyboardShortcuts() 方法的可变列表中。 这些对象在键盘快捷键助手内会显示为类别，如图 2 所示。

override fun onProvideKeyboardShortcuts(
    data: MutableList<KeyboardShortcutGroup>?,
    menu: Menu?,
    deviceId: Int
) {
    val cursorMovement = KeyboardShortcutGroup(
        "Cursor movement",
        listOf(
            KeyboardShortcutInfo("Up", KeyEvent.KEYCODE_P, KeyEvent.META_CTRL_ON),
            KeyboardShortcutInfo("Down", KeyEvent.KEYCODE_N, KeyEvent.META_CTRL_ON),
            KeyboardShortcutInfo("Forward", KeyEvent.KEYCODE_F, KeyEvent.META_CTRL_ON),
            KeyboardShortcutInfo("Backward", KeyEvent.KEYCODE_B, KeyEvent.META_CTRL_ON),
        )
    )

    val messageEdit = KeyboardShortcutGroup(
        "Message editing",
        listOf(
            KeyboardShortcutInfo("Select All", KeyEvent.KEYCODE_A, KeyEvent.META_CTRL_ON),
            KeyboardShortcutInfo(
                "Send a message",
                KeyEvent.KEYCODE_ENTER,
                KeyEvent.META_SHIFT_ON
            )
        )
    )

    data?.add(cursorMovement)
    data?.add(messageEdit)
}

通过代码打开键盘快捷键辅助工具

应用通过调用 requestShowKeyboardShortcuts() 方法来显示键盘快捷键界面。在以下代码段中，当用户点按或点击按钮或按 Enter 键时，键盘快捷键帮助程序会打开。

val activity = LocalActivity.current

Button(
    onClick = {
        activity?.requestShowKeyboardShortcuts()
    }
) {
    Text(text = "Show keyboard shortcuts")
}

上一页
处理键盘操作