Platform cursor implementation. More...

#include <qwindowscursor.h>

Inheritance diagram for QWindowsCursor:

Collaboration diagram for QWindowsCursor:

Classes
struct	PixmapCursor

Public Types
enum class	State { Showing , Hidden , Suppressed }

Public Types inherited from QPlatformCursor
enum	Capability { OverrideCursor = 0x1 }

Public Member Functions
	QWindowsCursor (const QPlatformScreen *screen)

void	changeCursor (QCursor widgetCursor, QWindow widget) override
	Set a cursor on a window.

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

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

QPoint	pos () const override

void	setPos (const QPoint &pos) override

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

CursorHandlePtr	standardWindowCursor (Qt::CursorShape s=Qt::ArrowCursor)
	Return cached standard cursor resources or create new ones.

CursorHandlePtr	pixmapWindowCursor (const QCursor &c)
	Return cached pixmap cursor or create new one.

QPixmap	dragDefaultCursor (Qt::DropAction action) const

HCURSOR	hCursor (const QCursor &c) const

Public Member Functions inherited from QPlatformCursor
	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.

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 void	enforceOverrideCursor ()

static bool	hasOverrideCursor ()

static HCURSOR	createPixmapCursor (QPixmap pixmap, const QPoint &hotSpot, qreal scaleFactor=1)

static HCURSOR	createPixmapCursor (const PixmapCursor &pc, qreal scaleFactor=1)

static PixmapCursor	customCursor (Qt::CursorShape cursorShape, const QPlatformScreen *screen=nullptr)

static HCURSOR	createCursorFromShape (Qt::CursorShape cursorShape, const QPlatformScreen *screen=nullptr)

static QPoint	mousePosition ()

static State	cursorState ()

Static Public Member Functions inherited from QPlatformCursor
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)

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

Platform cursor implementation.

Note that whereas under X11, a cursor can be set as a property of a window, there is only a global SetCursor() function on Windows. Each Window sets on the global cursor on receiving a Enter-event as do the Window manager frames (resize/move handles).

See also: QWindowsWindowCursor

Definition at line 53 of file qwindowscursor.h.

Member Enumeration Documentation

◆ State

enum class QWindowsCursor::State

strong

Enumerator
Showing
Hidden
Suppressed

Definition at line 56 of file qwindowscursor.h.

Constructor & Destructor Documentation

◆ QWindowsCursor()

QWindowsCursor::QWindowsCursor ( const QPlatformScreen * screen )

explicit

Definition at line 558 of file qwindowscursor.cpp.

References initResources(), and Q_UNUSED.

Here is the call graph for this function:

Member Function Documentation

◆ changeCursor()

void QWindowsCursor::changeCursor	(	QCursor *	cursorIn,
		QWindow *	window )

overridevirtual

Set a cursor on a window.

This is called frequently as the mouse moves over widgets in the window (QLineEdits, etc).

Implements QPlatformCursor.

Definition at line 579 of file qwindowscursor.cpp.

References qWarning, window(), and QWindowsWindow::windowsWindowOf().

Here is the call graph for this function:

◆ clearOverrideCursor()

void QWindowsCursor::clearOverrideCursor ( )

overridevirtual

Reimplement this function in subclass to clear the override cursor.

See also: QGuiApplication::clearOverrideCursor(), Capabilities

Since: 5.10

Reimplemented from QPlatformCursor.

Definition at line 620 of file qwindowscursor.cpp.

References QSet< T >::cbegin(), QWindowsContext::instance(), it, and QWindowsWindow::RestoreOverrideCursor.

Here is the call graph for this function:

◆ createCursorFromShape()

HCURSOR QWindowsCursor::createCursorFromShape	(	Qt::CursorShape	cursorShape,
		const QPlatformScreen *	screen = nullptr )

static

Definition at line 459 of file qwindowscursor.cpp.

References Qt::ArrowCursor, Qt::BitmapCursor, Qt::BlankCursor, Qt::BusyCursor, Qt::ClosedHandCursor, createBitmapCursor(), createPixmapCursor(), Qt::CrossCursor, customCursor(), Qt::DragCopyCursor, Qt::DragLinkCursor, Qt::DragMoveCursor, Qt::ForbiddenCursor, QImage::Format_Mono, Qt::IBeamCursor, IDC_HAND, Qt::OpenHandCursor, Qt::PointingHandCursor, Q_ASSERT, qWarning, screen, Qt::SizeAllCursor, Qt::SizeBDiagCursor, Qt::SizeFDiagCursor, Qt::SizeHorCursor, Qt::SizeVerCursor, Qt::SplitHCursor, Qt::SplitVCursor, systemCursorSize(), Qt::UpArrowCursor, Qt::WaitCursor, and Qt::WhatsThisCursor.

Referenced by defaultCursor(), and standardWindowCursor().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createPixmapCursor() [1/2]

static HCURSOR QWindowsCursor::createPixmapCursor	(	const PixmapCursor &	pc,
		qreal	scaleFactor = 1 )

inlinestatic

Definition at line 83 of file qwindowscursor.h.

References createPixmapCursor(), QWindowsCursor::PixmapCursor::hotSpot, and QWindowsCursor::PixmapCursor::pixmap.

Referenced by createPixmapCursor().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createPixmapCursor() [2/2]

HCURSOR QWindowsCursor::createPixmapCursor	(	QPixmap	pixmap,
		const QPoint &	hotSpot,
		qreal	scaleFactor = 1 )

static

Definition at line 66 of file qwindowscursor.cpp.

References Qt::color1, Qt::KeepAspectRatio, QPixmap::mask(), pixmap, qFuzzyCompare(), qRound(), qt_createIconMask(), qt_pixmapToWinHBITMAP(), Qt::SmoothTransformation, QPoint::x(), and QPoint::y().

Referenced by createCursorFromShape(), QWindowsOleDropSource::createCursors(), and pixmapWindowCursor().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cursorState()

QWindowsCursor::State QWindowsCursor::cursorState ( )

static

Definition at line 640 of file qwindowscursor.cpp.

References Hidden, Showing, and Suppressed.

Referenced by QWindowsOleDropSource::GiveFeedback().

Here is the caller graph for this function:

◆ customCursor()

QWindowsCursor::PixmapCursor QWindowsCursor::customCursor	(	Qt::CursorShape	cursorShape,
		const QPlatformScreen *	screen = nullptr )

static

Definition at line 208 of file qwindowscursor.cpp.

References closedhand_bits, Qt::ClosedHandCursor, closedhandm_bits, createPixmapCursorFromData(), Qt::DragCopyCursor, Qt::DragLinkCursor, Qt::DragMoveCursor, hsplit_bits, hsplitm_bits, openhand_bits, Qt::OpenHandCursor, openhandm_bits, screen, screenCursorSize(), Qt::SplitHCursor, Qt::SplitVCursor, standardCursorSize(), vsplit_bits, and vsplitm_bits.

Referenced by createCursorFromShape(), and dragDefaultCursor().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ dragDefaultCursor()

QPixmap QWindowsCursor::dragDefaultCursor ( Qt::DropAction action ) const

Definition at line 688 of file qwindowscursor.cpp.

References Qt::CopyAction, cursor, customCursor(), Qt::DragCopyCursor, Qt::DragLinkCursor, Qt::DragMoveCursor, QImage::Format_ARGB32, QPixmap::fromImage(), QPixmap::isNull(), Qt::LinkAction, Qt::MoveAction, and Qt::TargetMoveAction.

Referenced by QWindowsOleDropSource::createCursors().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ enforceOverrideCursor()

void QWindowsCursor::enforceOverrideCursor ( )

static

Definition at line 600 of file qwindowscursor.cpp.

References hasOverrideCursor().

Referenced by QWindowsWindow::applyCursor(), and QWindowsContext::windowsProc().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasOverrideCursor()

static bool QWindowsCursor::hasOverrideCursor ( )

inlinestatic

Definition at line 75 of file qwindowscursor.h.

Referenced by QWindowsWindow::applyCursor(), enforceOverrideCursor(), and QWindowsContext::windowsProc().

Here is the caller graph for this function:

◆ hCursor()

HCURSOR QWindowsCursor::hCursor ( const QCursor & c ) const

Definition at line 772 of file qwindowscursor.cpp.

References Qt::BitmapCursor, QHash< Key, T >::constEnd(), and QHash< Key, T >::constFind().

Here is the call graph for this function:

◆ mousePosition()

QPoint QWindowsCursor::mousePosition ( )

static

Definition at line 633 of file qwindowscursor.cpp.

Referenced by QWindowsOleDropSource::createCursors(), pos(), QWindowsOleDropSource::QueryContinueDrag(), and QWindowsTabletSupport::translateTabletPacketEvent().

Here is the caller graph for this function:

◆ pixmapWindowCursor()

CursorHandlePtr QWindowsCursor::pixmapWindowCursor ( const QCursor & c )

Return cached pixmap cursor or create new one.

Definition at line 531 of file qwindowscursor.cpp.

References QHash< Key, T >::begin(), cacheKey(), createBitmapCursor(), createPixmapCursor(), QHash< Key, T >::end(), QHash< Key, T >::erase(), QHighDpiScaling::factor(), QHash< Key, T >::find(), QHash< Key, T >::insert(), QPixmap::isNull(), it, QHash< QWindowsPixmapCursorCacheKey, CursorHandlePtr >::iterator, pixmap, and QHash< Key, T >::size().

Here is the call graph for this function:

◆ pos()

QPoint QWindowsCursor::pos ( ) const

overridevirtual

Reimplemented from QPlatformCursor.

Definition at line 654 of file qwindowscursor.cpp.

References mousePosition().

Referenced by setPos().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setOverrideCursor()

void QWindowsCursor::setOverrideCursor ( const QCursor & )

overridevirtual

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 from QPlatformCursor.

Definition at line 606 of file qwindowscursor.cpp.

References cursor, qWarning, and QCursor::shape().

Here is the call graph for this function:

◆ setPos()

void QWindowsCursor::setPos ( const QPoint & pos )

overridevirtual

Reimplemented from QPlatformCursor.

Definition at line 659 of file qwindowscursor.cpp.

References pos(), QPoint::x(), and QPoint::y().

Here is the call graph for this function:

◆ size()

QSize QWindowsCursor::size ( ) const

overridevirtual

Returns the size of the cursor, in native pixels.

Reimplemented from QPlatformCursor.

Definition at line 669 of file qwindowscursor.cpp.

References QWinRegistryKey::dwordValue(), QPlatformScreen::logicalBaseDpi(), QPlatformScreen::logicalDpi(), and screenCursorSize().

Here is the call graph for this function:

◆ standardWindowCursor()

CursorHandlePtr QWindowsCursor::standardWindowCursor ( Qt::CursorShape s = Qt::ArrowCursor )

Return cached standard cursor resources or create new ones.

Definition at line 514 of file qwindowscursor.cpp.

References createCursorFromShape(), QHash< Key, T >::end(), QHash< Key, T >::find(), QHash< Key, T >::insert(), and it.

Here is the call graph for this function:

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

qtbase/src/plugins/platforms/windows/qwindowscursor.h (05fc3aef53348fb58be6308076e000825b704e58)
qtbase/src/plugins/platforms/windows/qwindowscursor.cpp (af0edfbc7c33261d11b559cb4842045457adc4a1)

Classes

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ State

Constructor & Destructor Documentation

◆ QWindowsCursor()

Member Function Documentation

◆ changeCursor()

◆ clearOverrideCursor()

◆ createCursorFromShape()

◆ createPixmapCursor() [1/2]

◆ createPixmapCursor() [2/2]

◆ cursorState()

◆ customCursor()

◆ dragDefaultCursor()

◆ enforceOverrideCursor()

◆ hasOverrideCursor()

◆ hCursor()

◆ mousePosition()

◆ pixmapWindowCursor()

◆ pos()

◆ setOverrideCursor()

◆ setPos()

◆ size()

◆ standardWindowCursor()