Murl::IKeyboardControl Interface Referenceabstract

The IKeyboardControl interface. More...

#include "murl_i_keyboard_control.h"

Inheritance diagram for Murl::IKeyboardControl:

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 StringGetText () const =0
 Get the editing string from the text field. More...
 
- Public Member Functions inherited from Murl::IControlable
virtual const StringGetName () 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...
 

Detailed Description

The IKeyboardControl interface.

Methods to control the on-screen keyboard.

Member Enumeration Documentation

◆ KeyboardType

Definition of the keyboard types.

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

Enumerator
KEYBOARD_DEFAULT 

The default keyboard.

KEYBOARD_URL 

A keyboard optimized for URL entry.

KEYBOARD_EMAIL 

A keyboard optimized for specifying email addresses.

KEYBOARD_NUMBERS 

The numbers and punctuation keyboard.

KEYBOARD_PAD_NUMBERS 

A numeric keypad designed for PIN entry.

KEYBOARD_PAD_PHONE 

A keypad designed for entering telephone numbers.

◆ ReturnKeyType

Definition of the return key types.

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

Enumerator
RETURN_KEY_DEFAULT 

Set the text of the return key to "return".

RETURN_KEY_GO 

Set the text of the return key to "Go".

RETURN_KEY_JOIN 

Set the text of the return key to "Join".

RETURN_KEY_NEXT 

Set the text of the return key to "Next".

RETURN_KEY_ROUTE 

Set the text of the return key to "Route".

RETURN_KEY_SEARCH 

Set the text of the return key to "Search".

RETURN_KEY_SEND 

Set the text of the return key to "Send".

RETURN_KEY_DONE 

Set the text of the return key to "Done".

Member Function Documentation

◆ SetKeyboardType()

virtual void Murl::IKeyboardControl::SetKeyboardType ( KeyboardType  keyboardType)
pure virtual

Set the keyboard type of the on-screen keyboard.

Parameters
keyboardTypeThe keyboard type.

◆ SetReturnKeyType()

virtual void Murl::IKeyboardControl::SetReturnKeyType ( ReturnKeyType  returnKeyType)
pure virtual

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

Parameters
returnKeyTypeThe return key type.

◆ IsShowing()

virtual Bool Murl::IKeyboardControl::IsShowing ( ) const
pure virtual

Check if the on-screen keyboard is showing.

Returns
true if the on-screen keyboard is showing.

◆ WasClosed()

virtual Bool Murl::IKeyboardControl::WasClosed ( ) const
pure virtual

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

Returns
true if the on-screen keyboard was closed.

◆ HasTextfield()

virtual Bool Murl::IKeyboardControl::HasTextfield ( ) const
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.

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

◆ SetTitle()

virtual void Murl::IKeyboardControl::SetTitle ( const String title)
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.

Parameters
titleThe title string for the text field.

◆ SetDescription()

virtual void Murl::IKeyboardControl::SetDescription ( const String description)
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.

Parameters
descriptionThe description string for the text field.

◆ SetText()

virtual void Murl::IKeyboardControl::SetText ( const String text)
pure virtual

Set the initial editing string for the text field.

The initial editing string must be set before Show() the keyboard.

Parameters
textThe initial editing string for the text field.

◆ GetText()

virtual const String& Murl::IKeyboardControl::GetText ( ) const
pure virtual

Get the editing string from the text field.

The edited string is available when the keyboard WasClosed().

Returns
The editing string from the text field.

The documentation for this interface was generated from the following file:
  • murl_i_keyboard_control.h


Copyright © 2011-2018 Spraylight GmbH.