Murl Engine Lua Addon API  Version 1.0 beta
Murl.IKeyboardControl

The IKeyboardControl interface.

Methods to control the on-screen keyboard.


Table members

Inherited


Murl.IControlable

Enumerations


KeyboardType

Definition of the keyboard types. The PAD keyboard types may not offer a return key (e.g. Phone iOS).

Murl.IKeyboardControl.KEYBOARD_DEFAULTThe default keyboard.
Murl.IKeyboardControl.KEYBOARD_URLA keyboard optimized for URL entry.
Murl.IKeyboardControl.KEYBOARD_EMAILA keyboard optimized for specifying email addresses.
Murl.IKeyboardControl.KEYBOARD_NUMBERSThe numbers and punctuation keyboard.
Murl.IKeyboardControl.KEYBOARD_PAD_NUMBERSA numeric keypad designed for PIN entry.
Murl.IKeyboardControl.KEYBOARD_PAD_PHONEA keypad designed for entering telephone numbers.
Murl.IKeyboardControl.NUM_KEYBOARD_TYPES

ReturnKeyType

Definition of the return key types. The text of the return key is translated to the current language.

Murl.IKeyboardControl.RETURN_KEY_DEFAULTSet the text of the return key to "return".
Murl.IKeyboardControl.RETURN_KEY_GOSet the text of the return key to "Go".
Murl.IKeyboardControl.RETURN_KEY_JOINSet the text of the return key to "Join".
Murl.IKeyboardControl.RETURN_KEY_NEXTSet the text of the return key to "Next".
Murl.IKeyboardControl.RETURN_KEY_ROUTESet the text of the return key to "Route".
Murl.IKeyboardControl.RETURN_KEY_SEARCHSet the text of the return key to "Search".
Murl.IKeyboardControl.RETURN_KEY_SENDSet the text of the return key to "Send".
Murl.IKeyboardControl.RETURN_KEY_DONESet the text of the return key to "Done".
Murl.IKeyboardControl.NUM_RETURN_KEY_TYPES


Functions



Methods


SetKeyboardType(keyboardType)

Set the keyboard type of the on-screen keyboard.

SetKeyboardType(Murl.IKeyboardControl.KeyboardType keyboardType)

Parameters
keyboardTypeThe keyboard type.

SetReturnKeyType(returnKeyType)

Set the return key type of the on-screen keyboard.

SetReturnKeyType(Murl.IKeyboardControl.ReturnKeyType returnKeyType)

Parameters
returnKeyTypeThe return key type.

Show()

Show the on-screen keyboard.

Show()


Hide()

Hide the on-screen keyboard.

Hide()


IsShowing()

Check if the on-screen keyboard is showing.

Boolean IsShowing()

Returns
Boolean true if the on-screen keyboard is showing.

WasClosed()

Check if the on-screen keyboard was closed in the most recent tick.

Boolean WasClosed()

Returns
Boolean true if the on-screen keyboard was closed.

HasTextfield()

Check if the on-screen keyboard has a text field for editing. The on-screen keyboard text field is currently supported on tvOS only.

Boolean HasTextfield()

Returns
Boolean true if the on-screen keyboard has a text field for editing.

SetTitle(title)

Set the title string for the text field. The title string is a text displayed above the text field, containing one line with automatic font size fitting.

SetTitle(String title)

Parameters
titleThe title string for the text field.

SetDescription(description)

Set the description string for the text field. The description string is a text displayed below the title text, containing two lines with automatic line break.

SetDescription(String description)

Parameters
descriptionThe description string for the text field.

SetText(text)

Set the initial editing string for the text field. The initial editing string must be set before Show() the keyboard.

SetText(String text)

Parameters
textThe initial editing string for the text field.

GetText()

Get the editing string from the text field. The edited string is available when the keyboard WasClosed().

String GetText()

Returns
String The editing string from the text field.