VirtualKeyboard Class Reference

Inherits QtQuick.Item, and Item.

Signals
void	error (string msg)
void	keypress (string text)

Properties
string	backspace
bool	hide
int	keyHeight
int	keySpacing
list	layout
int	margin
list	qwertyLayout
int	rowSpacing
string	shiftDownSymbol
bool	shiftKey
string	shiftUpSymbol

Detailed Description

A QML component providing an on screen keyboard.

VirtualKeyboard displays a virtual on screen keyboard that can be used in applications that need keyboard support, especially on mobile devices.

The component itself does not provide builtin localized keyboard layouts, the user has to define the keyboard-layout dynamically.

Definition at line 35 of file VirtualKeyboard.qml.

Member Function Documentation

void VirtualKeyboard::error ( string  msg )

signal

Emitted upon error.

Parameters

msg	Error message.

void VirtualKeyboard::keypress ( string  text )

signal

Emitted for every keypress.

Parameters

text	The label of the pressed key.

Property Documentation

string VirtualKeyboard::backspace

Symbol that can be used for the backspace key.

Remarks

This property is read-only

Definition at line 51 of file VirtualKeyboard.qml.

bool VirtualKeyboard::hide

Whether the keyboard should be hidden.

Besides this property the visibility of the virtual keyboard also depends on the setting ApplicationSettings.isVirtualKeyboard and its successful initialization.

Definition at line 143 of file VirtualKeyboard.qml.

int VirtualKeyboard::keyHeight

Height of the keys in pixel.

Default: 45 * ApplicationInfo.ratio

Definition at line 128 of file VirtualKeyboard.qml.

int VirtualKeyboard::keySpacing

Horizontal spacing between keys in pixel.

Default: 3 * ApplicationInfo.ratio

Definition at line 122 of file VirtualKeyboard.qml.

list VirtualKeyboard::layout

Keyboard layout.

The layout should be provided by the user. It can contain unicode characters, and can be set dynamically also on a per-level basis.

The expected format of the layout property is a list of row lists. Example:

[
   [                                    <-- start of the first row
     { label: "1", shiftLabel: "!" },   <-- first key of the first row
     { label: "2", shiftLabel: "@" },
     ...
   ],
   [
     { label: "q", shiftLabel: "Q" },
     { label: "w", shiftLabel: "W" },
     ...
   ],
   ...
]

The order passed in layout will not be altered.

Use the shiftKey property to activate a shift button which allows to assign 2 letters on one key. You can define an additional shiftLabel per key, or leave it undefined, in which case VirtualKeyboard automatically defines the shift-label (using String.toLocaleUpperCase()).

Default is to use the qwertyLayout.

See also

qwertyLayout shiftKey

Definition at line 103 of file VirtualKeyboard.qml.

int VirtualKeyboard::margin

Margin around the keyboard in pixel.

Default: 5 * ApplicationInfo.ratio

Definition at line 134 of file VirtualKeyboard.qml.

list VirtualKeyboard::qwertyLayout

Default basic qwerty-layout used unless the user provides another.

See also

layout.

Remarks

This property is read-only

Definition at line 45 of file VirtualKeyboard.qml.

int VirtualKeyboard::rowSpacing

Vertical spacing between rows in pixel.

Default: 5 * ApplicationInfo.ratio

Definition at line 116 of file VirtualKeyboard.qml.

string VirtualKeyboard::shiftDownSymbol

Symbol for the shift-down key.

Remarks

This property is read-only

Definition at line 63 of file VirtualKeyboard.qml.

bool VirtualKeyboard::shiftKey

Whether a shift key should be used.

Definition at line 108 of file VirtualKeyboard.qml.

string VirtualKeyboard::shiftUpSymbol

Symbol for the shift-up key.

Remarks

This property is read-only

Definition at line 57 of file VirtualKeyboard.qml.

---

The documentation for this class was generated from the following file:

• VirtualKeyboard.qml