Options
All
  • Public
  • Public/Protected
  • All
V1.7
  • V1.6
  • V1.7
Menu

Class Keyboard

Main entry point for interacting with the UiKit keyboard.

Hierarchy

  • Keyboard

Index

Enumerations

Constructors

Methods

Constructors

constructor

Methods

hide

  • hide(): void

onVisibilityChangedSub

  • onVisibilityChangedSub(callback: ((arg0: boolean) => void) | null): CallbackID

  • The on keyboard visibility changed event.

    This event is dispatched whenever the visibility of the keyboard changes.

    priv

    none

    Parameters

    • callback: ((arg0: boolean) => void) | null

    Returns CallbackID

onVisibilityChangedUnsub

  • onVisibilityChangedUnsub(callbackID: CallbackID): boolean

show

  • Requests that the keyboard be shown and enabled for the given prism.

    priv

    none

    Parameters

    • a_pClientVol: Prism | null

      the prism the keyboard will be positioned against.

    • a_pLocaleCode: Code

      the locale to use with the keyboard.

    • a_keyboardProperties: KeyboardProperties

      the properties to use for the keyboard.

    • a_eventHandler: ((arg0: EventData) => void) | null

      the keyboard event handling function.

    • Optional positionExtents: AABB

      default = math.AABB.EMPTY
      the (volume-space) extents of the control that's calling the keyboard.

    Returns ShowKeyboardReturnCode

    a ShowKeyboardReturnCode value indicating the result of the call.

Static Get

Generated using TypeDoc