The QPlatformCursor class provides information about pointer device events (movement, buttons), and requests to change the currently displayed cursor. More...

#include <qplatformcursor.h>

Inheritance diagram for QPlatformCursor:

Collaboration diagram for QPlatformCursor:

Public Types
enum	Capability { OverrideCursor = 0x1 }

Public Member Functions
	QPlatformCursor ()
	Constructs a QPlatformCursor.

virtual void	pointerEvent (const QMouseEvent &event)
	This method is called by Qt whenever a QMouseEvent is generated by the underlying pointer input.

virtual void	changeCursor (QCursor windowCursor, QWindow window)=0
	This method is called by Qt whenever the cursor graphic should be changed.

virtual void	setOverrideCursor (const QCursor &)
	Reimplement this function in subclass to set an override cursor on the associated screen and return true to indicate success.

virtual void	clearOverrideCursor ()
	Reimplement this function in subclass to clear the override cursor.

virtual QPoint	pos () const

virtual void	setPos (const QPoint &pos)

virtual QSize	size () const
	Returns the size of the cursor, in native pixels.

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`.

Static Public Member Functions
static Capabilities	capabilities ()

static void	setCapabilities (Capabilities c)

static void	setCapability (Capability c)

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)

Friends
class	QApplicationPrivate

void	qt_qpa_set_cursor (QWidget *w, bool force)

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.

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
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.

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

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

	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

The QPlatformCursor class provides information about pointer device events (movement, buttons), and requests to change the currently displayed cursor.

Since: 5.0

\preliminary

Note that QPlatformCursor does not include any graphics for display. An application that sets a QCursor may provide its own graphics.

See also: QPlatformCursorImage

Definition at line 42 of file qplatformcursor.h.

Member Enumeration Documentation

◆ Capability

enum QPlatformCursor::Capability

Since: 5.10

\value OverrideCursor Indicates that the platform implements QPlatformCursor::setOverrideCursor() and QPlatformCursor::clearOverrideCursor().

Enumerator
OverrideCursor

Definition at line 46 of file qplatformcursor.h.

Constructor & Destructor Documentation

◆ QPlatformCursor()

QPlatformCursor::QPlatformCursor ( )

Constructs a QPlatformCursor.

Definition at line 77 of file qplatformcursor.cpp.

Member Function Documentation

◆ capabilities()

static Capabilities QPlatformCursor::capabilities ( )

inlinestatic

Definition at line 64 of file qplatformcursor.h.

◆ changeCursor()

virtual void QPlatformCursor::changeCursor	(	QCursor *	windowCursor,
		QWindow *	window )

pure virtual

This method is called by Qt whenever the cursor graphic should be changed.

Implementation of this method is mandatory for a subclass of QPlatformCursor.

windowCursor is a pointer to the QCursor that should be displayed.

To unset the cursor of window, \nullptr is passed. This means window does not have a cursor set and the cursor of a the first parent window which has a cursor explicitly set or the system default cursor should take effect.

window is a pointer to the window currently displayed at QCursor::pos(). Note that this may be \nullptr if the current position is not occupied by a displayed widget.

See also: QCursor::pos()

Implemented in QCocoaCursor, QDirectFBCursor, QEglFSKmsGbmCursor, QFbCursor, QHaikuCursor, QOffscreenCursor, QOffscreenCursor, QQnxCursor, QWasmCursor, QWindowsCursor, and QXcbCursor.

◆ clearOverrideCursor()

void QPlatformCursor::clearOverrideCursor ( )

virtual

Reimplement this function in subclass to clear the override cursor.

See also: QGuiApplication::clearOverrideCursor(), Capabilities

Since: 5.10

Reimplemented in QWindowsCursor.

Definition at line 666 of file qplatformcursor.cpp.

◆ pointerEvent()

virtual void QPlatformCursor::pointerEvent ( const QMouseEvent & event )

inlinevirtual

This method is called by Qt whenever a QMouseEvent is generated by the underlying pointer input.

event is a reference to the QMouseEvent in question. A default do-nothing implementation is provided.

Reimplemented in QEglFSKmsGbmCursor, and QFbCursor.

Definition at line 54 of file qplatformcursor.h.

◆ pos()

QPoint QPlatformCursor::pos ( ) const

virtual

Reimplemented in QCocoaCursor, QEglFSKmsGbmCursor, QFbCursor, QOffscreenCursor, QOffscreenCursor, QQnxCursor, QWindowsCursor, and QXcbCursor.

Definition at line 81 of file qplatformcursor.cpp.

◆ setCapabilities()

static void QPlatformCursor::setCapabilities ( Capabilities c )

inlinestatic

Definition at line 65 of file qplatformcursor.h.

◆ setCapability()

static void QPlatformCursor::setCapability ( Capability c )

inlinestatic

Definition at line 66 of file qplatformcursor.h.

◆ setOverrideCursor()

void QPlatformCursor::setOverrideCursor ( const QCursor & )

virtual

Reimplement this function in subclass to set an override cursor on the associated screen and return true to indicate success.

This function can be implemented on platforms where the cursor is a property of the application or the screen rather than a property of the window. On these platforms, the OverrideCursor capability should be set.

See also: QGuiApplication::setOverrideCursor(), Capabilities

Since: 5.10

Reimplemented in QWindowsCursor.

Definition at line 655 of file qplatformcursor.cpp.

◆ setPos()

void QPlatformCursor::setPos ( const QPoint & pos )

virtual

Reimplemented in QCocoaCursor, QEglFSKmsGbmCursor, QFbCursor, QOffscreenCursor, QOffscreenCursor, QQnxCursor, QWindowsCursor, and QXcbCursor.

Definition at line 87 of file qplatformcursor.cpp.

◆ size()

QSize QPlatformCursor::size ( ) const

virtual

Returns the size of the cursor, in native pixels.

Reimplemented in QCocoaCursor, QWindowsCursor, and QXcbCursor.

Definition at line 101 of file qplatformcursor.cpp.

Friends And Related Symbol Documentation

◆ QApplicationPrivate

friend class QApplicationPrivate

friend

Definition at line 70 of file qplatformcursor.h.

◆ qt_qpa_set_cursor

void qt_qpa_set_cursor	(	QWidget *	w,
		bool	force )

friend

Definition at line 5033 of file qwidget.cpp.

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

qtbase/src/gui/kernel/qplatformcursor.h (2f317b41eab90bcafa4381569b498ef3b4f210f6)
qtbase/src/gui/kernel/qplatformcursor.cpp (05fc3aef53348fb58be6308076e000825b704e58)

Public Types

Public Member Functions

Static Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Capability

Constructor & Destructor Documentation

◆ QPlatformCursor()

Member Function Documentation

◆ capabilities()

◆ changeCursor()

◆ clearOverrideCursor()

◆ pointerEvent()

◆ pos()

◆ setCapabilities()

◆ setCapability()

◆ setOverrideCursor()

◆ setPos()

◆ size()

Friends And Related Symbol Documentation

◆ QApplicationPrivate

◆ qt_qpa_set_cursor