Interface IGlobalInputManager`Beta`

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

Index

Methods

registerBindingCategory registerKeyBinding setMouseIcon

Methods

registerBindingCategory

registerBindingCategory(id: string, label: string, order: number): void
Beta
Parameters
- id: string
  Unique category identifier (use a CoreInputBindingCategory value or a custom string).
- label: string
  Localized display name shown as the group heading.
- order: number
  Numeric sort order; lower values appear first.
Returns void
Remarks
Register a named control category for display in the Control Help panel.
- Defined in tmp/package/index.d.ts:8054

registerKeyBinding

registerKeyBinding(
    inputContextId: EditorInputContext,
    action: SupportedKeyboardActionTypes,
    binding: KeyBinding,
    info?: KeyBindingInfo,
): IRegisteredKeyBinding
Beta
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.
- Defined in tmp/package/index.d.ts:8069

setMouseIcon

setMouseIcon(
contextId: EditorInputContext,
mouseIcon: MouseCursorIconType | undefined,
): void
Beta
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
- Defined in tmp/package/index.d.ts:8087