QVirtualKeyboardInputContext Class
Provides access to an input context. More...
Header: | #include <QVirtualKeyboardInputContext> |
Instantiated By: | InputContext |
Inherits: | QObject |
Properties
|
|
Public Functions
QVirtualKeyboardInputContext(QObject *parent = nullptr) | |
virtual | ~QVirtualKeyboardInputContext() |
int | anchorPosition() const |
bool | anchorRectIntersectsClipRect() const |
QRectF | anchorRectangle() const |
void | clear() |
void | commit() |
void | commit(const QString &text, int replaceFrom = 0, int replaceLength = 0) |
int | cursorPosition() const |
bool | cursorRectIntersectsClipRect() const |
QRectF | cursorRectangle() const |
QVirtualKeyboardInputEngine * | inputEngine() const |
QObject * | inputItem() const |
Qt::InputMethodHints | inputMethodHints() const |
bool | isAnimating() const |
bool | isCapsLockActive() const |
bool | isSelectionControlVisible() const |
bool | isShiftActive() const |
bool | isUppercase() const |
QVirtualKeyboardObserver * | keyboardObserver() const |
QString | locale() const |
QString | preeditText() const |
QVirtualKeyboardInputContextPrivate * | priv() const |
QString | selectedText() const |
void | sendKeyClick(int key, const QString &text, int modifiers = 0) |
void | setAnimating(bool isAnimating) |
void | setPreeditText(const QString &text, QList<QInputMethodEvent::Attribute> attributes = QList<QInputMethodEvent::Attribute>(), int replaceFrom = 0, int replaceLength = 0) |
void | setSelectionOnFocusObject(const QPointF &anchorPos, const QPointF &cursorPos) |
QString | surroundingText() const |
Signals
void | anchorPositionChanged() |
void | anchorRectIntersectsClipRectChanged() |
void | anchorRectangleChanged() |
void | animatingChanged() |
void | capsLockActiveChanged() |
void | cursorPositionChanged() |
void | cursorRectIntersectsClipRectChanged() |
void | cursorRectangleChanged() |
void | inputItemChanged() |
void | inputMethodHintsChanged() |
void | localeChanged() |
void | preeditTextChanged() |
void | selectedTextChanged() |
void | selectionControlVisibleChanged() |
void | shiftActiveChanged() |
void | surroundingTextChanged() |
void | uppercaseChanged() |
Detailed Description
\inmodule
QtVirtualKeyboard \ingroup
qtvirtualkeyboard-cpp-for-devs
Property Documentation
[read-only]
anchorPosition : const int
This property holds the anchor position.
This property is changed when the anchor position changes.
Access functions:
int | anchorPosition() const |
Notifier signal:
void | anchorPositionChanged() |
[read-only]
anchorRectIntersectsClipRect : const bool
Holds true
if the bounding rectangle of the selection anchor intersects the exposed input item rectangle.
Access functions:
bool | anchorRectIntersectsClipRect() const |
Notifier signal:
void | anchorRectIntersectsClipRectChanged() |
See also Qt::ImAnchorRectangle and Qt::ImInputItemClipRectangle.
[read-only]
anchorRectangle : const QRectF
This property holds the anchor rectangle.
This property is changed when the anchor rectangle changes.
Access functions:
QRectF | anchorRectangle() const |
Notifier signal:
void | anchorRectangleChanged() |
animating : bool
This property holds the animating status.
Use this property to set the animating status, for example during UI transitioning states.
Access functions:
bool | isAnimating() const |
void | setAnimating(bool isAnimating) |
Notifier signal:
void | animatingChanged() |
[read-only]
capsLock : const bool
This property holds the caps lock status. \deprecated
Use capsLockActive instead.
This property is changed when the caps lock status changes.
Access functions:
bool | isCapsLockActive() const |
Notifier signal:
void | capsLockActiveChanged() |
[read-only]
capsLockActive : const bool
This property holds the caps lock status.
This property is changed when the caps lock status changes.
Access functions:
bool | isCapsLockActive() const |
Notifier signal:
void | capsLockActiveChanged() |
[read-only]
cursorPosition : const int
This property holds the cursor position.
This property is changed when the cursor position changes.
Access functions:
int | cursorPosition() const |
Notifier signal:
void | cursorPositionChanged() |
[read-only]
cursorRectIntersectsClipRect : const bool
Holds true
if the bounding rectangle of the input cursor intersects the exposed input item rectangle.
Access functions:
bool | cursorRectIntersectsClipRect() const |
Notifier signal:
void | cursorRectIntersectsClipRectChanged() |
See also Qt::ImCursorRectangle and Qt::ImInputItemClipRectangle.
[read-only]
cursorRectangle : const QRectF
This property holds the cursor rectangle.
This property is changed when the cursor rectangle changes.
Access functions:
QRectF | cursorRectangle() const |
Notifier signal:
void | cursorRectangleChanged() |
[read-only]
inputEngine : QVirtualKeyboardInputEngine* const
This property holds the input engine.
This property stores the input engine.
Access functions:
QVirtualKeyboardInputEngine * | inputEngine() const |
[read-only]
inputItem : QObject* const
This property holds the focused input item. \deprecated
This property is changed when the focused input item changes.
Access functions:
QObject * | inputItem() const |
Notifier signal:
void | inputItemChanged() |
[read-only]
inputMethodHints : const Qt::InputMethodHints
This property holds the input method hints.
This property is changed when the input method hints changes.
Access functions:
Qt::InputMethodHints | inputMethodHints() const |
Notifier signal:
void | inputMethodHintsChanged() |
[read-only]
keyboardObserver : QVirtualKeyboardObserver* const
\since
QtQuick.VirtualKeyboard 6.1
Holds the keyboard observer object, which can be used to receive notifications of keyboard change events.
Access functions:
QVirtualKeyboardObserver * | keyboardObserver() const |
[read-only]
locale : const QString
This property holds the locale.
This property is changed when the input locale changes.
Access functions:
QString | locale() const |
Notifier signal:
void | localeChanged() |
preeditText : QString
This property holds the pre-edit text.
This property sets the pre-edit text.
Access functions:
QString | preeditText() const |
void | setPreeditText(const QString &text, QList<QInputMethodEvent::Attribute> attributes = QList<QInputMethodEvent::Attribute>(), int replaceFrom = 0, int replaceLength = 0) |
Notifier signal:
void | preeditTextChanged() |
[read-only]
priv : QVirtualKeyboardInputContextPrivate* const
\internal
Access functions:
QVirtualKeyboardInputContextPrivate * | priv() const |
[read-only]
selectedText : const QString
This property holds the selected text.
This property is changed when the selected text changes.
Access functions:
QString | selectedText() const |
Notifier signal:
void | selectedTextChanged() |
[read-only]
selectionControlVisible : const bool
Holds true
if the selection control is currently visible.
Access functions:
bool | isSelectionControlVisible() const |
Notifier signal:
void | selectionControlVisibleChanged() |
[read-only]
shift : const bool
This property holds the shift status. \deprecated
Use shiftActive instead.
This property is changed when the shift status changes.
Access functions:
bool | isShiftActive() const |
Notifier signal:
void | shiftActiveChanged() |
[read-only]
shiftActive : const bool
This property holds the shift status.
This property is changed when the shift status changes.
Access functions:
bool | isShiftActive() const |
Notifier signal:
void | shiftActiveChanged() |
[read-only]
surroundingText : const QString
This property holds the surrounding text around cursor.
This property is changed when the surrounding text around the cursor changes.
Access functions:
QString | surroundingText() const |
Notifier signal:
void | surroundingTextChanged() |
[read-only]
uppercase : const bool
This property holds the uppercase status.
This property is true
when either shiftActive or capsLockActive is true
.
Access functions:
bool | isUppercase() const |
Notifier signal:
void | uppercaseChanged() |
Member Function Documentation
[explicit]
QVirtualKeyboardInputContext::QVirtualKeyboardInputContext(QObject *parent = nullptr)
\internal
Constructs an input context with parent as the platform input context.
[virtual noexcept]
QVirtualKeyboardInputContext::~QVirtualKeyboardInputContext()
\internal
Destroys the input context and frees all allocated resources.
[invokable]
void QVirtualKeyboardInputContext::clear()
Clears the pre-edit text.
Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.
[invokable]
void QVirtualKeyboardInputContext::commit()
Commits the current pre-edit text.
Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.
[invokable]
void QVirtualKeyboardInputContext::commit(const QString &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.
Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.
QVirtualKeyboardInputContextPrivate *QVirtualKeyboardInputContext::priv() const
\internal
Note: Getter function for property priv.
[invokable]
void QVirtualKeyboardInputContext::sendKeyClick(int key, const QString &text, int modifiers = 0)
Sends a key click event with the given key, text and modifiers to the input item that currently has focus.
Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.
[invokable]
void QVirtualKeyboardInputContext::setSelectionOnFocusObject(const QPointF &anchorPos, const QPointF &cursorPos)
\internal
Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.