The QInputDevice class describes a device from which a QInputEvent originates. More...

#include <qinputdevice.h>

Inheritance diagram for QInputDevice:

Collaboration diagram for QInputDevice:

Public Types
enum class	DeviceType { Unknown = 0x0000 , Mouse = 0x0001 , TouchScreen = 0x0002 , TouchPad = 0x0004 , Puck = 0x0008 , Stylus = 0x0010 , Airbrush = 0x0020 , Keyboard = 0x1000 , AllDevices = 0x7FFFFFFF }

enum class	Capability { None = 0 , Position = 0x0001 , Area = 0x0002 , Pressure = 0x0004 , Velocity = 0x0008 , NormalizedPosition = 0x0020 , MouseEmulation = 0x0040 , PixelScroll = 0x0080 , Scroll = 0x0100 , Hover = 0x0200 , Rotation = 0x0400 , XTilt = 0x0800 , YTilt = 0x1000 , TangentialPressure = 0x2000 , ZPosition = 0x4000 , All = 0x7FFFFFFF }

Signals
void	availableVirtualGeometryChanged (QRect area)

Signals inherited from QObject
void	destroyed (QObject *=nullptr)

void	objectNameChanged (const QString &objectName, QPrivateSignal)

Public Member Functions
	QInputDevice (QObject *parent=nullptr)

	~QInputDevice ()

	QInputDevice (const QString &name, qint64 systemId, DeviceType type, const QString &seatName=QString(), QObject *parent=nullptr)

QString	name () const

DeviceType	type () const

Capabilities	capabilities () const

bool	hasCapability (Capability cap) const

qint64	systemId () const

QString	seatName () const

QRect	availableVirtualGeometry () const

bool	operator== (const QInputDevice &other) const

Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)

virtual	~QObject ()

virtual bool	event (QEvent *event)

virtual bool	eventFilter (QObject watched, QEvent event)

QString	objectName () const

void	setObjectName (const QString &name)

QBindable< QString >	bindableObjectName ()

bool	isWidgetType () const

bool	isWindowType () const

bool	signalsBlocked () const noexcept

bool	blockSignals (bool b) noexcept

QThread *	thread () const

void	moveToThread (QThread *thread)

int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)

template<typename T >
T	findChild (const QString &aName=QString(), Qt::FindChildOptions options=Qt::FindChildrenRecursively) const

template<typename T >
QList< T >	findChildren (const QString &aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const

template<typename T >
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const

const QObjectList &	children () const

void	setParent (QObject *parent)

void	installEventFilter (QObject *filterObj)

void	removeEventFilter (QObject *obj)

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

void	dumpObjectInfo () const

bool	setProperty (const char *name, const QVariant &value)

QVariant	property (const char *name) const

QList< QByteArray >	dynamicPropertyNames () const

QBindingStorage *	bindingStorage ()

const QBindingStorage *	bindingStorage () const

QObject *	parent () const

bool	inherits (const char *classname) const

Static Public Member Functions
static QStringList	seatNames ()

static QList< const QInputDevice * >	devices ()

static const QInputDevice *	primaryKeyboard (const QString &seatName=QString())

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)

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::FunctionPointer< Func2 >::Object receiver, Func2 slot, Qt::ConnectionType type=Qt::AutoConnection)

static QMetaObject::Connection ::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 slot)

static QMetaObject::Connection ::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject context, Func2 slot, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static std::enable_if< QtPrivate::FunctionPointer< Func2 >::ArgumentCount==-1 &&!std::is_convertible_v< Func2, const char * >, QMetaObject::Connection >::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 slot)

template<typename Func1 , typename Func2 >
static std::enable_if< QtPrivate::FunctionPointer< Func2 >::ArgumentCount==-1 &&!std::is_convertible_v< Func2, const char * >, QMetaObject::Connection >::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject context, Func2 slot, Qt::ConnectionType type=Qt::AutoConnection)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)

static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)

static bool	disconnect (const QMetaObject::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
	QInputDevice (QInputDevicePrivate &d, QObject *parent)

Protected Member Functions inherited from QObject
QObject *	sender () const

int	senderSignalIndex () const

int	receivers (const char *signal) const

bool	isSignalConnected (const QMetaMethod &signal) const

virtual void	timerEvent (QTimerEvent *event)

virtual void	childEvent (QChildEvent *event)

virtual void	customEvent (QEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

	QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Properties
QString	name

DeviceType	type

Capabilities	capabilities

qint64	systemId

QString	seatName

QRect	availableVirtualGeometry

Properties inherited from QObject
QString	objectName
	the name of this object More...

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Related Functions inherited from QObject
template< class T > T	qobject_cast (const QObject *object)

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList

Detailed Description

The QInputDevice class describes a device from which a QInputEvent originates.

Since: 6.0 \inmodule QtGui

Each QInputEvent contains a QInputDevice pointer to allow accessing device-specific properties like type, capabilities and seat. It is the responsibility of the platform or generic plug-ins to discover, create and register an instance of this class corresponding to each available input device, via QWindowSystemInterface::registerInputDevice(), before generating any input event referring to that device.

Applications do not need to instantiate this class, but can read the instances pointed to by QInputEvent::device() and QInputDevice::devices().

Definition at line 52 of file qinputdevice.h.

Member Enumeration Documentation

◆ Capability

enum QInputDevice::Capability

strong

Indicates what kind of information the input device or its driver can provide.

\value None No information about input device capabilities available.

\value Position Indicates that position information is available, meaning that the position() family of functions in the touch points return valid points.

\value Area Indicates that touch area information is available, meaning that QEventPoint::ellipseDiameters() in the touch points return valid values.

\value Pressure Indicates that pressure information is available, meaning that QEventPoint::pressure() returns a valid value.

\value Velocity Indicates that velocity information is available, meaning that QEventPoint::velocity() returns a valid vector.

\value NormalizedPosition Indicates that the normalized position is available, meaning that QEventPoint::globalPosition() returns a valid value.

\value MouseEmulation Indicates that the device synthesizes mouse events.

\value Scroll Indicates that the device has a scroll capability.

\value [since 6.2] PixelScroll Indicates that the device (usually a \l {QInputDevice::DeviceType::TouchPad}{touchpad}) scrolls with \l {QWheelEvent::pixelDelta()}{pixel precision}.

\value Hover Indicates that the device has a hover capability.

\value Rotation Indicates that \l {QEventPoint::}{rotation} information is available.

\value XTilt Indicates that \l {QTabletEvent::xTilt()}{tilt} information is available for the X-axis.

\value YTilt Indicates that \l {QTabletEvent::yTilt()}{tilt} information is available for the Y-axis.

\value TangentialPressure Indicates that \l {QTabletEvent::tangentialPressure()} {tangential pressure} information is available.

\value ZPosition Indicates that position information for the \l {QTabletEvent::z()} {Z-axis} is available.

\value All

Enumerator
None
Position
Area
Pressure
Velocity
NormalizedPosition
MouseEmulation
PixelScroll
Scroll
Hover
Rotation
XTilt
YTilt
TangentialPressure
ZPosition
All

Definition at line 79 of file qinputdevice.h.

◆ DeviceType

enum QInputDevice::DeviceType

strong

This enum represents the type of device that generated a QPointerEvent.

\value Unknown The device cannot be identified.

\value Mouse A mouse.

\value TouchScreen In this type of device, the touch surface and display are integrated. This means the surface and display typically have the same size, such that there is a direct relationship between the touch points' physical positions and the coordinate reported by QEventPoint. As a result, Qt allows the user to interact directly with multiple QWidgets, QGraphicsItems, or Qt Quick Items at the same time.

\value TouchPad In this type of device, the touch surface is separate from the display. There is not a direct relationship between the physical touch location and the on-screen coordinates. Instead, they are calculated relative to the current mouse position, and the user must use the touch-pad to move this reference point. Unlike touch-screens, Qt allows users to only interact with a single QWidget or QGraphicsItem at a time.

\value Stylus A pen-like device used on a graphics tablet such as a Wacom tablet, or on a touchscreen that provides a separate stylus sensing capability.

\value Airbrush A stylus with a thumbwheel to adjust \l {QTabletEvent::tangentialPressure}{tangentialPressure}.

\value Puck A device that is similar to a flat mouse with a transparent circle with cross-hairs.

\value Keyboard A keyboard.

\value AllDevices Any of the above (used as a default filter value).

Enumerator
Unknown
Mouse
TouchScreen
TouchPad
Puck
Stylus
Airbrush
Keyboard
AllDevices

Definition at line 65 of file qinputdevice.h.

Constructor & Destructor Documentation

◆ QInputDevice() [1/3]

QInputDevice::QInputDevice ( QObject * parent = nullptr )

Creates a new invalid input device instance as a child of parent.

Definition at line 137 of file qinputdevice.cpp.

◆ ~QInputDevice()

QInputDevice::~QInputDevice ( )

Definition at line 142 of file qinputdevice.cpp.

Here is the call graph for this function:

◆ QInputDevice() [2/3]

QInputDevice::QInputDevice	(	const QString &	name,
		qint64	id,
		QInputDevice::DeviceType	type,
		const QString &	seatName = `QString()`,
		QObject *	parent = `nullptr`
	)

Creates a new input device instance. The given name is normally a manufacturer-assigned model name if available, or something else identifiable; id is a platform-specific number that will be unique per device (for example the xinput ID on X11); type identifies what kind of device. On window systems that are capable of handling input from multiple users or sets of input devices at the same time (such as Wayland or X11), seatName identifies the name of the set of devices that will be used together. If the device is a child or slave device (for example one of several mice that can take turns moving the "core pointer"), the master device should be given as the parent.

The platform plugin creates, registers and continues to own each device instance; usually parent should be given for memory management purposes even if there is no master for a particular device.

By default, capabilities() are None.

Definition at line 165 of file qinputdevice.cpp.

◆ QInputDevice() [3/3]

QInputDevice::QInputDevice	(	QInputDevicePrivate &	d,
		QObject *	parent
	)

protected

Definition at line 174 of file qinputdevice.cpp.

Member Function Documentation

◆ availableVirtualGeometry()

QRect QInputDevice::availableVirtualGeometry ( ) const

Returns the region within the \l{QScreen::availableVirtualGeometry}{virtual desktop} that this device can access.

For example a \l {QInputDevice::DeviceType}{TouchScreen} input device is fixed in place upon a single physical screen, and usually calibrated so that this area is the same as QScreen::geometry(); whereas a \l {QInputDevice::DeviceType}{Mouse} can probably access all screens on the virtual desktop. A Wacom graphics tablet may be configured in a way that it's mapped to all screens, or only to the screen where the user prefers to create drawings, or to the window in which drawing occurs. A \l {QInputDevice::DeviceType}{Stylus} device that is integrated with a touchscreen may be physically limited to that screen.

If the returned rectangle is \l {QRect::isNull()}{null}, it means this device can access the entire virtual desktop.

Definition at line 196 of file qinputdevice.cpp.

◆ availableVirtualGeometryChanged

void QInputDevice::availableVirtualGeometryChanged ( QRect area )

signal

◆ capabilities()

QInputDevice::Capabilities QInputDevice::capabilities ( ) const

Returns the device capabilities.

Definition at line 227 of file qinputdevice.cpp.

◆ devices()

QList< const QInputDevice * > QInputDevice::devices ( )

static

Returns a list of all registered input devices (keyboards and pointing devices).

Note: The returned list cannot be used to add new devices. To add a simulated touch screen for an autotest, QTest::createTouchDevice() can be used. Platform plugins should call QWindowSystemInterface::registerInputDevice() to add devices as they are discovered.

Definition at line 277 of file qinputdevice.cpp.

Here is the caller graph for this function:

◆ hasCapability()

bool QInputDevice::hasCapability ( QInputDevice::Capability capability ) const

Returns whether the device capabilities include the given capability.

Definition at line 236 of file qinputdevice.cpp.

◆ name()

QString QInputDevice::name ( ) const

Returns the device name.

This string may be empty. It is however useful on systems that have multiple input devices: it can be used to differentiate from which device a QPointerEvent originates.

Definition at line 209 of file qinputdevice.cpp.

Here is the caller graph for this function:

◆ operator==()

bool QInputDevice::operator== ( const QInputDevice & other ) const

Definition at line 389 of file qinputdevice.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ primaryKeyboard()

const QInputDevice * QInputDevice::primaryKeyboard ( const QString & seatName = QString() )

static

Returns the core or master keyboard on the given seat seatName.

Definition at line 305 of file qinputdevice.cpp.

◆ seatName()

QString QInputDevice::seatName ( ) const

Returns the seat with which the device is associated, if known; otherwise empty.

Devices that are intended to be used together by one user may be configured to have the same seat name. That is only possible on Wayland and X11 platforms so far.

Definition at line 259 of file qinputdevice.cpp.

◆ seatNames()

QStringList QInputDevice::seatNames ( )

static

Since: 6.3

Returns a list of seat names for all registered input devices (keyboards and pointing devices).

Definition at line 288 of file qinputdevice.cpp.

◆ systemId()

qint64 QInputDevice::systemId ( ) const

Returns the platform specific system ID (for example xinput ID on the X11 platform).

All platforms are expected to provide a unique system ID for each device.

Definition at line 246 of file qinputdevice.cpp.

◆ type()

QInputDevice::DeviceType QInputDevice::type ( ) const

Returns the device type.

Definition at line 218 of file qinputdevice.cpp.

Property Documentation

◆ availableVirtualGeometry

QRect QInputDevice::availableVirtualGeometry

read

Definition at line 135 of file qinputdevice.h.

◆ capabilities

Capabilities QInputDevice::capabilities

read

Definition at line 135 of file qinputdevice.h.

◆ name

QString QInputDevice::name

read

Definition at line 135 of file qinputdevice.h.

◆ seatName

QString QInputDevice::seatName

read

Definition at line 135 of file qinputdevice.h.

◆ systemId

qint64 QInputDevice::systemId

read

Definition at line 135 of file qinputdevice.h.

◆ type

DeviceType QInputDevice::type

read

Definition at line 135 of file qinputdevice.h.

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

src/gui/kernel/qinputdevice.h
src/gui/kernel/qinputdevice.cpp

Public Types

Signals

Public Member Functions

Static Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Capability

◆ DeviceType

Constructor & Destructor Documentation

◆ QInputDevice() [1/3]

◆ ~QInputDevice()

◆ QInputDevice() [2/3]

◆ QInputDevice() [3/3]

Member Function Documentation

◆ availableVirtualGeometry()

◆ availableVirtualGeometryChanged

◆ capabilities()

◆ devices()

◆ hasCapability()

◆ name()

◆ operator==()

◆ primaryKeyboard()

◆ seatName()

◆ seatNames()

◆ systemId()

◆ type()

Property Documentation

◆ availableVirtualGeometry

◆ capabilities

◆ name

◆ seatName

◆ systemId

◆ type