VirtualKeyboardSettings QML Type | Qt Virtual Keyboard 5.15.18

- Qt 5.15
- Qt Virtual Keyboard
- QML Types
- VirtualKeyboardSettings QML Type
- Qt Virtual Keyboard | Commercial or GPLv3

# VirtualKeyboardSettings QML Type

Provides settings for virtual keyboard. More...

Import Statement: | import QtQuick.VirtualKeyboard.Settings 2.15
Since: | QtQuick.VirtualKeyboard 1.2

- List of all members, including inherited members

## Properties

- activeLocales : list<string>
- availableLocales : list<string>
- fullScreenMode : bool
- locale : string
- styleName : string
- wordCandidateList
  - wordCandidateList.alwaysVisible : bool
  - wordCandidateList.autoHideDelay : int

## Detailed Description

This type provides a VirtualKeyboardSettings 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 property was introduced in QtQuick.VirtualKeyboard.Settings 2.0.

[read-only] 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 property was introduced in QtQuick.VirtualKeyboard.Settings 2.0.

fullScreenMode : bool

This property enables the fullscreen mode for the virtual keyboard.

In fullscreen mode, the virtual keyboard replicates the contents of the focused input field to the fullscreen input field located at the top of the keyboard.

For example, to activate the fullscreen mode when the screen aspect ratio is greater than 16:9:

     Binding {
         target: VirtualKeyboardSettings
         property: "fullScreenMode"
         value: (Screen.width / Screen.height) > (16.0 / 9.0)
     }

This property was introduced in QtQuick.VirtualKeyboard.Settings 2.2.

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 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.

wordCandidateList group
wordCandidateList.alwaysVisible : bool
wordCandidateList.autoHideDelay : int

Name | Description
--- | ---
autoHideDelay | This property defines the delay, in milliseconds, after which the word candidate list is hidden if empty. If the value is `0`, the list is immediately hidden when cleared. If the value is `-1`, the list is visible until input focus changes, or the input panel is hidden. The default value is `5000` milliseconds.
alwaysVisible | This property defines whether the word candidate list should always remain visible. The default value is `false`.
autoCommitWord | This property enables the automatic commit feature that is activated when the word candidate list is narrowed down to a single candidate. The automatic commit feature takes effect when the word candidate list initially contains multiple words and is reduced to single word after additional input. This word will be selected and committed automatically without user interaction. This property is set to `false` by default.

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