KeyboardStyle QML Type

Template for the alternative keys list background.

Bottom margin for the alternate keys list panel.

Template for the alternative keys list item.

Template for the alternative keys list highlight.

Height of the alternate keys list item.

Width of the alternate keys list item.

Left margin for the alternate keys list panel.

Right margin for the alternate keys list panel.

Top margin for the alternate keys list panel.

Template for the backspace key.

Template for the character preview popup.

If the delegate contains the text property, the property is updated with the display text when the component becomes active.

property string text

Example:

characterPreviewDelegate: Item {
    property string text
    id: characterPreview
    Rectangle {
        id: characterPreviewBackground
        anchors.fill: parent
        ...
        Text {
            text: characterPreview.text
            anchors.fill: parent
            ...
        }
    }
}

Number of pixels between the top of each key and the bottom of the characterPreviewDelegate.

Template for the enter key.

This property holds the delegate for the background of the full screen input.

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

This property holds the text color for the full screen input field.

The default color is black.

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

This property holds the delegate for the background of the full screen input container.

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

This property holds the delegate for the cursor in the full screen input field.

The delegate should toggle the visibility of the cursor according to the parent.blinkStatus property defined for the full screen input field. For example:

fullScreenInputCursor: Rectangle {
    width: 1
    color: "#000"
    visible: parent.blinkStatus
}

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

This property holds the font for the full screen input field.

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

This property holds the margins around the full screen input field.

The default value is 0.

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

This property holds the padding around the full screen input content.

The default value is 0.

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

This property holds the password mask character for the full screen input field.

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

This property holds the selected text color for the full screen input field.

The default color is set to fullScreenInputColor.

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

This property holds the selection color for the full screen input field.

The default color is semi-transparent black.

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

Template for the function popup list background.

This property was introduced in QtQuick.VirtualKeyboard.Styles 6.2.

Template for the function list item.

The following properties are available to the item:

• keyboardFunction - Keyboard function of the current item.

This property was introduced in QtQuick.VirtualKeyboard.Styles 6.2.

Template for the function popup list highlight.

This property was introduced in QtQuick.VirtualKeyboard.Styles 6.2.

Template for the handwriting mode key.

Template for the hide key.

Template for the regular keys.

Example:

keyPanel: KeyPanel {
    Rectangle {
        anchors.fill: parent
        ...
        Text {
            anchors.fill: parent
            text: control.displayText
            ...
        }
    }
}

Template for the keyboard background.

Example:

keyboardBackground: Rectangle {
    color: "black"
}

The design height of the keyboard.

The design width of the keyboard.

The current height of the keyboard.

The distance between the bottom-most keys and the bottom edge of the keyboard container, expressed as a percentage (0.0 - 1.0) of the keyboard's height.

The distance between the left-most keys and the left edge of the keyboard, expressed as a percentage (0.0 - 1.0) of the keyboard's width.

The distance between the right-most keys and the right edge of the keyboard, expressed as a percentage (0.0 - 1.0) of the keyboard's width.

This value is proportional to the keyboard's width.

The distance between the top-most keys and the top edge of the keyboard, expressed as a percentage (0.0 - 1.0) of the keyboard's height.

Template for the language key.

This property holds the transition to apply to items that are added to the language list view.

This property was introduced in QtQuick.VirtualKeyboard.Styles 2.1.

Template for the language list background.

This property was introduced in QtQuick.VirtualKeyboard.Styles 2.1.

Template for the language list item.

The following properties are available to the item:

• displayName Display name of the language.

This property was introduced in QtQuick.VirtualKeyboard.Styles 2.1.

Template for the language list highlight.

This property was introduced in QtQuick.VirtualKeyboard.Styles 2.1.

This property holds the transition to apply to items that are removed from the language list view.

This property was introduced in QtQuick.VirtualKeyboard.Styles 2.1.

This property determines whether a popup list will be shown when the language key is clicked. If this property is false, clicking the language key cycles through the available languages one at a time.

The default value is false.

This property was introduced in QtQuick.VirtualKeyboard.Styles 2.1.

Template for the generic mode key.

This template provides a visualization of the key in which the state can be on or off. This template is used in situations where the key label will remain the same regardless of status.

The current state is available in the control.mode property.

Template for the navigation highlight item.

This item is used in arrow-key-navigation mode to highlight the navigation focus on the keyboard.

The item is typically a transparent rectangle with a high contrast border.

This property was introduced in QtQuick.VirtualKeyboard.Styles 1.1.

This property holds the transition to apply to items that are added to the popup list view.

This property was introduced in QtQuick.VirtualKeyboard.Styles 2.1.

Template for the popup list background.

This property was introduced in QtQuick.VirtualKeyboard.Styles 2.1.

Template for the popup list item.

The following properties are available to the item:

• display Display text for the current item.

• wordCompletionLength Word completion length measured from the end of the display text.

• dictionary Dictionary type of the word, see QVirtualKeyboardSelectionListModel::DictionaryType.

• canRemoveSuggestion A boolean indicating if the word can be removed from dictionary.

This property was introduced in QtQuick.VirtualKeyboard.Styles 2.1.

Template for the popup list highlight.

This property was introduced in QtQuick.VirtualKeyboard.Styles 2.1.

This property holds the transition to apply to items that are removed from the popup list view.

This property was introduced in QtQuick.VirtualKeyboard.Styles 2.1.

The keyboard style scale hint. This value is determined by dividing keyboardHeight by keyboardDesignHeight. All pixel dimensions must be proportional to this value.

This item is used to indicate where the bounds of the text selection is and to be able to interactively move the start or end of the selection. The same item is used for both start and end selection.

Selection handles are currently only supported for the application-based integration method.

This property was introduced in QtQuick.VirtualKeyboard.Styles 2.1.

This property holds the transition to apply to items that are added to the selection list view.

This property was introduced in QtQuick.VirtualKeyboard.Styles 1.3.

Template for the selection list background.

Template for the selection list item.

The following properties are available to the item:

• display Display text for the current item.

• wordCompletionLength Word completion length measured from the end of the display text.

• dictionary Dictionary type of the word, see QVirtualKeyboardSelectionListModel::DictionaryType.

• canRemoveSuggestion A boolean indicating if the word can be removed from dictionary.

Selection list height.

Template for the selection list highlight.

This property holds the transition to apply to items that are removed from the selection list view.

This property was introduced in QtQuick.VirtualKeyboard.Styles 1.3.

Template for the shift key.

Template for the space key.

Template for the symbol mode key.

Template for rendering a Trace object.

This property was introduced in QtQuick.VirtualKeyboard.Styles 2.1.

Template for the trace input key.

This property was introduced in QtQuick.VirtualKeyboard.Styles 2.1.