The QCursor class provides a mouse cursor with an arbitrary shape. More...

#include <qcursor.h>

Collaboration diagram for QCursor:

Public Member Functions
	QCursor ()
	Constructs a cursor with the default arrow shape.

	QCursor (Qt::CursorShape shape)
	Constructs a cursor with the specified shape.

	QCursor (const QBitmap &bitmap, const QBitmap &mask, int hotX=-1, int hotY=-1)
	Constructs a custom bitmap cursor.

	QCursor (const QPixmap &pixmap, int hotX=-1, int hotY=-1)
	Constructs a custom pixmap cursor.

	QCursor (const QCursor &cursor)
	Constructs a copy of the cursor c.

	~QCursor ()
	Destroys the cursor.

QCursor &	operator= (const QCursor &cursor)
	Move-assigns other to this QCursor instance.

	QCursor (QCursor &&other) noexcept

void	swap (QCursor &other) noexcept
	\memberswap{cursor}

	operator QVariant () const
	Returns the cursor as a QVariant.

Qt::CursorShape	shape () const
	Returns the cursor shape identifier.

void	setShape (Qt::CursorShape newShape)
	Sets the cursor to the shape identified by shape.

QBitmap	bitmap () const
	Returns the cursor bitmap, or a null bitmap if it is one of the standard cursors.

QBitmap	mask () const
	Returns the cursor bitmap mask, or a null bitmap if it is one of the standard cursors.

QPixmap	pixmap () const
	Returns the cursor pixmap.

QPoint	hotSpot () const
	Returns the cursor hot spot, or (0, 0) if it is one of the standard cursors.

Static Public Member Functions
static QPoint	pos ()
	Returns the position of the cursor (hot spot) of the primary screen in global screen coordinates.

static QPoint	pos (const QScreen *screen)
	Returns the position of the cursor (hot spot) of the screen in global screen coordinates.

static void	setPos (int x, int y)
	Moves the cursor (hot spot) of the primary screen to the global screen position (x, y).

static void	setPos (QScreen *screen, int x, int y)
	Moves the cursor (hot spot) of the screen to the global screen position (x, y).

static void	setPos (const QPoint &p)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Moves the cursor (hot spot) to the global screen position at point p.

static void	setPos (QScreen *screen, const QPoint &p)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Moves the cursor (hot spot) to the global screen position of the screen at point p.

Friends
Q_GUI_EXPORT bool	operator== (const QCursor &lhs, const QCursor &rhs)

bool	operator!= (const QCursor &lhs, const QCursor &rhs) noexcept

Related Symbols
(Note that these are not member symbols.)
QDataStream &	operator<< (QDataStream &stream, const QCursor &cursor)
	Writes the cursor to the stream.

QDataStream &	operator>> (QDataStream &stream, QCursor &cursor)
	Reads the cursor from the stream.

Detailed Description

The QCursor class provides a mouse cursor with an arbitrary shape.

\inmodule QtGui

This class is mainly used to create mouse cursors that are associated with particular widgets and to get and set the position of the mouse cursor.

Qt has a number of standard cursor shapes, but you can also make custom cursor shapes based on a QBitmap, a mask and a hotspot.

To associate a cursor with a widget, use QWidget::setCursor(). To associate a cursor with all widgets (normally for a short period of time), use QGuiApplication::setOverrideCursor().

To set a cursor shape use QCursor::setShape() or use the QCursor constructor which takes the shape as argument, or you can use one of the predefined cursors defined in the \l Qt::CursorShape enum.

If you want to create a cursor with your own bitmap, either use the QCursor constructor which takes a bitmap and a mask or the constructor which takes a pixmap as arguments.

To set or get the position of the mouse cursor use the static methods QCursor::pos() and QCursor::setPos().

{Note:} It is possible to create a QCursor before QGuiApplication, but it is not useful except as a place-holder for a real QCursor created after QGuiApplication. Attempting to use a QCursor that was created before QGuiApplication will result in a crash.

Definition at line 44 of file qcursor.h.

Constructor & Destructor Documentation

◆ QCursor() [1/6]

QCursor::QCursor ( )

Constructs a cursor with the default arrow shape.

Definition at line 417 of file qcursor.cpp.

◆ QCursor() [2/6]

QCursor::QCursor ( Qt::CursorShape shape )

Constructs a cursor with the specified shape.

See \l Qt::CursorShape for a list of shapes.

See also: setShape()

Definition at line 438 of file qcursor.cpp.

◆ QCursor() [3/6]

QCursor::QCursor	(	const QBitmap &	bitmap,
		const QBitmap &	mask,
		int	hotX = -1,
		int	hotY = -1 )

Constructs a custom bitmap cursor.

bitmap and mask make up the bitmap. hotX and hotY define the cursor's hot spot.

If hotX is negative, it is set to the {bitmap().width()/2}. If hotY is negative, it is set to the {bitmap().height()/2}.

The cursor bitmap (B) and mask (M) bits are combined like this: \list

B=1 and M=1 gives black.
B=0 and M=1 gives white.
B=0 and M=0 gives transparent.
B=1 and M=0 gives an XOR'd result under Windows, undefined results on all other platforms. \endlist

Use the global Qt color Qt::color0 to draw 0-pixels and Qt::color1 to draw 1-pixels in the bitmaps.

Valid cursor sizes depend on the display hardware (or the underlying window system). We recommend using 32 x 32 cursors, because this size is supported on all platforms. Some platforms also support 16 x 16, 48 x 48, and 64 x 64 cursors.

See also: QBitmap::QBitmap(), QBitmap::setMask()

Definition at line 408 of file qcursor.cpp.

◆ QCursor() [4/6]

QCursor::QCursor	(	const QPixmap &	pixmap,
		int	hotX = -1,
		int	hotY = -1 )

explicit

Constructs a custom pixmap cursor.

pixmap is the image. It is usual to give it a mask (set using QPixmap::setMask()). hotX and hotY define the cursor's hot spot.

If hotX is negative, it is set to the {pixmap().width()/2}. If hotY is negative, it is set to the {pixmap().height()/2}.

Valid cursor sizes depend on the display hardware (or the underlying window system). We recommend using 32 x 32 cursors, because this size is supported on all platforms. Some platforms also support 16 x 16, 48 x 48, and 64 x 64 cursors.

See also: QPixmap::QPixmap(), QPixmap::setMask()

Definition at line 352 of file qcursor.cpp.

◆ QCursor() [5/6]

QCursor::QCursor ( const QCursor & cursor )

Constructs a copy of the cursor c.

Definition at line 604 of file qcursor.cpp.

◆ ~QCursor()

QCursor::~QCursor ( )

Destroys the cursor.

Definition at line 615 of file qcursor.cpp.

◆ QCursor() [6/6]

QCursor::QCursor ( QCursor && other )

inlinenoexcept

Since: 5.5

Move-constructs a cursor from other. After being moved from, the only valid operations on other are destruction and (move and copy) assignment. The effects of calling any other member function on a moved-from instance are undefined.

Definition at line 54 of file qcursor.h.

Member Function Documentation

◆ bitmap()

QBitmap QCursor::bitmap ( ) const

Returns the cursor bitmap, or a null bitmap if it is one of the standard cursors.

Since: 5.15

Deprecated: Use the overload without argument instead.

Returns the cursor bitmap, or a null bitmap if it is one of the standard cursors.

Previously, Qt provided a version of bitmap() which returned the bitmap by-pointer. That version is now removed. To maintain compatibility with old code, this function was provided to differentiate between the by-pointer function and the by-value function.

Since: 5.15

Deprecated: Use the overload without argument instead.

Returns the cursor bitmap, or a null bitmap if it is one of the standard cursors.

Previously, Qt provided a version of bitmap() which returned the bitmap by-pointer. That version is now removed. To maintain compatibility with old code, this function was provided to differentiate between the by-pointer function and the by-value function.

Definition at line 544 of file qcursor.cpp.

◆ hotSpot()

QPoint QCursor::hotSpot ( ) const

Returns the cursor hot spot, or (0, 0) if it is one of the standard cursors.

Definition at line 594 of file qcursor.cpp.

◆ mask()

QBitmap QCursor::mask ( ) const

Returns the cursor bitmap mask, or a null bitmap if it is one of the standard cursors.

Since: 5.15

Deprecated: Use the overload without argument instead.

Returns the cursor bitmap mask, or a null bitmap if it is one of the standard cursors.

Previously, Qt provided a version of mask() which returned the bitmap by-pointer. That version is now removed. To maintain compatibility with old code, this function was provided to differentiate between the by-pointer function and the by-value function.

Since: 5.15

Deprecated: Use the overload without argument instead.

Returns the cursor bitmap mask, or a null bitmap if it is one of the standard cursors.

Previously, Qt provided a version of mask() which returned the bitmap by-pointer. That version is now removed. To maintain compatibility with old code, this function was provided to differentiate between the by-pointer function and the by-value function.

Definition at line 570 of file qcursor.cpp.

◆ operator QVariant()

QCursor::operator QVariant ( ) const

Returns the cursor as a QVariant.

Definition at line 641 of file qcursor.cpp.

◆ operator=()

QCursor & QCursor::operator= ( const QCursor & cursor )

Move-assigns other to this QCursor instance.

Assigns c to this cursor and returns a reference to this cursor.

Since: 5.2

Definition at line 627 of file qcursor.cpp.

◆ pixmap()

QPixmap QCursor::pixmap ( ) const

Returns the cursor pixmap.

This is only valid if the cursor is a pixmap cursor.

Definition at line 583 of file qcursor.cpp.

◆ pos() [1/2]

QPoint QCursor::pos ( )

static

Returns the position of the cursor (hot spot) of the primary screen in global screen coordinates.

You can call QWidget::mapFromGlobal() to translate it to widget coordinates.

Note: The position is queried from the windowing system. If mouse events are generated via other means (e.g., via QWindowSystemInterface in a unit test), those fake mouse moves will not be reflected in the returned value.; On platforms where there is no windowing system or cursors are not available, the returned position is based on the mouse move events generated via QWindowSystemInterface.

See also: setPos(), QWidget::mapFromGlobal(), QWidget::mapToGlobal(), QGuiApplication::primaryScreen()

Definition at line 187 of file qcursor.cpp.

◆ pos() [2/2]

QPoint QCursor::pos ( const QScreen * screen )

static

Returns the position of the cursor (hot spot) of the screen in global screen coordinates.

You can call QWidget::mapFromGlobal() to translate it to widget coordinates.

See also: setPos(), QWidget::mapFromGlobal(), QWidget::mapToGlobal()

Definition at line 156 of file qcursor.cpp.

◆ setPos() [1/4]

static void QCursor::setPos ( const QPoint & p )

inlinestatic

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Moves the cursor (hot spot) to the global screen position at point p.

Definition at line 80 of file qcursor.h.

◆ setPos() [2/4]

void QCursor::setPos	(	int	x,
		int	y )

static

Moves the cursor (hot spot) of the primary screen to the global screen position (x, y).

You can call QWidget::mapToGlobal() to translate widget coordinates to global screen coordinates.

See also: pos(), QWidget::mapFromGlobal(), QWidget::mapToGlobal(), QGuiApplication::primaryScreen()

Definition at line 239 of file qcursor.cpp.

◆ setPos() [3/4]

static void QCursor::setPos	(	QScreen *	screen,
		const QPoint &	p )

inlinestatic

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Moves the cursor (hot spot) to the global screen position of the screen at point p.

Definition at line 81 of file qcursor.h.

◆ setPos() [4/4]

void QCursor::setPos	(	QScreen *	screen,
		int	x,
		int	y )

static

Moves the cursor (hot spot) of the screen to the global screen position (x, y).

You can call QWidget::mapToGlobal() to translate widget coordinates to global screen coordinates.

Note: Calling this function results in changing the cursor position through the windowing system. The windowing system will typically respond by sending mouse events to the application's window. This means that the usage of this function should be avoided in unit tests and everywhere where fake mouse events are being injected via QWindowSystemInterface because the windowing system's mouse state (with regards to buttons for example) may not match the state in the application-generated events.; On platforms where there is no windowing system or cursors are not available, this function may do nothing.

See also: pos(), QWidget::mapFromGlobal(), QWidget::mapToGlobal()

Definition at line 213 of file qcursor.cpp.

◆ setShape()

void QCursor::setShape ( Qt::CursorShape shape )

Sets the cursor to the shape identified by shape.

See \l Qt::CursorShape for the list of cursor shapes.

See also: shape()

Definition at line 510 of file qcursor.cpp.

◆ shape()

Qt::CursorShape QCursor::shape ( ) const

Returns the cursor shape identifier.

See also: setShape()

Definition at line 497 of file qcursor.cpp.

◆ swap()

void QCursor::swap ( QCursor & other )

inlinenoexcept

\memberswap{cursor}

Since: 5.7

Definition at line 57 of file qcursor.h.

Friends And Related Symbol Documentation

◆ operator!=

bool operator!=	(	const QCursor &	lhs,
		const QCursor &	rhs )

friend

Since: 5.10

Inequality operator. Returns the equivalent of !(lhs == rhs).

See also: operator==(const QCursor &lhs, const QCursor &rhs)

Definition at line 85 of file qcursor.h.

◆ operator<<()

QDataStream & operator<<	(	QDataStream &	stream,
		const QCursor &	cursor )

See also: {Serializing Qt Data Types}

Definition at line 280 of file qcursor.cpp.

◆ operator==

Q_GUI_EXPORT bool operator==	(	const QCursor &	lhs,
		const QCursor &	rhs )

friend

Since: 5.10

Equality operator. Returns true if lhs and rhs have the same \l{QCursor::}{shape()} and, in the case of \l{Qt::BitmapCursor}{bitmap cursors}, the same \l{QCursor::}{hotSpot()} and either the same \l{QCursor::}{pixmap()} or the same \l{QCursor::}{bitmap()} and \l{QCursor::}{mask()}.

Note: When comparing bitmap cursors, this function only compares the bitmaps' \l{QPixmap::cacheKey()}{cache keys}, not each pixel.

See also: operator!=(const QCursor &lhs, const QCursor &rhs)

Definition at line 461 of file qcursor.cpp.

◆ operator>>()

QDataStream & operator>>	(	QDataStream &	stream,
		QCursor &	cursor )

See also: {Serializing Qt Data Types}

Definition at line 307 of file qcursor.cpp.

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

qtbase/src/gui/kernel/qcursor.h (a0dfa8c4d29a005009d04dcb52452efb9d74e26e)
qtbase/src/gui/kernel/qcursor.cpp (3ccb4ce781463f1b8e0cb4c9283b3067fe92a32e)

Public Member Functions

Static Public Member Functions

Friends

Related Symbols

Detailed Description

Constructor & Destructor Documentation

◆ QCursor() [1/6]

◆ QCursor() [2/6]

◆ QCursor() [3/6]

◆ QCursor() [4/6]

◆ QCursor() [5/6]

◆ ~QCursor()

◆ QCursor() [6/6]

Member Function Documentation

◆ bitmap()

◆ hotSpot()

◆ mask()

◆ operator QVariant()

◆ operator=()

◆ pixmap()

◆ pos() [1/2]

◆ pos() [2/2]

◆ setPos() [1/4]

◆ setPos() [2/4]

◆ setPos() [3/4]

◆ setPos() [4/4]

◆ setShape()

◆ shape()

◆ swap()

Friends And Related Symbol Documentation

◆ operator!=

◆ operator<<()

◆ operator==

◆ operator>>()