![]() |
Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
|
#include <qandroidinputcontext.h>
Classes | |
| struct | ExtractedText |
Public Types | |
| enum | EditContext : uint32_t { CutButton = 1 << 0 , CopyButton = 1 << 1 , PasteButton = 1 << 2 , SelectAllButton = 1 << 3 , AllButtons = CutButton | CopyButton | PasteButton | SelectAllButton } |
| enum | HandleMode { Hidden = 0 , ShowCursor = 1 , ShowSelection = 2 , ShowEditPopup = 0x100 } |
| Public Types inherited from QPlatformInputContext | |
| enum | Capability { HiddenTextCapability = 0x1 } |
Public Slots | |
| void | safeCall (const std::function< void()> &func, Qt::ConnectionType conType=Qt::BlockingQueuedConnection) |
| void | updateCursorPosition () |
| void | updateSelectionHandles () |
| void | handleLocationChanged (int handleId, int x, int y) |
| void | touchDown (int x, int y) |
| void | longPress (int x, int y) |
| void | keyDown () |
| void | hideSelectionHandles () |
| Public Slots inherited from QObject | |
| void | deleteLater () |
| \threadsafe | |
Public Member Functions | |
| QAndroidInputContext () | |
| ~QAndroidInputContext () | |
| bool | isValid () const override |
| Returns input context validity. | |
| void | reset () override |
| Method to be called when input method needs to be reset. | |
| void | commit () override |
| void | update (Qt::InputMethodQueries queries) override |
| Notification on editor updates. | |
| void | invokeAction (QInputMethod::Action action, int cursorPosition) override |
| Called when the word currently being composed in the input item is tapped by the user. | |
| QRectF | keyboardRect () const override |
| This function can be reimplemented to return virtual keyboard rectangle in currently active window coordinates. | |
| bool | isAnimating () const override |
| This function can be reimplemented to return true whenever input method is animating shown or hidden. | |
| void | showInputPanel () override |
| Request to show input panel. | |
| void | hideInputPanel () override |
| Request to hide input panel. | |
| bool | isInputPanelVisible () const override |
| Returns input panel visibility status. | |
| bool | isComposing () const |
| void | clear () |
| void | setFocusObject (QObject *object) override |
| This virtual method gets called to notify updated focus to object. | |
| QObject * | focusObject () |
| void | sendShortcut (const QKeySequence &) |
| jboolean | beginBatchEdit () |
| jboolean | endBatchEdit () |
| jboolean | commitText (const QString &text, jint newCursorPosition) |
| jboolean | deleteSurroundingText (jint leftLength, jint rightLength) |
| jboolean | finishComposingText () |
| jint | getCursorCapsMode (jint reqModes) |
| const ExtractedText & | getExtractedText (jint hintMaxChars, jint hintMaxLines, jint flags) |
| QString | getSelectedText (jint flags) |
| QString | getTextAfterCursor (jint length, jint flags) |
| QString | getTextBeforeCursor (jint length, jint flags) |
| jboolean | replaceText (jint start, jint end, const QString text, jint newCursorPosition) |
| jboolean | setComposingText (const QString &text, jint newCursorPosition) |
| jboolean | setComposingRegion (jint start, jint end) |
| jboolean | setSelection (jint start, jint end) |
| jboolean | selectAll () |
| jboolean | cut () |
| jboolean | copy () |
| jboolean | copyURL () |
| jboolean | paste () |
| void | reportFullscreenMode (jboolean enabled) |
| jboolean | fullscreenMode () |
| Public Member Functions inherited from QPlatformInputContext | |
| QPlatformInputContext () | |
| ~QPlatformInputContext () | |
| virtual bool | hasCapability (Capability capability) const |
| Returns whether the implementation supports capability. | |
| virtual bool | filterEvent (const QEvent *event) |
| This function can be reimplemented to filter input events. | |
| void | emitKeyboardRectChanged () |
| Active QPlatformInputContext is responsible for providing keyboardRectangle property to QInputMethod. | |
| void | emitAnimatingChanged () |
| Active QPlatformInputContext is responsible for providing animating property to QInputMethod. | |
| void | emitInputPanelVisibleChanged () |
| Active QPlatformInputContext is responsible for providing visible property to QInputMethod. | |
| virtual QLocale | locale () const |
| void | emitLocaleChanged () |
| virtual Qt::LayoutDirection | inputDirection () const |
| void | emitInputDirectionChanged (Qt::LayoutDirection newDirection) |
| bool | inputMethodAccepted () const |
Returns true if current focus object supports input method events. | |
| Public Member Functions inherited from QObject | |
| Q_INVOKABLE | QObject (QObject *parent=nullptr) |
| Constructs an object with parent object parent. | |
| virtual | ~QObject () |
| Destroys the object, deleting all its child objects. | |
| virtual bool | event (QEvent *event) |
| This virtual function receives events to an object and should return true if the event e was recognized and processed. | |
| virtual bool | eventFilter (QObject *watched, QEvent *event) |
| Filters events if this object has been installed as an event filter for the watched object. | |
| QString | objectName () const |
| Q_WEAK_OVERLOAD void | setObjectName (const QString &name) |
| Sets the object's name to name. | |
| void | setObjectName (QAnyStringView name) |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
| QBindable< QString > | bindableObjectName () |
| bool | isWidgetType () const |
Returns true if the object is a widget; otherwise returns false. | |
| bool | isWindowType () const |
Returns true if the object is a window; otherwise returns false. | |
| bool | isQuickItemType () const |
Returns true if the object is a QQuickItem; otherwise returns false. | |
| bool | isQmlExposed () const noexcept |
| Returns whether the object has been created by the QML engine or ownership has been explicitly set via QJSEngine::setObjectOwnership(). | |
| bool | signalsBlocked () const noexcept |
Returns true if signals are blocked; otherwise returns false. | |
| bool | blockSignals (bool b) noexcept |
| If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it). | |
| QThread * | thread () const |
| Returns the thread in which the object lives. | |
| bool | moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL) |
Changes the thread affinity for this object and its children and returns true on success. | |
| int | startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer) |
| This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds. | |
| int | startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer) |
| void | killTimer (int id) |
| Kills the timer with timer identifier, id. | |
| void | killTimer (Qt::TimerId id) |
| template<typename T> | |
| T | findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const |
| Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object. | |
| template<typename T> | |
| QList< T > | findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const |
| Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects. | |
| template<typename T> | |
| T | findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
| template<typename T> | |
| QList< T > | findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
| const QObjectList & | children () const |
| Returns a list of child objects. | |
| void | setParent (QObject *parent) |
| Makes the object a child of parent. | |
| void | installEventFilter (QObject *filterObj) |
| Installs an event filter filterObj on this object. | |
| void | removeEventFilter (QObject *obj) |
| Removes an event filter object obj from this object. | |
| QMetaObject::Connection | connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const |
| bool | disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const |
| bool | disconnect (const QObject *receiver, const char *member=nullptr) const |
| void | dumpObjectTree () const |
| Dumps a tree of children to the debug output. | |
| void | dumpObjectInfo () const |
| Dumps information about signal connections, etc. | |
| bool | setProperty (const char *name, const QVariant &value) |
| Sets the value of the object's name property to value. | |
| bool | setProperty (const char *name, QVariant &&value) |
| QVariant | property (const char *name) const |
| Returns the value of the object's name property. | |
| QList< QByteArray > | dynamicPropertyNames () const |
| QBindingStorage * | bindingStorage () |
| const QBindingStorage * | bindingStorage () const |
| QObject * | parent () const |
| Returns a pointer to the parent object. | |
| bool | inherits (const char *classname) const |
Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false. | |
Additional Inherited Members | |
| Signals inherited from QObject | |
| void | destroyed (QObject *=nullptr) |
| This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked. | |
| void | objectNameChanged (const QString &objectName, QPrivateSignal) |
| This signal is emitted after the object's name has been changed. | |
| Protected Member Functions inherited from QObject | |
| QObject * | sender () const |
| Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr. | |
| int | senderSignalIndex () const |
| int | receivers (const char *signal) const |
| Returns the number of receivers connected to the signal. | |
| bool | isSignalConnected (const QMetaMethod &signal) const |
| virtual void | timerEvent (QTimerEvent *event) |
| This event handler can be reimplemented in a subclass to receive timer events for the object. | |
| virtual void | childEvent (QChildEvent *event) |
| This event handler can be reimplemented in a subclass to receive child events. | |
| virtual void | customEvent (QEvent *event) |
| This event handler can be reimplemented in a subclass to receive custom events. | |
| virtual void | connectNotify (const QMetaMethod &signal) |
| virtual void | disconnectNotify (const QMetaMethod &signal) |
| QObject (QObjectPrivate &dd, QObject *parent=nullptr) | |
| Protected Attributes inherited from QObject | |
| QScopedPointer< QObjectData > | d_ptr |
| Properties inherited from QObject | |
| QString | objectName |
| the name of this object | |
| Related Symbols inherited from QObject | |
| template< class T > T | qobject_cast (const QObject *object) |
| Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr. | |
| template< typename T > T | qFindChildqFindChildren (const QObject *obj, const QString &name)() |
| template< typename T > QList< T > | qFindChildrenqFindChildren (const QObject *obj, const QString &name)() |
| QObjectList | |
| \macro Q_CLASSINFO(Name, Value) | |
Definition at line 19 of file qandroidinputcontext.h.
| enum QAndroidInputContext::EditContext : uint32_t |
| Enumerator | |
|---|---|
| CutButton | |
| CopyButton | |
| PasteButton | |
| SelectAllButton | |
| AllButtons | |
Definition at line 30 of file qandroidinputcontext.h.
| Enumerator | |
|---|---|
| Hidden | |
| ShowCursor | |
| ShowSelection | |
| ShowEditPopup | |
Definition at line 38 of file qandroidinputcontext.h.
| QAndroidInputContext::QAndroidInputContext | ( | ) |
Definition at line 398 of file qandroidinputcontext.cpp.
References QAndroidInputContext(), m_androidInputContext, m_classConstructorMethodID, m_extractedTextClass, m_partialEndOffsetFieldID, m_partialStartOffsetFieldID, m_selectionEndFieldID, m_selectionStartFieldID, m_startOffsetFieldID, m_textFieldID, methods, QtExtractedTextClassName, QtNativeInputConnectionClassName, and updateSelectionHandles().
Referenced by QAndroidInputContext().
| QAndroidInputContext::~QAndroidInputContext | ( | ) |
Definition at line 498 of file qandroidinputcontext.cpp.
References m_androidInputContext, m_extractedTextClass, m_partialEndOffsetFieldID, m_partialStartOffsetFieldID, m_selectionEndFieldID, m_selectionStartFieldID, m_startOffsetFieldID, and m_textFieldID.
|
static |
Definition at line 510 of file qandroidinputcontext.cpp.
References m_androidInputContext.
Referenced by QtAndroidInput::handleLocationChanged(), QtAndroidInput::keyboardGeometryChanged(), QtAndroidInput::keyboardVisibilityChanged(), QtAndroidInput::longPress(), and QtAndroidInput::touchAdd().
| jboolean QAndroidInputContext::beginBatchEdit | ( | ) |
Definition at line 1034 of file qandroidinputcontext.cpp.
| void QAndroidInputContext::clear | ( | ) |
Definition at line 1010 of file qandroidinputcontext.cpp.
Referenced by finishComposingText(), reset(), and setComposingText().
|
overridevirtual |
Reimplemented from QPlatformInputContext.
Definition at line 545 of file qandroidinputcontext.cpp.
| jboolean QAndroidInputContext::commitText | ( | const QString & | text, |
| jint | newCursorPosition ) |
Definition at line 1053 of file qandroidinputcontext.cpp.
| jboolean QAndroidInputContext::copy | ( | ) |
Definition at line 1722 of file qandroidinputcontext.cpp.
| jboolean QAndroidInputContext::copyURL | ( | ) |
Definition at line 1732 of file qandroidinputcontext.cpp.
| jboolean QAndroidInputContext::cut | ( | ) |
Definition at line 1709 of file qandroidinputcontext.cpp.
| jboolean QAndroidInputContext::deleteSurroundingText | ( | jint | leftLength, |
| jint | rightLength ) |
Definition at line 1059 of file qandroidinputcontext.cpp.
| jboolean QAndroidInputContext::endBatchEdit | ( | ) |
Definition at line 1040 of file qandroidinputcontext.cpp.
References updateCursorPosition().
| jboolean QAndroidInputContext::finishComposingText | ( | ) |
Definition at line 1176 of file qandroidinputcontext.cpp.
References clear().
| QObject * QAndroidInputContext::focusObject | ( | ) |
Definition at line 1019 of file qandroidinputcontext.cpp.
| jboolean QAndroidInputContext::fullscreenMode | ( | ) |
Definition at line 1216 of file qandroidinputcontext.cpp.
| jint QAndroidInputContext::getCursorCapsMode | ( | jint | reqModes | ) |
Definition at line 1295 of file qandroidinputcontext.cpp.
| const QAndroidInputContext::ExtractedText & QAndroidInputContext::getExtractedText | ( | jint | hintMaxChars, |
| jint | hintMaxLines, | ||
| jint | flags ) |
Definition at line 1331 of file qandroidinputcontext.cpp.
| QString QAndroidInputContext::getSelectedText | ( | jint | flags | ) |
Definition at line 1387 of file qandroidinputcontext.cpp.
| QString QAndroidInputContext::getTextAfterCursor | ( | jint | length, |
| jint | flags ) |
Definition at line 1396 of file qandroidinputcontext.cpp.
| QString QAndroidInputContext::getTextBeforeCursor | ( | jint | length, |
| jint | flags ) |
Definition at line 1436 of file qandroidinputcontext.cpp.
|
slot |
Definition at line 715 of file qandroidinputcontext.cpp.
|
overridevirtual |
Request to hide input panel.
Reimplemented from QPlatformInputContext.
Definition at line 995 of file qandroidinputcontext.cpp.
References QtAndroidInput::hideSoftwareKeyboard().
|
slot |
Definition at line 914 of file qandroidinputcontext.cpp.
References updateSelectionHandles().
|
overridevirtual |
Called when the word currently being composed in the input item is tapped by the user.
Input methods often use this information to offer more word suggestions to the user.
Reimplemented from QPlatformInputContext.
Definition at line 932 of file qandroidinputcontext.cpp.
|
overridevirtual |
This function can be reimplemented to return true whenever input method is animating shown or hidden.
Default implementation returns false.
Reimplemented from QPlatformInputContext.
Definition at line 947 of file qandroidinputcontext.cpp.
| bool QAndroidInputContext::isComposing | ( | ) | const |
Definition at line 1005 of file qandroidinputcontext.cpp.
|
overridevirtual |
Returns input panel visibility status.
Default implementation returns false.
Reimplemented from QPlatformInputContext.
Definition at line 1000 of file qandroidinputcontext.cpp.
References QtAndroidInput::isSoftwareKeyboardVisible().
|
inlineoverridevirtual |
Returns input context validity.
Deriving implementations should return true.
Reimplemented from QPlatformInputContext.
Definition at line 68 of file qandroidinputcontext.h.
|
overridevirtual |
This function can be reimplemented to return virtual keyboard rectangle in currently active window coordinates.
Default implementation returns invalid rectangle.
Reimplemented from QPlatformInputContext.
Definition at line 942 of file qandroidinputcontext.cpp.
|
slot |
Definition at line 905 of file qandroidinputcontext.cpp.
References updateSelectionHandles().
Referenced by setComposingText().
|
slot |
Definition at line 859 of file qandroidinputcontext.cpp.
References updateSelectionHandles().
| jboolean QAndroidInputContext::paste | ( | ) |
Definition at line 1738 of file qandroidinputcontext.cpp.
| jboolean QAndroidInputContext::replaceText | ( | jint | start, |
| jint | end, | ||
| const QString | text, | ||
| jint | newCursorPosition ) |
Definition at line 1192 of file qandroidinputcontext.cpp.
| void QAndroidInputContext::reportFullscreenMode | ( | jboolean | enabled | ) |
Definition at line 1202 of file qandroidinputcontext.cpp.
References updateSelectionHandles().
|
overridevirtual |
Method to be called when input method needs to be reset.
Called by QInputMethod::reset(). No further QInputMethodEvents should be sent as response.
Reimplemented from QPlatformInputContext.
Definition at line 529 of file qandroidinputcontext.cpp.
References clear(), QtAndroidInput::hideSoftwareKeyboard(), and QtAndroidInput::resetSoftwareKeyboard().
Referenced by setFocusObject().
|
slot |
Definition at line 987 of file qandroidinputcontext.cpp.
| jboolean QAndroidInputContext::selectAll | ( | ) |
Definition at line 1699 of file qandroidinputcontext.cpp.
| void QAndroidInputContext::sendShortcut | ( | const QKeySequence & | sequence | ) |
Definition at line 1750 of file qandroidinputcontext.cpp.
| jboolean QAndroidInputContext::setComposingRegion | ( | jint | start, |
| jint | end ) |
Definition at line 1598 of file qandroidinputcontext.cpp.
| jboolean QAndroidInputContext::setComposingText | ( | const QString & | text, |
| jint | newCursorPosition ) |
Definition at line 1487 of file qandroidinputcontext.cpp.
References clear(), and keyDown().
This virtual method gets called to notify updated focus to object.
Reimplemented from QPlatformInputContext.
Definition at line 1024 of file qandroidinputcontext.cpp.
References reset(), and updateSelectionHandles().
| jboolean QAndroidInputContext::setSelection | ( | jint | start, |
| jint | end ) |
Definition at line 1655 of file qandroidinputcontext.cpp.
|
overridevirtual |
Request to show input panel.
Reimplemented from QPlatformInputContext.
Definition at line 952 of file qandroidinputcontext.cpp.
References QtAndroidInput::showSoftwareKeyboard().
|
slot |
Definition at line 830 of file qandroidinputcontext.cpp.
References updateSelectionHandles().
|
overridevirtual |
Notification on editor updates.
Called by QInputMethod::update().
Reimplemented from QPlatformInputContext.
Definition at line 924 of file qandroidinputcontext.cpp.
|
slot |
Definition at line 550 of file qandroidinputcontext.cpp.
References QtAndroidInput::updateSelection().
Referenced by endBatchEdit(), and updateCursorPosition().
|
slot |
Definition at line 604 of file qandroidinputcontext.cpp.
References AllButtons, QtAndroid::androidPlatformIntegration(), CopyButton, QtAndroidInput::getSelectHandleWidth(), Hidden, m_selectHandleWidth, PasteButton, QAndroidPlatformIntegration::screen(), and SelectAllButton.
Referenced by QAndroidInputContext(), hideSelectionHandles(), keyDown(), longPress(), reportFullscreenMode(), setFocusObject(), and touchDown().