Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QAndroidInputContext Class Reference

#include <qandroidinputcontext.h>

Inheritance diagram for QAndroidInputContext:
Collaboration diagram for QAndroidInputContext:

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.
QObjectfocusObject ()
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 ExtractedTextgetExtractedText (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< QStringbindableObjectName ()
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 isQmlObjectType () const
 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).
QThreadthread () 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>
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>
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 QObjectListchildren () 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< QByteArraydynamicPropertyNames () const
QBindingStoragebindingStorage ()
const QBindingStoragebindingStorage () const
QObjectparent () 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.

Static Public Member Functions

static QAndroidInputContextandroidInputContext ()
Static Public Member Functions inherited from QPlatformInputContext
static void setSelectionOnFocusObject (const QPointF &anchorPos, const QPointF &cursorPos)
 QPlatformInputContext::setSelectionOnFocusObject.
static QVariant queryFocusObject (Qt::InputMethodQuery query, QPointF position)
 QPlatformInputContext::queryFocusObject.
static QRectF inputItemRectangle ()
 QPlatformInputContext::inputItemRectangle.
static QRectF inputItemClipRectangle ()
 QPlatformInputContext::inputItemClipRectangle.
static QRectF cursorRectangle ()
 QPlatformInputContext::cursorRectangle.
static QRectF anchorRectangle ()
 QPlatformInputContext::anchorRectangle.
static QRectF keyboardRectangle ()
 QPlatformInputContext::keyboardRectangle.
Static Public Member Functions inherited from QObject
static QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 \threadsafe
static QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 \threadsafe
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
static bool disconnect (const QMetaObject::Connection &)
 Disconnect a connection.
template<typename Func1, typename Func2>
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot)
template<typename Func1>
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero)

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
QObjectsender () 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< QObjectDatad_ptr
Properties inherited from QObject
QString objectName
 the name of this object

Detailed Description

Definition at line 18 of file qandroidinputcontext.h.

Member Enumeration Documentation

◆ EditContext

Enumerator
CutButton 
CopyButton 
PasteButton 
SelectAllButton 
AllButtons 

Definition at line 29 of file qandroidinputcontext.h.

◆ HandleMode

Enumerator
Hidden 
ShowCursor 
ShowSelection 
ShowEditPopup 

Definition at line 37 of file qandroidinputcontext.h.

Constructor & Destructor Documentation

◆ QAndroidInputContext()

QAndroidInputContext::QAndroidInputContext ( )

Definition at line 400 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, and QtNativeInputConnectionClassName.

Referenced by QAndroidInputContext().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ~QAndroidInputContext()

Member Function Documentation

◆ androidInputContext()

QAndroidInputContext * QAndroidInputContext::androidInputContext ( )
static

Definition at line 512 of file qandroidinputcontext.cpp.

References m_androidInputContext.

Referenced by QtAndroidInput::handleLocationChanged(), QtAndroidInput::keyboardGeometryChanged(), QtAndroidInput::keyboardVisibilityChanged(), QtAndroidInput::longPress(), and QtAndroidInput::touchAdd().

Here is the caller graph for this function:

◆ beginBatchEdit()

jboolean QAndroidInputContext::beginBatchEdit ( )

Definition at line 1019 of file qandroidinputcontext.cpp.

◆ clear()

void QAndroidInputContext::clear ( )

Definition at line 995 of file qandroidinputcontext.cpp.

Referenced by finishComposingText(), reset(), and setComposingText().

Here is the caller graph for this function:

◆ commit()

void QAndroidInputContext::commit ( )
overridevirtual

Reimplemented from QPlatformInputContext.

Definition at line 547 of file qandroidinputcontext.cpp.

◆ commitText()

jboolean QAndroidInputContext::commitText ( const QString & text,
jint newCursorPosition )

Definition at line 1038 of file qandroidinputcontext.cpp.

◆ copy()

jboolean QAndroidInputContext::copy ( )

Definition at line 1707 of file qandroidinputcontext.cpp.

◆ copyURL()

jboolean QAndroidInputContext::copyURL ( )

Definition at line 1717 of file qandroidinputcontext.cpp.

◆ cut()

jboolean QAndroidInputContext::cut ( )

Definition at line 1694 of file qandroidinputcontext.cpp.

◆ deleteSurroundingText()

jboolean QAndroidInputContext::deleteSurroundingText ( jint leftLength,
jint rightLength )

Definition at line 1044 of file qandroidinputcontext.cpp.

◆ endBatchEdit()

jboolean QAndroidInputContext::endBatchEdit ( )

Definition at line 1025 of file qandroidinputcontext.cpp.

References updateCursorPosition().

Here is the call graph for this function:

◆ finishComposingText()

jboolean QAndroidInputContext::finishComposingText ( )

Definition at line 1161 of file qandroidinputcontext.cpp.

References clear().

Here is the call graph for this function:

◆ focusObject()

QObject * QAndroidInputContext::focusObject ( )

Definition at line 1004 of file qandroidinputcontext.cpp.

◆ fullscreenMode()

jboolean QAndroidInputContext::fullscreenMode ( )

Definition at line 1201 of file qandroidinputcontext.cpp.

◆ getCursorCapsMode()

jint QAndroidInputContext::getCursorCapsMode ( jint reqModes)

Definition at line 1280 of file qandroidinputcontext.cpp.

◆ getExtractedText()

const QAndroidInputContext::ExtractedText & QAndroidInputContext::getExtractedText ( jint hintMaxChars,
jint hintMaxLines,
jint flags )

Definition at line 1316 of file qandroidinputcontext.cpp.

◆ getSelectedText()

QString QAndroidInputContext::getSelectedText ( jint flags)

Definition at line 1372 of file qandroidinputcontext.cpp.

◆ getTextAfterCursor()

QString QAndroidInputContext::getTextAfterCursor ( jint length,
jint flags )

Definition at line 1381 of file qandroidinputcontext.cpp.

◆ getTextBeforeCursor()

QString QAndroidInputContext::getTextBeforeCursor ( jint length,
jint flags )

Definition at line 1421 of file qandroidinputcontext.cpp.

◆ handleLocationChanged

void QAndroidInputContext::handleLocationChanged ( int handleId,
int x,
int y )
slot

Definition at line 700 of file qandroidinputcontext.cpp.

◆ hideInputPanel()

void QAndroidInputContext::hideInputPanel ( )
overridevirtual

Request to hide input panel.

Reimplemented from QPlatformInputContext.

Definition at line 980 of file qandroidinputcontext.cpp.

References QtAndroidInput::hideSoftwareKeyboard().

Here is the call graph for this function:

◆ hideSelectionHandles

void QAndroidInputContext::hideSelectionHandles ( )
slot

Definition at line 899 of file qandroidinputcontext.cpp.

References updateSelectionHandles().

Here is the call graph for this function:

◆ invokeAction()

void QAndroidInputContext::invokeAction ( QInputMethod::Action action,
int cursorPosition )
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 917 of file qandroidinputcontext.cpp.

◆ isAnimating()

bool QAndroidInputContext::isAnimating ( ) const
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 932 of file qandroidinputcontext.cpp.

◆ isComposing()

bool QAndroidInputContext::isComposing ( ) const

Definition at line 990 of file qandroidinputcontext.cpp.

◆ isInputPanelVisible()

bool QAndroidInputContext::isInputPanelVisible ( ) const
overridevirtual

Returns input panel visibility status.

Default implementation returns false.

Reimplemented from QPlatformInputContext.

Definition at line 985 of file qandroidinputcontext.cpp.

References QtAndroidInput::isSoftwareKeyboardVisible().

Referenced by hasValidFocusObject().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ isValid()

bool QAndroidInputContext::isValid ( ) const
inlineoverridevirtual

Returns input context validity.

Deriving implementations should return true.

Reimplemented from QPlatformInputContext.

Definition at line 67 of file qandroidinputcontext.h.

◆ keyboardRect()

QRectF QAndroidInputContext::keyboardRect ( ) const
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 927 of file qandroidinputcontext.cpp.

◆ keyDown

void QAndroidInputContext::keyDown ( )
slot

Definition at line 890 of file qandroidinputcontext.cpp.

References updateSelectionHandles().

Referenced by setComposingText().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ longPress

void QAndroidInputContext::longPress ( int x,
int y )
slot

Definition at line 844 of file qandroidinputcontext.cpp.

References updateSelectionHandles().

Here is the call graph for this function:

◆ paste()

jboolean QAndroidInputContext::paste ( )

Definition at line 1723 of file qandroidinputcontext.cpp.

◆ replaceText()

jboolean QAndroidInputContext::replaceText ( jint start,
jint end,
const QString text,
jint newCursorPosition )

Definition at line 1177 of file qandroidinputcontext.cpp.

◆ reportFullscreenMode()

void QAndroidInputContext::reportFullscreenMode ( jboolean enabled)

Definition at line 1187 of file qandroidinputcontext.cpp.

References updateSelectionHandles().

Here is the call graph for this function:

◆ reset()

void QAndroidInputContext::reset ( )
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 531 of file qandroidinputcontext.cpp.

References clear(), QtAndroidInput::hideSoftwareKeyboard(), and QtAndroidInput::resetSoftwareKeyboard().

Referenced by setFocusObject().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ safeCall

void QAndroidInputContext::safeCall ( const std::function< void()> & func,
Qt::ConnectionType conType = Qt::BlockingQueuedConnection )
slot

Definition at line 972 of file qandroidinputcontext.cpp.

◆ selectAll()

jboolean QAndroidInputContext::selectAll ( )

Definition at line 1684 of file qandroidinputcontext.cpp.

◆ sendShortcut()

void QAndroidInputContext::sendShortcut ( const QKeySequence & sequence)

Definition at line 1735 of file qandroidinputcontext.cpp.

◆ setComposingRegion()

jboolean QAndroidInputContext::setComposingRegion ( jint start,
jint end )

Definition at line 1583 of file qandroidinputcontext.cpp.

◆ setComposingText()

jboolean QAndroidInputContext::setComposingText ( const QString & text,
jint newCursorPosition )

Definition at line 1472 of file qandroidinputcontext.cpp.

References clear(), and keyDown().

Here is the call graph for this function:

◆ setFocusObject()

void QAndroidInputContext::setFocusObject ( QObject * object)
overridevirtual

This virtual method gets called to notify updated focus to object.

Warning
Input methods must not call this function directly.

Reimplemented from QPlatformInputContext.

Definition at line 1009 of file qandroidinputcontext.cpp.

References reset(), and updateSelectionHandles().

Here is the call graph for this function:

◆ setSelection()

jboolean QAndroidInputContext::setSelection ( jint start,
jint end )

Definition at line 1640 of file qandroidinputcontext.cpp.

◆ showInputPanel()

void QAndroidInputContext::showInputPanel ( )
overridevirtual

Request to show input panel.

Reimplemented from QPlatformInputContext.

Definition at line 937 of file qandroidinputcontext.cpp.

◆ touchDown

void QAndroidInputContext::touchDown ( int x,
int y )
slot

Definition at line 815 of file qandroidinputcontext.cpp.

References updateSelectionHandles().

Here is the call graph for this function:

◆ update()

void QAndroidInputContext::update ( Qt::InputMethodQueries )
overridevirtual

Notification on editor updates.

Called by QInputMethod::update().

Reimplemented from QPlatformInputContext.

Definition at line 909 of file qandroidinputcontext.cpp.

◆ updateCursorPosition

void QAndroidInputContext::updateCursorPosition ( )
slot

Definition at line 552 of file qandroidinputcontext.cpp.

References QtAndroidInput::updateSelection().

Referenced by endBatchEdit(), and updateCursorPosition().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ updateSelectionHandles

void QAndroidInputContext::updateSelectionHandles ( )
slot

Definition at line 598 of file qandroidinputcontext.cpp.

References AllButtons, QtAndroid::androidPlatformIntegration(), CopyButton, QtAndroidInput::getSelectHandleWidth(), Hidden, m_selectHandleWidth, PasteButton, QAndroidPlatformIntegration::screen(), and SelectAllButton.

Referenced by hideSelectionHandles(), keyDown(), longPress(), reportFullscreenMode(), setFocusObject(), and touchDown().

Here is the call graph for this function:
Here is the caller graph for this function:

The documentation for this class was generated from the following files: