Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
Public Types | Signals | Public Member Functions | List of all members
QInputDeviceManager Class Reference

QInputDeviceManager acts as a communication hub between QtGui and the input handlers. More...

#include <qinputdevicemanager_p.h>

+ Inheritance diagram for QInputDeviceManager:
+ Collaboration diagram for QInputDeviceManager:

Public Types

enum  DeviceType {
  DeviceTypeUnknown , DeviceTypePointer , DeviceTypeKeyboard , DeviceTypeTouch ,
  DeviceTypeTablet , NumDeviceTypes
}
 

Signals

void deviceListChanged (QInputDeviceManager::DeviceType type)
 
void cursorPositionChangeRequested (const QPoint &pos)
 
- 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

 QInputDeviceManager (QObject *parent=nullptr)
 
 ~QInputDeviceManager () override
 
int deviceCount (DeviceType type) const
 
void setCursorPos (const QPoint &pos)
 
Qt::KeyboardModifiers keyboardModifiers () const
 
void setKeyboardModifiers (Qt::KeyboardModifiers mods)
 
- 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 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

- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 
- 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
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
 Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
 
 
 
 \macro Q_CLASSINFO(Name, Value)
 

Detailed Description

QInputDeviceManager acts as a communication hub between QtGui and the input handlers.

On embedded platforms the input handling code is either compiled into the platform plugin or is loaded dynamically as a generic plugin without any interface. The input handler in use may also change between each run (e.g. evdevmouse/keyboard/touch vs. libinput). QWindowSystemInterface is too limiting when Qt (the platform plugin) is acting as a windowing system, and is one way only.

QInputDeviceManager solves this by providing a global object that is used to communicate from the input handlers to the rest of Qt (e.g. the number of connected mice, which may be important information for the cursor drawing code), and vice-versa (e.g. to indicate to the input handler that a manual cursor position change was requested by the application via QCursor::setPos and thus any internal state has to be updated accordingly).

Definition at line 25 of file qinputdevicemanager_p.h.

Member Enumeration Documentation

◆ DeviceType

enum QInputDeviceManager::DeviceType
Enumerator
DeviceTypeUnknown 
DeviceTypePointer 
DeviceTypeKeyboard 
DeviceTypeTouch 
DeviceTypeTablet 
NumDeviceTypes 

Definition at line 31 of file qinputdevicemanager_p.h.

Constructor & Destructor Documentation

◆ QInputDeviceManager()

QInputDeviceManager::QInputDeviceManager ( QObject * parent = nullptr)
explicit

Definition at line 30 of file qinputdevicemanager.cpp.

◆ ~QInputDeviceManager()

QInputDeviceManager::~QInputDeviceManager ( )
overridedefault

Member Function Documentation

◆ cursorPositionChangeRequested

void QInputDeviceManager::cursorPositionChangeRequested ( const QPoint & pos)
signal

Referenced by QEvdevMouseManager::QEvdevMouseManager(), QLibInputHandler::QLibInputHandler(), and setCursorPos().

+ Here is the caller graph for this function:

◆ deviceCount()

int QInputDeviceManager::deviceCount ( DeviceType type) const

Definition at line 38 of file qinputdevicemanager.cpp.

References d.

◆ deviceListChanged

void QInputDeviceManager::deviceListChanged ( QInputDeviceManager::DeviceType type)
signal

Referenced by QEglFSKmsGbmCursor::QEglFSKmsGbmCursor(), and QFbCursor::QFbCursor().

+ Here is the caller graph for this function:

◆ keyboardModifiers()

Qt::KeyboardModifiers QInputDeviceManager::keyboardModifiers ( ) const
Returns
the keyboard modifier state stored in the QInputDeviceManager object.

Keyboard input handlers are expected to keep this up-to-date via setKeyboardModifiers().

Querying the state via this function (e.g. from a mouse handler that needs to include the modifier state in mouse events) is the preferred alternative over QGuiApplication::keyboardModifiers() since the latter may not report the current state due to asynchronous QPA event processing.

Definition at line 74 of file qinputdevicemanager.cpp.

References d.

◆ setCursorPos()

void QInputDeviceManager::setCursorPos ( const QPoint & pos)

Definition at line 58 of file qinputdevicemanager.cpp.

References cursorPositionChangeRequested(), emit, and pos.

+ Here is the call graph for this function:

◆ setKeyboardModifiers()

void QInputDeviceManager::setKeyboardModifiers ( Qt::KeyboardModifiers mods)

Definition at line 80 of file qinputdevicemanager.cpp.

References d.

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