InputContext QML Type

Provides access to an input context. More...

Properties

Methods

Detailed Description

\inqmlmoduleQtQuick.VirtualKeyboard \ingroup qtvirtualkeyboard-internal-qml

The InputContext can be accessed as singleton instance.

Property Documentation

[read-only] anchorPosition : int

\sinceQtQuick.VirtualKeyboard 2.2

This property is changed when the anchor position changes.


[read-only] anchorRectIntersectsClipRect : bool

\readonly

Holds true if the bounding rectangle of the selection anchor intersects the exposed input item rectangle.

See also Qt::ImAnchorRectangle and Qt::ImInputItemClipRectangle.


[read-only] anchorRectangle : rect

\sinceQtQuick.VirtualKeyboard 2.1

This property is changed when the anchor rectangle changes.


animating : bool

Use this property to set the animating status, for example during UI transitioning states.


[read-only] capsLock : bool

\deprecated

Use capsLockActive instead.

This property is changed when the caps lock status changes.


[read-only] capsLockActive : bool

\sinceQtQuick.VirtualKeyboard 2.4

This property is changed when the caps lock status changes.


[read-only] cursorPosition : int

This property is changed when the cursor position changes.


[read-only] cursorRectIntersectsClipRect : bool

\readonly

Holds true if the bounding rectangle of the input cursor intersects the exposed input item rectangle.

See also Qt::ImCursorRectangle and Qt::ImInputItemClipRectangle.


[read-only] cursorRectangle : rect

This property is changed when the cursor rectangle changes.


[read-only] inputEngine : InputEngine

This property stores the input engine.


[read-only] inputItem : QtObject

\deprecated

This property is changed when the focused input item changes.


[read-only] inputMethodHints : int

This property is changed when the input method hints changes.


[read-only] keyboardObserver : KeyboardObserver

\readonly\since QtQuick.VirtualKeyboard 6.1

Holds the keyboard observer object, which can be used to receive notifications of keyboard change events.


[read-only] locale : string

This property is changed when the input locale changes.


preeditText : string

This property sets the pre-edit text.


[read-only] selectedText : string

This property is changed when the selected text changes.


[read-only] selectionControlVisible : bool

\readonly

Holds true if the selection control is currently visible.


[read-only] shift : bool

\deprecated

Use shiftActive instead.

This property is changed when the shift status changes.


[read-only] shiftActive : bool

\sinceQtQuick.VirtualKeyboard 2.4

This property is changed when the shift status changes.


[read-only] surroundingText : string

This property is changed when the surrounding text around the cursor changes.


[read-only] uppercase : bool

\sinceQtQuick.VirtualKeyboard 2.2

This property is true when either shiftActive or capsLockActive is true.


Method Documentation

void clear()

Clears the pre-edit text.


void commit()

Commits the current pre-edit text.


void commit(string text, int replaceFrom = 0, int replaceLength = 0)

Commits the final text to the input item and optionally modifies the text relative to the start of the pre-edit text. If replaceFrom is non-zero, the text replaces the contents relative to replaceFrom with a length of replaceLength.


void sendKeyClick(int key, string text, int modifiers = 0)

Sends a key click event with the given key, text and modifiers to the input item that currently has focus.