Class KeyboardShortcutManager

Allows adding/changing keyboard shortcuts. This class provides static methods for registering default shortcuts. An instance of this class must be used to access or change keyboard shortcuts.

Index

Methods

getAllShortcutIds getShortcutDefaultKeybindings getShortcutDescription

Methods

`Static` getAllShortcutIds

getAllShortcutIds(): string[]
Gets all registered keyboard shortcut IDs.

Returns string[]
See
getShortcutDescription
- Defined in shortcuts/KeyboardShortcutManager.ts:129

`Static` getShortcutDefaultKeybindings

getShortcutDefaultKeybindings(shortcutId): KeyBinding[]
Get the default keybindings associated with a keyboard shortcut.

Any keybinding in the resultant list, by default, can trigger the function associated with the shortcut.
Parameters
- shortcutId: string
Returns KeyBinding[]
- Defined in shortcuts/KeyboardShortcutManager.ts:143

`Static` getShortcutDescription

getShortcutDescription(id, localeList?): null | string
Get a description of a keyboard shortcut.

localeList, if given, attempts to
Parameters
- id: string
- Optional localeList: readonly string[]
Returns null | string
- Defined in shortcuts/KeyboardShortcutManager.ts:156

Generated using TypeDoc

OpenSource licenses