VirtualKeyboardSettings QML Type

Provides settings for virtual keyboard. More...

Import Statement: import QtQuick.VirtualKeyboard.Settings 2.0
Since: QtQuick.VirtualKeyboard 1.2

Properties

Detailed Description

This module provides VirtualKeyboarSettings singleton instance, which can be used to configure the virtual keyboard settings.

Please note that the settings have only effect in the current application's lifetime, that is, configuration changes are not permanent.

For example, to change the keyboard style in application:


  Component.onCompleted: VirtualKeyboardSettings.styleName = "retro"

Property Documentation

activeLocales : list<string>

This property contains a list of activated languages of the virtual keyboard.

The list of active languages is a subset of the available languages, and can be used to limit the list of available languages in the application lifetime.

This QML property was introduced in QtQuick.VirtualKeyboard.Settings 2.0.


availableLocales : list<string>

This property contains a list of languages supported by the virtual keyboard.

This list is read-only and depends on the build-time configuration of the virtual keyboard.

This QML property was introduced in QtQuick.VirtualKeyboard.Settings 2.0.


locale : string

This property provides the default locale for the keyboard.

When the locale is not specified, the default system locale is used instead.

If the keyboard locale is different from the new default locale, keyboard language is changed immediately to reflect the new locale. If the locale setting is incorrect, or it is not in the list of supported locales, it is ignored and the default setting is used instead.

A locale is supported if it is included in the list of availableLocales.

This QML property was introduced in QtQuick.VirtualKeyboard.Settings 2.0.


styleName : string

This property provides the current style. Application can change the keyboard style by setting the styleName to different value.

The system wide keyboard style can be affected by setting the QT_VIRTUALKEYBOARD_STYLE environment variable.