BaseKey QML Type | Qt Virtual Keyboard | Qt 6.12.0
Description: Common parent for all key types.
Keywords: qmltype

- Qt 6.12
- Qt Virtual Keyboard
- QML Types
- QtQuick.VirtualKeyboard.Components
- BaseKey
- Qt Virtual Keyboard | Commercial or GPLv3

# BaseKey QML Type

Common parent for all key types. More...

Import Statement: | `import QtQuick.VirtualKeyboard.Components`
Inherits: | Item
Inherited By: | BackspaceKey, ChangeLanguageKey, EnterKey, FillerKey, FlickKey, HandwritingModeKey, HideKeyboardKey, InputModeKey, Key, ModeKey, NumberKey, ShiftKey, SpaceKey, and SymbolModeKey

- List of all members, including inherited members

## Properties

- active : bool
- alternativeKeys : var
- displayAlternativeKeys : var `(since 6.2)`
- displayText : string
- effectiveAlternativeKeys : var `(since QtQuick.VirtualKeyboard 2.0)`
- effectiveAlternativeKeysHighlightIndex : int `(since QtQuick.VirtualKeyboard 2.0)`
- functionKey : bool
- highlighted : bool
- key : int
- keyPanelDelegate : alias
- keyType : int `(since 6.1)`
- noKeyEvent : bool `(since QtQuick.VirtualKeyboard 1.3)`
- noModifier : bool `(since QtQuick.VirtualKeyboard 1.3)`
- pressed : bool
- repeat : bool
- showPreview : bool
- smallText : string `(since QtQuick.VirtualKeyboard 2.0)`
- smallTextVisible : bool `(since QtQuick.VirtualKeyboard 2.0)`
- soundEffect : url `(since QtQuick.VirtualKeyboard 1.1)`
- text : string
- uppercased : bool
- weight : real

## Signals

- clicked()

## Detailed Description

BaseKey is a common type for all keys in keyboard layout.

This type should not be used directly in the layouts. The specialized key types, such as Key or EnterKey should be used instead.

## Property Documentation

### active : bool

This property holds the active status of the key.

This property is automatically set to true when the key is pressed.

### alternativeKeys : var

Sets the list of alternative keys.

This property can be set to a string, or a list of strings. If the value is a string, the alternative keys are presented as individual characters of that string. If the value is a list of strings, the list is used instead.

The alternative keys are presented to the user by pressing and holding a key with this property set.

Note: If the alternative keys contains the key `text`, it will be filtered from the `effectiveAlternativeKeys` and its position will be used as an indicator for the highlighted item instead.

The default is empty list.

### displayAlternativeKeys : var `[since 6.2]`

This property allows overriding the list of key strings presented to the user in the alternative keys view.

This property was introduced in Qt 6.2.

### displayText : string

Sets the display text.

This string is rendered in the keyboard layout.

The default value is the key text.

### effectiveAlternativeKeys : var `[read-only, since QtQuick.VirtualKeyboard 2.0]`

This property contains the effective alternative keys presented to user.

The list is contains the items in the `alternativeKeys` excluding the `text` item.

This property was introduced in QtQuick.VirtualKeyboard 2.0.

### effectiveAlternativeKeysHighlightIndex : int `[read-only, since QtQuick.VirtualKeyboard 2.0]`

This property contains the index of highlighted item in the `effectiveAlternativeKeys`.

The index is calculated from the index of the key `text` in the `alternativeKeys`.

For example, if the alternative keys contains "çcċčć" and the key `text` is "c", this index will become 1 and the effective alternative keys presented to user will be "ç[ċ]čć".

This property was introduced in QtQuick.VirtualKeyboard 2.0.

### functionKey : bool

Sets the function key attribute.

The default is false.

### highlighted : bool

Sets the highlighted status of the key.

The default is false.

### key : int

Sets the key code for input method processing.

The default is Qt.Key_unknown.

### keyPanelDelegate : alias

Sets the key panel delegate for the key.

This property is essential for key decoration. Without a key panel delegate, the key is invisible. This property should be assigned in the inherited key type.

### keyType : int `[since 6.1]`

Key type for the specialized key. Possible values are defined by the {QtVirtualKeyboard::KeyType}{key type enumeration}.

For example, SpaceKey sets this value to QtVirtualKeyboard.KeyType.SpaceKey.

This property was introduced in Qt 6.1.

### noKeyEvent : bool `[since QtQuick.VirtualKeyboard 1.3]`

This property controls whether the key emits key events for input method processing. When true, the key events are disabled.

By default, the key event is emitted if the key is not unknown or the text is not empty.

This property was introduced in QtQuick.VirtualKeyboard 1.3.

### noModifier : bool `[since QtQuick.VirtualKeyboard 1.3]`

Disables key modifiers on the emitted key.

The default is false.

This property was introduced in QtQuick.VirtualKeyboard 1.3.

### pressed : bool

This property holds the pressed status of the key.

The pressed status can only be true if the key is both enabled and active. When the key state becomes pressed, it triggers a key down event for the input engine. A key up event is triggered when the key is released.

### repeat : bool

Sets the key repeat attribute.

If the repeat is enabled, the key will repeat the input events while held down. The repeat should not be used if alternativeKeys is also set.

The default is false.

### showPreview : bool

Sets the show preview attribute.

By default, the character preview popup is not shown for function keys, nor when the focused input item hides the text it displays, for example a password field. In the latter case the preview would reveal the characters the input item masks.

### smallText : string `[since QtQuick.VirtualKeyboard 2.0]`

Sets the small text rendered in the corner of the key.

The default value based on the default item in the effective alternative keys.

This property was introduced in QtQuick.VirtualKeyboard 2.0.

### smallTextVisible : bool `[since QtQuick.VirtualKeyboard 2.0]`

Sets the visibility of small text.

The default value is inherited from the parent.

This property was introduced in QtQuick.VirtualKeyboard 2.0.

### soundEffect : url `[read-only, since QtQuick.VirtualKeyboard 1.1]`

This property holds the sound effect to be played on key press.

This property is read-only since the sound effects are defined in the keyboard style.

This property was introduced in QtQuick.VirtualKeyboard 1.1.

### text : string

Sets the key text for input method processing.

In most cases, this is the Unicode representation of the key code.

The default value is an empty string.

### uppercased : bool

This property holds the uppercase status of the key.

By default, this property reflects the uppercase status of the keyboard.

### weight : real

Sets the key weight value which determines the relative size of the key.

Use this property to change the key size in the layout.

The default value is inherited from the parent element of the key in the layout hierarchy.

## Signal Documentation

### clicked()

This signal is triggered when the key is pressed, allowing custom processing of key.

Note: The corresponding handler is `onClicked`.