InputContext QML Type
Provides access to an input context. More...
| Import Statement: | import QtQuick.VirtualKeyboard |
| In C++: | QVirtualKeyboardInputContext |
Properties
- anchorPosition : int
(since QtQuick.VirtualKeyboard 2.2) - anchorRectIntersectsClipRect : bool
- anchorRectangle : rect
(since QtQuick.VirtualKeyboard 2.1) - animating : bool
- capsLockActive : bool
(since QtQuick.VirtualKeyboard 2.4) - cursorPosition : int
- cursorRectIntersectsClipRect : bool
- cursorRectangle : rect
- inputEngine : InputEngine
- inputMethodHints : int
- keyboardObserver : KeyboardObserver
(since QtQuick.VirtualKeyboard 6.1) - locale : string
- preeditText : string
- selectedText : string
- selectionControlVisible : bool
- shiftActive : bool
(since QtQuick.VirtualKeyboard 2.4) - surroundingText : string
- uppercase : bool
(since QtQuick.VirtualKeyboard 2.2)
Methods
- void clear()
- void commit()
- void commit(string text, int replaceFrom, int replaceLength)
- void sendKeyClick(int key, string text, int modifiers)
Detailed Description
The InputContext can be accessed as singleton instance.
Property Documentation
anchorPosition : int |
This property is changed when the anchor position changes.
This property was introduced in QtQuick.VirtualKeyboard 2.2.
anchorRectIntersectsClipRect : bool |
Holds true if the bounding rectangle of the selection anchor intersects the exposed input item rectangle.
See also Qt::ImAnchorRectangle and Qt::ImInputItemClipRectangle.
anchorRectangle : rect |
This property is changed when the anchor rectangle changes.
This property was introduced in QtQuick.VirtualKeyboard 2.1.
animating : bool |
Use this property to set the animating status, for example during UI transitioning states.
capsLockActive : bool |
This property is changed when the caps lock status changes.
This property was introduced in QtQuick.VirtualKeyboard 2.4.
cursorPosition : int |
This property is changed when the cursor position changes.
cursorRectIntersectsClipRect : bool |
Holds true if the bounding rectangle of the input cursor intersects the exposed input item rectangle.
See also Qt::ImCursorRectangle and Qt::ImInputItemClipRectangle.
cursorRectangle : rect |
This property is changed when the cursor rectangle changes.
inputEngine : InputEngine |
This property stores the input engine.
inputMethodHints : int |
This property is changed when the input method hints changes.
keyboardObserver : KeyboardObserver |
Holds the keyboard observer object, which can be used to receive notifications of keyboard change events.
This property was introduced in QtQuick.VirtualKeyboard 6.1.
locale : string |
This property is changed when the input locale changes.
preeditText : string |
This property sets the pre-edit text.
selectedText : string |
This property is changed when the selected text changes.
selectionControlVisible : bool |
Holds true if the selection control is currently visible.
shiftActive : bool |
This property is changed when the shift status changes.
This property was introduced in QtQuick.VirtualKeyboard 2.4.
surroundingText : string |
This property is changed when the surrounding text around the cursor changes.
uppercase : bool |
This property is true when either shiftActive or capsLockActive is true.
This property was introduced in QtQuick.VirtualKeyboard 2.2.
Method Documentation
void clear() |
Clears the pre-edit text.
void commit() |
Commits the current pre-edit text.
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.
Sends a key click event with the given key, text and modifiers to the input item that currently has focus.