Interface IGlobalInputManager

interface IGlobalInputManager {
    registerKeyBinding(
        inputContextId: EditorInputContext,
        action: SupportedKeyboardActionTypes,
        binding: KeyBinding,
        info?: KeyBindingInfo,
    ): IRegisteredKeyBinding;
    setMouseIcon(
        contextId: EditorInputContext,
        mouseIcon: MouseCursorIconType | undefined,
    ): void;
}

Index

Methods

registerKeyBinding setMouseIcon

Methods

registerKeyBinding

registerKeyBinding(
    inputContextId: EditorInputContext,
    action: SupportedKeyboardActionTypes,
    binding: KeyBinding,
    info?: KeyBindingInfo,
): IRegisteredKeyBinding
Parameters
- inputContextId: EditorInputContext
  Id of the UI context to handle this binding.
- action: SupportedKeyboardActionTypes
  Action to register the binding for.
- binding: KeyBinding
  Keyboard binding to invoke action.
- Optionalinfo: KeyBindingInfo
  Additional information about key binding.
Returns IRegisteredKeyBinding
Remarks
Register a key press binding for an action which will be handled by the specified input context.

setMouseIcon

setMouseIcon(
contextId: EditorInputContext,
mouseIcon: MouseCursorIconType | undefined,
): void
Parameters
- contextId: EditorInputContext
  The editor input context id (maps to EditorInputContext).
- mouseIcon: MouseCursorIconType | undefined
  The MouseCursorIconType, or null to clear.
Returns void
Remarks
Set or clear the mouse cursor icon for a given editor input context layer.
Throws