QCursor

PyQt5.QtGui.QCursor

Description

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

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

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
	ArrowCursor	left_ptr		SizeVerCursor	size_ver
	UpArrowCursor	up_arrow		SizeHorCursor	size_hor
	CrossCursor	cross		SizeBDiagCursor	size_bdiag
	IBeamCursor	ibeam		SizeFDiagCursor	size_fdiag
	WaitCursor	wait		SizeAllCursor	size_all
	BusyCursor	left_ptr_watch		SplitVCursor	split_v
	ForbiddenCursor	forbidden		SplitHCursor	split_h
	PointingHandCursor	pointing_hand		OpenHandCursor	openhand
	WhatsThisCursor	whats_this		ClosedHandCursor	closedhand
	DragMoveCursor	dnd-move or move		DragCopyCursor	dnd-copy or copy
	DragLinkCursor	dnd-link or link

See also

QWidget, GUI Design Handbook: Cursors.

Methods

__init__()

Constructs a cursor with the default arrow shape.

---

__init__(Union[QCursor, CursorShape])

TODO

---

__init__(Any)

TODO

---

__init__(QPixmap, hotX: int = -1, hotY: int = -1)

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

__init__(), setMask().

---

__init__(QBitmap, QBitmap, hotX: int = -1, hotY: int = -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 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

__init__(), QBitmap::setMask().

---

bitmap() → QBitmap

TODO

---

__eq__(Union[QCursor, CursorShape]) → bool

TODO

---

hotSpot() → QPoint

TODO

---

mask() → QBitmap

TODO

---

__ne__(Union[QCursor, CursorShape]) → bool

TODO

---

pixmap() → QPixmap

TODO

---

@staticmethod
pos() → QPoint

See also

setPos().

---

@staticmethod
pos(QScreen) → QPoint

TODO

---

@staticmethod
setPos(QPoint)

TODO

---

@staticmethod
setPos(int, int)

See also

pos().

---

@staticmethod
setPos(QScreen, QPoint)

TODO

---

@staticmethod
setPos(QScreen, int, int)

TODO

---

setShape(CursorShape)

See also

shape().

---

shape() → CursorShape

See also

setShape().

---

swap(Union[QCursor, CursorShape])

TODO