键盘快捷键助手

键盘快捷键助手使用户能够发现平台和打开的应用程序的键盘快捷键。在键盘快捷键助手里发布您的应用程序的快捷键，以提高用户的生产力和易用性。

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

Application open on a device showing system shortcuts.
图 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显示了分为两组的键盘快捷键：光标移动和消息编辑。

Application open on a device showing shortcut groups.
图 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")
}
上一页
处理键盘操作