QCursor

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

Inheritance diagram of PySide6.QtGui.QCursor

Synopsis

Functions

Static functions

Detailed Description

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 setCursor() . To associate a cursor with all widgets (normally for a short period of time), use setOverrideCursor() .

To set a cursor shape use setShape() or use the QCursor constructor which takes the shape as argument, or you can use one of the predefined cursors defined in the 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 pos() and 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.

A Note for X11 Users

On X11, Qt supports the Xcursor library, which allows for full color icon themes. The table below shows the cursor name used for each CursorShape value. If a cursor cannot be found using the name shown below, a standard X11 cursor will be used instead. Note: X11 does not provide appropriate cursors for all possible CursorShape values. It is possible that some cursors will be taken from the Xcursor theme, while others will use an internal bitmap cursor.

Shape

CursorShape Value

Cursor Name

Shape

CursorShape Value

Cursor Name

cursor-arrow1

ArrowCursor

left_ptr

cursor-sizev2

SizeVerCursor

size_ver

cursor-uparrow3

UpArrowCursor

up_arrow

cursor-sizeh4

SizeHorCursor

size_hor

cursor-cross5

CrossCursor

cross

cursor-sizeb6

SizeBDiagCursor

size_bdiag

cursor-ibeam7

IBeamCursor

ibeam

cursor-sizef8

SizeFDiagCursor

size_fdiag

cursor-wait9

WaitCursor

wait

cursor-sizeall10

SizeAllCursor

size_all

cursor-busy11

BusyCursor

left_ptr_watch

cursor-vsplit12

SplitVCursor

split_v

cursor-forbidden13

ForbiddenCursor

forbidden

cursor-hsplit14

SplitHCursor

split_h

cursor-hand15

PointingHandCursor

pointing_hand

cursor-openhand16

OpenHandCursor

openhand

cursor-whatsthis17

WhatsThisCursor

whats_this

cursor-closedhand18

ClosedHandCursor

closedhand

DragMoveCursor

dnd-move or move

DragCopyCursor

dnd-copy or copy

DragLinkCursor

dnd-link or link

See also

QWidget GUI Design Handbook: Cursors

class PySide6.QtGui.QCursor

PySide6.QtGui.QCursor(shape)

PySide6.QtGui.QCursor(bitmap, mask[, hotX=-1[, hotY=-1]])

PySide6.QtGui.QCursor(cursor)

PySide6.QtGui.QCursor(pixmap[, hotX=-1[, hotY=-1]])

Parameters

Constructs a cursor with the default arrow shape.

Constructs a cursor with the specified shape.

See CursorShape for a list of shapes.

See also

setShape()

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 color0 to draw 0-pixels and 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() setMask()

Constructs a custom pixmap cursor.

pixmap is the image. It is usual to give it a mask (set using 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() setMask()

PySide6.QtGui.QCursor.bitmap()
Return type

PySide6.QtGui.QBitmap

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

PySide6.QtGui.QCursor.bitmap(arg__1)
Parameters

arg__1ReturnByValueConstant

Return type

PySide6.QtGui.QBitmap

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.

PySide6.QtGui.QCursor.hotSpot()
Return type

PySide6.QtCore.QPoint

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

PySide6.QtGui.QCursor.mask()
Return type

PySide6.QtGui.QBitmap

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

PySide6.QtGui.QCursor.mask(arg__1)
Parameters

arg__1ReturnByValueConstant

Return type

PySide6.QtGui.QBitmap

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.

PySide6.QtGui.QCursor.__ne__(rhs)
Parameters

rhsPySide6.QtGui.QCursor

Return type

bool

PySide6.QtGui.QCursor.pixmap()
Return type

PySide6.QtGui.QPixmap

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

static PySide6.QtGui.QCursor.pos()
Return type

PySide6.QtCore.QPoint

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

You can call 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.

See also

setPos() mapFromGlobal() mapToGlobal() primaryScreen()

static PySide6.QtGui.QCursor.pos(screen)
Parameters

screenPySide6.QtGui.QScreen

Return type

PySide6.QtCore.QPoint

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

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

See also

setPos() mapFromGlobal() mapToGlobal()

static PySide6.QtGui.QCursor.setPos(screen, p)
Parameters
static PySide6.QtGui.QCursor.setPos(screen, x, y)
Parameters

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

You can call 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() mapFromGlobal() mapToGlobal()

static PySide6.QtGui.QCursor.setPos(p)
Parameters

pPySide6.QtCore.QPoint

This is an overloaded function.

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

static PySide6.QtGui.QCursor.setPos(x, y)
Parameters
  • x – int

  • y – int

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

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

See also

pos() mapFromGlobal() mapToGlobal() primaryScreen()

PySide6.QtGui.QCursor.setShape(newShape)
Parameters

newShapeCursorShape

Sets the cursor to the shape identified by shape.

See CursorShape for the list of cursor shapes.

See also

shape()

PySide6.QtGui.QCursor.shape()
Return type

CursorShape

Returns the cursor shape identifier. The return value is one of the CursorShape enum values (cast to an int).

See also

setShape()

PySide6.QtGui.QCursor.swap(other)
Parameters

otherPySide6.QtGui.QCursor

Swaps this cursor with the other cursor.