Qt Documentation

Contents

QVirtualKeyboardInputContext Class

Provides access to an input context. More...

Header: #include <QVirtualKeyboardInputContext>
qmake: QT += virtualkeyboard
Instantiated By: InputContext
Inherits: QObject

Properties

  • 1 property inherited from QObject

Public Functions

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
Qt::InputMethodHints inputMethodHints() const
bool isAnimating() const
bool isCapsLockActive() const
bool isSelectionControlVisible() const
bool isShiftActive() const
bool isUppercase() const
QString locale() const
QString preeditText() const
QList<QInputMethodEvent::Attribute> preeditTextAttributes() 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 = ..., int replaceFrom = 0, int replaceLength = 0)
QString surroundingText() const
  • 31 public functions inherited from QObject

Signals

void anchorPositionChanged()
void anchorRectIntersectsClipRectChanged()
void anchorRectangleChanged()
void animatingChanged()
void capsLockActiveChanged()
void cursorPositionChanged()
void cursorRectIntersectsClipRectChanged()
void cursorRectangleChanged()
void inputMethodHintsChanged()
void localeChanged()
void preeditTextChanged()
void selectedTextChanged()
void selectionControlVisibleChanged()
void shiftActiveChanged()
void surroundingTextChanged()
void uppercaseChanged()

Static Public Members

const QMetaObject staticMetaObject
  • 9 static public members inherited from QObject

Additional Inherited Members

  • 1 public slot inherited from QObject
  • 9 protected functions inherited from QObject

Detailed Description

Provides access to an input context.

Property Documentation

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()

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.

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()

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()

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()

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.

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()

inputEngine : QVirtualKeyboardInputEngine* const

This property holds the input engine.

This property stores the input engine.

Access functions:

QVirtualKeyboardInputEngine *inputEngine() const

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()

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 = ..., int replaceFrom = 0, int replaceLength = 0)

Notifier signal:

void preeditTextChanged()

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()

selectionControlVisible : const bool

Holds true if the selection control is currently visible.

Access functions:

bool isSelectionControlVisible() const

Notifier signal:

void selectionControlVisibleChanged()

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()

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()

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

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.

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.

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.

QList<QInputMethodEvent::Attribute> QVirtualKeyboardInputContext::preeditTextAttributes() const

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.

© 2019 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.