PySide6.QtGui.QCursor¶

class QCursor¶

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

Synopsis¶

Methods¶

def __init__()
def bitmap()
def hotSpot()
def mask()
def __ne__()
def pixmap()
def setShape()
def shape()
def swap()

Static functions¶

def pos()
def setPos()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

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 QWidget::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 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 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 Qt::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 Qt::CursorShape values. It is possible that some cursors will be taken from the Xcursor theme, while others will use an internal bitmap cursor.

Shape

Qt::CursorShape Value

Cursor Name

Shape

Qt::CursorShape Value

Cursor Name

Qt::ArrowCursor

left_ptr

Qt::SizeVerCursor

size_ver

Qt::UpArrowCursor

up_arrow

Qt::SizeHorCursor

size_hor

Qt::CrossCursor

cross

Qt::SizeBDiagCursor

size_bdiag

Qt::IBeamCursor

ibeam

Qt::SizeFDiagCursor

size_fdiag

Qt::WaitCursor

wait

Qt::SizeAllCursor

size_all

Qt::BusyCursor

left_ptr_watch

Qt::SplitVCursor

split_v

Qt::ForbiddenCursor

forbidden

Qt::SplitHCursor

split_h

Qt::PointingHandCursor

pointing_hand

Qt::OpenHandCursor

openhand

Qt::WhatsThisCursor

whats_this

Qt::ClosedHandCursor

closedhand

Qt::DragMoveCursor

dnd-move or move

Qt::DragCopyCursor

dnd-copy or copy

Qt::DragLinkCursor

dnd-link or link

See also

QWidget

Qt::CursorShape Value	Cursor Name	Qt::CursorShape Value	Cursor Name
Qt::ArrowCursor	`left_ptr`	Qt::SizeVerCursor	`size_ver`
Qt::UpArrowCursor	`up_arrow`	Qt::SizeHorCursor	`size_hor`
Qt::CrossCursor	`cross`	Qt::SizeBDiagCursor	`size_bdiag`
Qt::IBeamCursor	`ibeam`	Qt::SizeFDiagCursor	`size_fdiag`
Qt::WaitCursor	`wait`	Qt::SizeAllCursor	`size_all`
Qt::BusyCursor	`left_ptr_watch`	Qt::SplitVCursor	`split_v`
Qt::ForbiddenCursor	`forbidden`	Qt::SplitHCursor	`split_h`
Qt::PointingHandCursor	`pointing_hand`	Qt::OpenHandCursor	`openhand`
Qt::WhatsThisCursor	`whats_this`	Qt::ClosedHandCursor	`closedhand`
Qt::DragMoveCursor	`dnd-move` or `move`	Qt::DragCopyCursor	`dnd-copy` or `copy`
Qt::DragLinkCursor	`dnd-link` or `link`

__init__()¶

Constructs a cursor with the default arrow shape.

__init__(shape)

Parameters:: shape – CursorShape

Constructs a cursor with the specified shape.

See Qt::CursorShape for a list of shapes.

See also

setShape()

__init__(cursor)

Parameters:: cursor – QCursor

Constructs a copy of the cursor c.

__init__(pixmap[, hotX=-1[, hotY=-1]])

Parameters:

pixmap – QPixmap
hotX – int
hotY – int

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

__init__(bitmap, mask[, hotX=-1[, hotY=-1]])

Parameters:

bitmap – QBitmap
mask – QBitmap
hotX – int
hotY – int

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() setMask()

bitmap()¶

Return type:: QBitmap

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

bitmap(arg__1)

Parameters:: arg__1 – ReturnByValueConstant
Return type:: QBitmap

Note

This function is 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.

hotSpot()¶

Return type:: QPoint

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

mask()¶

Return type:: QBitmap

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

mask(arg__1)

Parameters:: arg__1 – ReturnByValueConstant
Return type:: QBitmap

Note

This function is 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.

__ne__(rhs)¶

Parameters:: rhs – QCursor
Return type:: bool

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

See also

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

pixmap()¶

Return type:: QPixmap

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

static pos()¶

Return type:: QPoint

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.