QCursor Class | Qt GUI 5.15.19 (original) (raw)

Member Function Documentation

QCursor::QCursor(QCursor &&other)

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.

This function was introduced in Qt 5.5.

QCursor::QCursor(const QCursor &c)

Constructs a copy of the cursor c.

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

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() and QPixmap::setMask().

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:

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.

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

See also QBitmap::QBitmap() and QBitmap::setMask().

QCursor::QCursor(Qt::CursorShape shape)

Constructs a cursor with the specified shape.

See Qt::CursorShape for a list of shapes.

See also setShape().

QCursor::QCursor()

Constructs a cursor with the default arrow shape.

QCursor &QCursor::operator=(QCursor &&other)

Move-assigns other to this QCursor instance.

This function was introduced in Qt 5.2.

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

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

QCursor::~QCursor()

Destroys the cursor.

QBitmap QCursor::bitmap(Qt::ReturnByValueConstant) const

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 deprecated. To maintain compatibility with old code, you can explicitly differentiate between the by-pointer function and the by-value function:

const QBitmap *bmpPtr = cursor->bitmap(); QBitmap bmpVal = cursor->bitmap(Qt::ReturnByValue);

If you disable the deprecated version using the QT_DISABLE_DEPRECATED_BEFORE macro, then you can omit Qt::ReturnByValue as shown below:

This function was introduced in Qt 5.15.

QPoint QCursor::hotSpot() const

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

QBitmap QCursor::mask(Qt::ReturnByValueConstant) const

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 deprecated. To maintain compatibility with old code, you can explicitly differentiate between the by-pointer function and the by-value function:

const QBitmap *bmpPtr = cursor->mask(); QBitmap bmpVal = cursor->mask(Qt::ReturnByValue);

If you disable the deprecated version using the QT_DISABLE_DEPRECATED_BEFORE macro, then you can omit Qt::ReturnByValue as shown below:

This function was introduced in Qt 5.15.

QPixmap QCursor::pixmap() const

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

`[static]` QPoint QCursor::pos()

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.

Note: 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.

`[static]` QPoint QCursor::pos(const QScreen **screen*)

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(), and QWidget::mapToGlobal().

`[static]` void QCursor::setPos(int x, int y)

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.

`[static]` void QCursor::setPos(QScreen **screen*, int x, int y)

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.

Note: On platforms where there is no windowing system or cursors are not available, this function may do nothing.

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

`[static]` void QCursor::setPos(const QPoint &p)

This is an overloaded function.

Moves the cursor (hot spot) to the global screen position at point p.

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

This is an overloaded function.

Moves the cursor (hot spot) to the global screen position of the screen at point p.

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

Sets the cursor to the shape identified by shape.

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

See also shape().

Qt::CursorShape QCursor::shape() const

Returns the cursor shape identifier.