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

#include <qquickinputmethod_p.h>

Inheritance diagram for QQuickInputMethod:
Collaboration diagram for QQuickInputMethod:

Public Slots

void commit ()
void hide ()
void invokeAction (QInputMethod::Action a, int cursorPosition)
void reset ()
void show ()
void update (Qt::InputMethodQueries queries)
Public Slots inherited from QObject
void deleteLater ()
 \threadsafe

Signals

void anchorRectangleChanged ()
void animatingChanged ()
void cursorRectangleChanged ()
void inputDirectionChanged (Qt::LayoutDirection newDirection)
void inputItemClipRectangleChanged ()
void keyboardRectangleChanged ()
void localeChanged ()
void visibleChanged ()
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.

Public Member Functions

 QQuickInputMethod (QObject *parent=nullptr)
 \qmltype InputMethod \inqmlmodule QtQuick
QRectF anchorRectangle () const
QRectF cursorRectangle () const
Qt::LayoutDirection inputDirection () const
QRectF inputItemClipRectangle () const
QRectF inputItemRectangle () const
void setInputItemRectangle (const QRectF &rect)
QTransform inputItemTransform () const
void setInputItemTransform (const QTransform &transform)
bool isAnimating () const
bool isVisible () const
void setVisible (bool visible)
QRectF keyboardRectangle () const
QLocale locale () const
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.

Properties

QML_SINGLETONQRectF cursorRectangle
QRectF anchorRectangle
QRectF keyboardRectangle
QRectF inputItemClipRectangle
bool visible
bool animating
QLocale locale
Qt::LayoutDirection inputDirection
Properties inherited from QObject
QString objectName
 the name of this object

Additional Inherited Members

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

Detailed Description

Definition at line 29 of file qquickinputmethod_p.h.

Constructor & Destructor Documentation

◆ QQuickInputMethod()

QT_BEGIN_NAMESPACE QQuickInputMethod::QQuickInputMethod ( QObject * parent = nullptr)
explicit

\qmltype InputMethod \inqmlmodule QtQuick

Provides access to \l QInputMethod for QML applications.

The InputMethod singleton allows access to application's \l QInputMethod object and all its properties and slots. See the \l QInputMethod documentation for further details.

Definition at line 22 of file qquickinputmethod.cpp.

Member Function Documentation

◆ anchorRectangle()

QRectF QQuickInputMethod::anchorRectangle ( ) const

Definition at line 66 of file qquickinputmethod.cpp.

◆ anchorRectangleChanged

void QQuickInputMethod::anchorRectangleChanged ( )
signal

◆ animatingChanged

void QQuickInputMethod::animatingChanged ( )
signal

◆ commit

void QQuickInputMethod::commit ( )
slot

Definition at line 41 of file qquickinputmethod.cpp.

◆ cursorRectangle()

QRectF QQuickInputMethod::cursorRectangle ( ) const

Definition at line 70 of file qquickinputmethod.cpp.

◆ cursorRectangleChanged

void QQuickInputMethod::cursorRectangleChanged ( )
signal

◆ hide

void QQuickInputMethod::hide ( )
slot

Definition at line 45 of file qquickinputmethod.cpp.

◆ inputDirection()

Qt::LayoutDirection QQuickInputMethod::inputDirection ( ) const

Definition at line 74 of file qquickinputmethod.cpp.

◆ inputDirectionChanged

void QQuickInputMethod::inputDirectionChanged ( Qt::LayoutDirection newDirection)
signal

◆ inputItemClipRectangle()

QRectF QQuickInputMethod::inputItemClipRectangle ( ) const

Definition at line 78 of file qquickinputmethod.cpp.

◆ inputItemClipRectangleChanged

void QQuickInputMethod::inputItemClipRectangleChanged ( )
signal

◆ inputItemRectangle()

QRectF QQuickInputMethod::inputItemRectangle ( ) const

Definition at line 83 of file qquickinputmethod.cpp.

◆ inputItemTransform()

QTransform QQuickInputMethod::inputItemTransform ( ) const

Definition at line 92 of file qquickinputmethod.cpp.

◆ invokeAction

void QQuickInputMethod::invokeAction ( QInputMethod::Action a,
int cursorPosition )
slot

Definition at line 49 of file qquickinputmethod.cpp.

◆ isAnimating()

bool QQuickInputMethod::isAnimating ( ) const

Definition at line 101 of file qquickinputmethod.cpp.

◆ isVisible()

bool QQuickInputMethod::isVisible ( ) const

Definition at line 106 of file qquickinputmethod.cpp.

◆ keyboardRectangle()

QRectF QQuickInputMethod::keyboardRectangle ( ) const

Definition at line 115 of file qquickinputmethod.cpp.

◆ keyboardRectangleChanged

void QQuickInputMethod::keyboardRectangleChanged ( )
signal

◆ locale()

QLocale QQuickInputMethod::locale ( ) const

Definition at line 119 of file qquickinputmethod.cpp.

◆ localeChanged

void QQuickInputMethod::localeChanged ( )
signal

◆ reset

void QQuickInputMethod::reset ( )
slot

Definition at line 53 of file qquickinputmethod.cpp.

◆ setInputItemRectangle()

void QQuickInputMethod::setInputItemRectangle ( const QRectF & rect)

Definition at line 87 of file qquickinputmethod.cpp.

◆ setInputItemTransform()

void QQuickInputMethod::setInputItemTransform ( const QTransform & transform)

Definition at line 96 of file qquickinputmethod.cpp.

◆ setVisible()

void QQuickInputMethod::setVisible ( bool visible)

Definition at line 110 of file qquickinputmethod.cpp.

◆ show

void QQuickInputMethod::show ( )
slot

Definition at line 57 of file qquickinputmethod.cpp.

◆ update

void QQuickInputMethod::update ( Qt::InputMethodQueries queries)
slot

Definition at line 61 of file qquickinputmethod.cpp.

◆ visibleChanged

void QQuickInputMethod::visibleChanged ( )
signal

Property Documentation

◆ anchorRectangle

QRectF QQuickInputMethod::anchorRectangle
read

Definition at line 37 of file qquickinputmethod_p.h.

◆ animating

bool QQuickInputMethod::animating
read

Definition at line 42 of file qquickinputmethod_p.h.

◆ cursorRectangle

QML_SINGLETONQRectF QQuickInputMethod::cursorRectangle
read

Definition at line 36 of file qquickinputmethod_p.h.

◆ inputDirection

Qt::LayoutDirection QQuickInputMethod::inputDirection
read

Definition at line 44 of file qquickinputmethod_p.h.

◆ inputItemClipRectangle

QRectF QQuickInputMethod::inputItemClipRectangle
read

Definition at line 39 of file qquickinputmethod_p.h.

◆ keyboardRectangle

QRectF QQuickInputMethod::keyboardRectangle
read

Definition at line 38 of file qquickinputmethod_p.h.

◆ locale

QLocale QQuickInputMethod::locale
read

Definition at line 43 of file qquickinputmethod_p.h.

◆ visible

bool QQuickInputMethod::visible
read

Definition at line 41 of file qquickinputmethod_p.h.


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