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
QOhosInputContext Class Reference

#include <qohosinputcontext.h>

Inheritance diagram for QOhosInputContext:
Collaboration diagram for QOhosInputContext:

Public Types

enum class  RequestKeyboardReason { NONE , MOUSE , TOUCH , OTHER }
enum class  TextInputType {
  NONE , TEXT , MULTILINE , NUMBER ,
  PHONE , DATETIME , EMAIL_ADDRESS , URL ,
  VISIBLE_PASSWORD , NUMBER_PASSWORD
}
enum class  EnterKeyType {
  UNSPECIFIED , NONE , GO , SEARCH ,
  SEND , NEXT , DONE , PREVIOUS ,
  NEWLINE
}
enum class  Direction { CURSOR_UP , CURSOR_DOWN , CURSOR_LEFT , CURSOR_RIGHT }
Public Types inherited from QPlatformInputContext
enum  Capability { HiddenTextCapability = 0x1 }

Public Member Functions

 QOhosInputContext ()
 ~QOhosInputContext ()
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.
void setFocusObject (QObject *object) override
 This virtual method gets called to notify updated focus to object.
QObjectfocusObjectOrNull () const
void setSoftwareKeyboardVisibilityStatus (bool visible)
void setLastInputTypeToTriggerSoftKeyboard (RequestKeyboardReason inputType)
bool eventFilter (QObject *obj, QEvent *event) override
 Filters events if this object has been installed as an event filter for the watched object.
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.
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 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).
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.

Additional Inherited Members

Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
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.
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 &)
 Disconnects connection and resets it to \l{QMetaObject::Connection::operator bool()}{invalid}.
static bool disconnect (QMetaObject::Connection &)
static bool disconnect (QMetaObject::Connection &&conn)
 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)
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 qohosinputcontext.h.

Member Enumeration Documentation

◆ Direction

enum class QOhosInputContext::Direction
strong
Enumerator
CURSOR_UP 
CURSOR_DOWN 
CURSOR_LEFT 
CURSOR_RIGHT 

Definition at line 55 of file qohosinputcontext.h.

◆ EnterKeyType

Enumerator
UNSPECIFIED 
NONE 
GO 
SEARCH 
SEND 
NEXT 
DONE 
PREVIOUS 
NEWLINE 

Definition at line 43 of file qohosinputcontext.h.

◆ RequestKeyboardReason

Enumerator
NONE 
MOUSE 
TOUCH 
OTHER 

Definition at line 23 of file qohosinputcontext.h.

◆ TextInputType

Enumerator
NONE 
TEXT 
MULTILINE 
NUMBER 
PHONE 
DATETIME 
EMAIL_ADDRESS 
URL 
VISIBLE_PASSWORD 
NUMBER_PASSWORD 

Definition at line 30 of file qohosinputcontext.h.

Constructor & Destructor Documentation

◆ QOhosInputContext()

QOhosInputContext::QOhosInputContext ( )

Definition at line 232 of file qohosinputcontext.cpp.

References QOhosInputContext().

Referenced by QOhosInputContext().

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

◆ ~QOhosInputContext()

QOhosInputContext::~QOhosInputContext ( )
default

Member Function Documentation

◆ commit()

void QOhosInputContext::commit ( )
overridevirtual

Reimplemented from QPlatformInputContext.

Definition at line 261 of file qohosinputcontext.cpp.

◆ eventFilter()

bool QOhosInputContext::eventFilter ( QObject * watched,
QEvent * event )
overridevirtual

Filters events if this object has been installed as an event filter for the watched object.

In your reimplementation of this function, if you want to filter the event out, i.e. stop it being handled further, return true; otherwise return false.

Example:

class MainWindow : public QMainWindow
{
public:
protected:
bool eventFilter(QObject *obj, QEvent *ev) override;
private:
QTextEdit *textEdit;
};
{
textEdit = new QTextEdit;
setCentralWidget(textEdit);
textEdit->installEventFilter(this);
}
{
if (obj == textEdit) {
if (event->type() == QEvent::KeyPress) {
QKeyEvent *keyEvent = static_cast<QKeyEvent*>(event);
qDebug() << "Ate key press" << keyEvent->key();
return true;
} else {
return false;
}
} else {
// pass the event on to the parent class
}
}

Notice in the example above that unhandled events are passed to the base class's eventFilter() function, since the base class might have reimplemented eventFilter() for its own internal purposes.

Some events, such as \l QEvent::ShortcutOverride must be explicitly accepted (by calling \l {QEvent::}{accept()} on them) in order to prevent propagation.

Warning
If you delete the receiver object in this function, be sure to return true. Otherwise, Qt will forward the event to the deleted object and the program might crash.
See also
installEventFilter()

Reimplemented from QObject.

Definition at line 581 of file qohosinputcontext.cpp.

◆ focusObjectOrNull()

QObject * QOhosInputContext::focusObjectOrNull ( ) const

Definition at line 344 of file qohosinputcontext.cpp.

◆ hideInputPanel()

void QOhosInputContext::hideInputPanel ( )
overridevirtual

Request to hide input panel.

Reimplemented from QPlatformInputContext.

Definition at line 327 of file qohosinputcontext.cpp.

Referenced by update().

Here is the caller graph for this function:

◆ invokeAction()

void QOhosInputContext::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 304 of file qohosinputcontext.cpp.

◆ isAnimating()

bool QOhosInputContext::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 315 of file qohosinputcontext.cpp.

◆ isInputPanelVisible()

bool QOhosInputContext::isInputPanelVisible ( ) const
overridevirtual

Returns input panel visibility status.

Default implementation returns false.

Reimplemented from QPlatformInputContext.

Definition at line 333 of file qohosinputcontext.cpp.

◆ isValid()

bool QOhosInputContext::isValid ( ) const
inlineoverridevirtual

Returns input context validity.

Deriving implementations should return true.

Reimplemented from QPlatformInputContext.

Definition at line 64 of file qohosinputcontext.h.

◆ keyboardRect()

QRectF QOhosInputContext::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 309 of file qohosinputcontext.cpp.

◆ reset()

void QOhosInputContext::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 253 of file qohosinputcontext.cpp.

◆ setFocusObject()

void QOhosInputContext::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 339 of file qohosinputcontext.cpp.

◆ setLastInputTypeToTriggerSoftKeyboard()

void QOhosInputContext::setLastInputTypeToTriggerSoftKeyboard ( RequestKeyboardReason inputType)

Definition at line 500 of file qohosinputcontext.cpp.

◆ setSoftwareKeyboardVisibilityStatus()

void QOhosInputContext::setSoftwareKeyboardVisibilityStatus ( bool visible)

Definition at line 495 of file qohosinputcontext.cpp.

◆ showInputPanel()

void QOhosInputContext::showInputPanel ( )
overridevirtual

Request to show input panel.

Reimplemented from QPlatformInputContext.

Definition at line 321 of file qohosinputcontext.cpp.

Referenced by update().

Here is the caller graph for this function:

◆ update()

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

Notification on editor updates.

Called by QInputMethod::update().

Reimplemented from QPlatformInputContext.

Definition at line 272 of file qohosinputcontext.cpp.

References hideInputPanel(), and showInputPanel().

Here is the call graph for this function:

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