键盘快捷键辅助工具

通过键盘快捷键，用户能够发现平台的键盘快捷键并打开应用。在键盘快捷键中发布应用的快捷方式，以提高用户的工作效率和易用性。

用户按 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 = LocalContext.current as Activity

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