![]() |
Murl Engine API
Version 2018.3
|
The IKeyboardControl interface. More...
#include <murl_i_keyboard_control.h>
The IKeyboardControl interface.
Methods to control the on-screen keyboard.
Public Types | |
enum | KeyboardType { KEYBOARD_DEFAULT, KEYBOARD_URL, KEYBOARD_EMAIL, KEYBOARD_NUMBERS, KEYBOARD_PAD_NUMBERS, KEYBOARD_PAD_PHONE } |
Definition of the keyboard types. More... | |
enum | ReturnKeyType { RETURN_KEY_DEFAULT, RETURN_KEY_GO, RETURN_KEY_JOIN, RETURN_KEY_NEXT, RETURN_KEY_ROUTE, RETURN_KEY_SEARCH, RETURN_KEY_SEND, RETURN_KEY_DONE } |
Definition of the return key types. More... | |
Public Member Functions | |
virtual void | SetKeyboardType (KeyboardType keyboardType)=0 |
Set the keyboard type of the on-screen keyboard. More... | |
virtual void | SetReturnKeyType (ReturnKeyType returnKeyType)=0 |
Set the return key type of the on-screen keyboard. More... | |
virtual void | Show ()=0 |
Show the on-screen keyboard. | |
virtual void | Hide ()=0 |
Hide the on-screen keyboard. | |
virtual Bool | IsShowing () const =0 |
Check if the on-screen keyboard is showing. More... | |
virtual Bool | WasClosed () const =0 |
Check if the on-screen keyboard was closed in the most recent tick. More... | |
virtual Bool | HasTextfield () const =0 |
Check if the on-screen keyboard has a text field for editing. More... | |
virtual void | SetTitle (const String &title)=0 |
Set the title string for the text field. More... | |
virtual void | SetDescription (const String &description)=0 |
Set the description string for the text field. More... | |
virtual void | SetText (const String &text)=0 |
Set the initial editing string for the text field. More... | |
virtual const String & | GetText () const =0 |
Get the editing string from the text field. More... | |
![]() | |
virtual const String & | GetName () const =0 |
Get the controlable's name. More... | |
virtual void | FrameUpdate ()=0 |
Is executed in the platform thread context each frame tick. | |
virtual void | LogicUpdate ()=0 |
Is executed in the logic thread context each logic tick. | |
virtual void | ConfigChanged (const IAppConfiguration *appConfig)=0 |
Notification of changed configuration. More... | |
Definition of the keyboard types.
The PAD keyboard types may not offer a return key (e.g. Phone iOS).
Definition of the return key types.
The text of the return key is translated to the current language.
|
pure virtual |
Set the keyboard type of the on-screen keyboard.
keyboardType | The keyboard type. |
|
pure virtual |
Set the return key type of the on-screen keyboard.
returnKeyType | The return key type. |
|
pure virtual |
Check if the on-screen keyboard is showing.
|
pure virtual |
Check if the on-screen keyboard was closed in the most recent tick.
|
pure virtual |
Check if the on-screen keyboard has a text field for editing.
The on-screen keyboard text field is currently supported on tvOS only.
|
pure virtual |
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.
title | The title string for the text field. |
|
pure virtual |
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.
description | The description string for the text field. |
|
pure virtual |
Set the initial editing string for the text field.
The initial editing string must be set before Show() the keyboard.
text | The initial editing string for the text field. |
|
pure virtual |
Get the editing string from the text field.
The edited string is available when the keyboard WasClosed().