Keyboard

Module that handles system keyboard. More...

Enumerations
enum	KeyMode { MODE_TEXT , MODE_PASSWORD }
	Keyboard modes to use with Keyboard.start. More...
enum	KeyType { TYPE_DEFAULT , TYPE_LATIN , TYPE_NUMBER , TYPE_NUMBER_EXT }
	Keyboard types to use with Keyboard.start. More...
enum	KeyOption { OPT_MULTILINE , OPT_NO_AUTOCAP , OPT_NO_ASSISTANCE }
	Optional keyboard features usable. More...

Functions
void	Keyboard::start (string title, string text, int length, KeyType type, KeyMode mode, KeyOption opt)
	Start a keyboard instance.
DlgState	Keyboard::getState (void)
	Get keyboard state.
string	Keyboard::getInput (void)
	Get keyboard user input.
void	Keyboard::clear (void)
	Close current system keyboard instance.

Detailed Description

Module that handles system keyboard.

Enumeration Type Documentation

KeyMode

enum KeyMode

Keyboard modes to use with Keyboard.start.

Enumerator
MODE_TEXT	Text mode.
MODE_PASSWORD	Password mode.

KeyType

enum KeyType

Keyboard types to use with Keyboard.start.

Enumerator
TYPE_DEFAULT	Default type.
TYPE_LATIN	Latin encode type.
TYPE_NUMBER	Basic number type.
TYPE_NUMBER_EXT	Extended number type.

KeyOption

enum KeyOption

Optional keyboard features usable.

Enumerator
OPT_MULTILINE	Multiline keyboard.
OPT_NO_AUTOCAP	Disabled auto-cap on first letter.
OPT_NO_ASSISTANCE	Disabled word assistant.

Function Documentation

start()

void Keyboard::start	(	string	title,
		string	text,
		int	length,
		KeyType	type,
		KeyMode	mode,
		KeyOption	opt
	)

Start a keyboard instance.

Usage example:

Keyboard.start("Insert a text", "Text", 512, TYPE_DEFAULT, MODE_TEXT, OPT_MULTILINE + OPT_NO_AUTOCAP)

Parameters

title	- The keyboard title.
text	- The keyboard initial text.
length	- The text maximum length (optional).
type	- The keyboard type (optional).
mode	- The keyboard mode (optional).
opt	- Optional keyboard features to use (optional).

getState()

DlgState Keyboard::getState

(

void

)

Get keyboard state.

Usage example:

state = Keyboard.getState()

Returns

Current state of the system keyboard instance.

getInput()

string Keyboard::getInput

(

void

)

Get keyboard user input.

Usage example:

if Keyboard.getState() == FINISHED then
        result_text = Keyboard.getInput()
end

Returns

The text entered by the user.

clear()

void Keyboard::clear

(

void

)

Close current system keyboard instance.

Usage example:

Keyboard.clear()