![]() |
Murl Engine Lua Addon API
Version 1.0 beta
|
The IKeyboardControl interface.
Methods to control the on-screen keyboard.
Definition of the keyboard types. The PAD keyboard types may not offer a return key (e.g. Phone iOS).
Murl.IKeyboardControl.KEYBOARD_DEFAULT | The default keyboard. |
Murl.IKeyboardControl.KEYBOARD_URL | A keyboard optimized for URL entry. |
Murl.IKeyboardControl.KEYBOARD_EMAIL | A keyboard optimized for specifying email addresses. |
Murl.IKeyboardControl.KEYBOARD_NUMBERS | The numbers and punctuation keyboard. |
Murl.IKeyboardControl.KEYBOARD_PAD_NUMBERS | A numeric keypad designed for PIN entry. |
Murl.IKeyboardControl.KEYBOARD_PAD_PHONE | A keypad designed for entering telephone numbers. |
Murl.IKeyboardControl.NUM_KEYBOARD_TYPES |
Definition of the return key types. The text of the return key is translated to the current language.
Murl.IKeyboardControl.RETURN_KEY_DEFAULT | Set the text of the return key to "return". |
Murl.IKeyboardControl.RETURN_KEY_GO | Set the text of the return key to "Go". |
Murl.IKeyboardControl.RETURN_KEY_JOIN | Set the text of the return key to "Join". |
Murl.IKeyboardControl.RETURN_KEY_NEXT | Set the text of the return key to "Next". |
Murl.IKeyboardControl.RETURN_KEY_ROUTE | Set the text of the return key to "Route". |
Murl.IKeyboardControl.RETURN_KEY_SEARCH | Set the text of the return key to "Search". |
Murl.IKeyboardControl.RETURN_KEY_SEND | Set the text of the return key to "Send". |
Murl.IKeyboardControl.RETURN_KEY_DONE | Set the text of the return key to "Done". |
Murl.IKeyboardControl.NUM_RETURN_KEY_TYPES |
Set the keyboard type of the on-screen keyboard.
SetKeyboardType(Murl.IKeyboardControl.KeyboardType keyboardType)
keyboardType | The keyboard type. |
Set the return key type of the on-screen keyboard.
SetReturnKeyType(Murl.IKeyboardControl.ReturnKeyType returnKeyType)
returnKeyType | The return key type. |
Show the on-screen keyboard.
Show()
Hide the on-screen keyboard.
Hide()
Check if the on-screen keyboard is showing.
Boolean IsShowing()
Check if the on-screen keyboard was closed in the most recent tick.
Boolean WasClosed()
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()
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)
title | The title string for the text field. |
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)
description | The description string for the text field. |
Set the initial editing string for the text field. The initial editing string must be set before Show() the keyboard.
SetText(String text)
text | The initial editing string for the text field. |
Get the editing string from the text field. The edited string is available when the keyboard WasClosed().
String GetText()