Kirigami::Platform::InputMethod
#include <inputmethod.h>
Properties | |
bool | active |
bool | available |
bool | enabled |
bool | visible |
bool | willShowOnActive |
Properties inherited from QObject | |
objectName | |
Public Member Functions | |
InputMethod (QObject *parent=nullptr) | |
bool | active () const |
Q_SIGNAL void | activeChanged () |
bool | available () const |
Q_SIGNAL void | availableChanged () |
bool | enabled () const |
Q_SIGNAL void | enabledChanged () |
bool | visible () const |
Q_SIGNAL void | visibleChanged () |
bool | willShowOnActive () const |
Q_SIGNAL void | willShowOnActiveChanged () |
Public Member Functions inherited from QObject | |
QObject (QObject *parent) | |
QBindable< QString > | bindableObjectName () |
bool | blockSignals (bool block) |
const QObjectList & | children () const const |
QMetaObject::Connection | connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const |
void | deleteLater () |
void | destroyed (QObject *obj) |
bool | disconnect (const char *signal, const QObject *receiver, const char *method) const const |
bool | disconnect (const QObject *receiver, const char *method) const const |
void | dumpObjectInfo () const const |
void | dumpObjectTree () const const |
QList< QByteArray > | dynamicPropertyNames () const const |
virtual bool | event (QEvent *e) |
virtual bool | eventFilter (QObject *watched, QEvent *event) |
T | findChild (const QString &name, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QString &name, Qt::FindChildOptions options) const const |
QList< T > | findChildren (Qt::FindChildOptions options) const const |
bool | inherits (const char *className) const const |
void | installEventFilter (QObject *filterObj) |
bool | isQuickItemType () const const |
bool | isWidgetType () const const |
bool | isWindowType () const const |
void | killTimer (int id) |
virtual const QMetaObject * | metaObject () const const |
void | moveToThread (QThread *targetThread) |
QString | objectName () const const |
void | objectNameChanged (const QString &objectName) |
QObject * | parent () const const |
QVariant | property (const char *name) const const |
Q_CLASSINFO (Name, Value) | |
Q_EMIT Q_EMIT | |
Q_ENUM (...) | |
Q_ENUM_NS (...) | |
Q_ENUMS (...) | |
Q_FLAG (...) | |
Q_FLAG_NS (...) | |
Q_FLAGS (...) | |
Q_GADGET Q_GADGET | |
Q_GADGET_EXPORT (EXPORT_MACRO) | |
Q_INTERFACES (...) | |
Q_INVOKABLE Q_INVOKABLE | |
Q_MOC_INCLUDE Q_MOC_INCLUDE | |
Q_NAMESPACE Q_NAMESPACE | |
Q_NAMESPACE_EXPORT (EXPORT_MACRO) | |
Q_OBJECT Q_OBJECT | |
Q_PROPERTY (...) | |
Q_REVISION Q_REVISION | |
Q_SET_OBJECT_NAME (Object) | |
Q_SIGNAL Q_SIGNAL | |
Q_SIGNALS Q_SIGNALS | |
Q_SLOT Q_SLOT | |
Q_SLOTS Q_SLOTS | |
T | qobject_cast (const QObject *object) |
T | qobject_cast (QObject *object) |
QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT | |
void | removeEventFilter (QObject *obj) |
void | setObjectName (const QString &name) |
void | setObjectName (QAnyStringView name) |
void | setParent (QObject *parent) |
bool | setProperty (const char *name, const QVariant &value) |
bool | setProperty (const char *name, QVariant &&value) |
bool | signalsBlocked () const const |
int | startTimer (int interval, Qt::TimerType timerType) |
int | startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType) |
QThread * | thread () const const |
Additional Inherited Members | |
Public Types inherited from QObject | |
typedef | QObjectList |
Static Public Member Functions inherited from QObject | |
QMetaObject::Connection | connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, PointerToMemberFunction signal, Functor functor) |
bool | disconnect (const QMetaObject::Connection &connection) |
bool | disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method) |
bool | disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method) |
bool | disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method) |
QString | tr (const char *sourceText, const char *disambiguation, int n) |
Protected Member Functions inherited from QObject | |
virtual void | childEvent (QChildEvent *event) |
virtual void | connectNotify (const QMetaMethod &signal) |
virtual void | customEvent (QEvent *event) |
virtual void | disconnectNotify (const QMetaMethod &signal) |
bool | isSignalConnected (const QMetaMethod &signal) const const |
int | receivers (const char *signal) const const |
QObject * | sender () const const |
int | senderSignalIndex () const const |
virtual void | timerEvent (QTimerEvent *event) |
Detailed Description
This exposes information about the current used input method.
Definition at line 25 of file inputmethod.h.
Property Documentation
◆ active
|
read |
Is the current input method active?
What active means depends on the type of input method. In case of a virtual keyboard for example, it would mean the virtual keyboard is visible.
Definition at line 62 of file inputmethod.h.
◆ available
|
read |
Is an input method available?
This will be true if there is an input method available. When it is false it means there's no special input method configured and input happens directly through keyboard events.
Definition at line 42 of file inputmethod.h.
◆ enabled
|
read |
Is the current input method enabled?
If this is false, that means the input method is available but not in use.
Definition at line 51 of file inputmethod.h.
◆ visible
|
read |
Is the current input method visible?
For some input methods this will match active however for others this may differ.
Definition at line 72 of file inputmethod.h.
◆ willShowOnActive
|
read |
Will the input method be shown when a text input field gains focus?
This is intended to be used to decide whether to give an input field default focus. For certain input methods, like virtual keyboards, it may not be desirable to show it by default. For example, having a search field focused on application startup may cause the virtual keyboard to show, greatly reducing the available application space.
Definition at line 85 of file inputmethod.h.
Constructor & Destructor Documentation
◆ InputMethod()
Kirigami::Platform::InputMethod::InputMethod | ( | QObject * | parent = nullptr | ) |
Definition at line 25 of file inputmethod.cpp.
Member Function Documentation
◆ active()
bool Kirigami::Platform::InputMethod::active | ( | ) | const |
Definition at line 73 of file inputmethod.cpp.
◆ available()
bool Kirigami::Platform::InputMethod::available | ( | ) | const |
Definition at line 63 of file inputmethod.cpp.
◆ enabled()
bool Kirigami::Platform::InputMethod::enabled | ( | ) | const |
Definition at line 68 of file inputmethod.cpp.
◆ visible()
bool Kirigami::Platform::InputMethod::visible | ( | ) | const |
Definition at line 78 of file inputmethod.cpp.
◆ willShowOnActive()
bool Kirigami::Platform::InputMethod::willShowOnActive | ( | ) | const |
Definition at line 83 of file inputmethod.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Sat Dec 21 2024 16:56:52 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.