Keyboard

lumin.ui. Keyboard

Main entry point for interacting with the UiKit keyboard.

Classes

ShowKeyboardReturnCode

Methods

(static) Get() → {lumin.ui.Keyboard}

Returns the Keyboard singleton.

Returns:
Type
lumin.ui.Keyboard

hide()

Requests that the keyboard be hidden.

onVisibilityChangedSub(callback) → {lumin.utils.CallbackID}

The on keyboard visibility changed event.

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

Parameters:
Name Type Description
callback callable
Returns:
Type
lumin.utils.CallbackID

onVisibilityChangedUnsub(callbackID) → {boolean}

Parameters:
Name Type Description
callbackID lumin.utils.CallbackID
Returns:
Type
boolean

show(a_pClientVol, a_pLocaleCode, a_keyboardProperties, a_eventHandler, positionExtentsopt) → {lumin.ui.Keyboard.ShowKeyboardReturnCode}

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

Parameters:
Name Type Attributes Default Description
a_pClientVol lumin.Prism

the prism the keyboard will be positioned against.

a_pLocaleCode lumin.ui.Locale.Code

the locale to use with the keyboard.

a_keyboardProperties lumin.ui.KeyboardProperties

the properties to use for the keyboard.

a_eventHandler callable

the keyboard event handling function.

positionExtents lumin.math.AABB <optional>
math.AABB.EMPTY

the (volume-space) extents of the control that's calling the keyboard.

Returns:

a ShowKeyboardReturnCode value indicating the result of the call.

Type
lumin.ui.Keyboard.ShowKeyboardReturnCode