Home · All Classes · Modules

QCursor Class Reference
^{[QtGui module]}

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

Methods

• __init__ (self)
• __init__ (self, Qt.CursorShape shape)
• __init__ (self, QBitmap bitmap, QBitmap mask, int hotX = -1, int hotY = -1)
• __init__ (self, QPixmap pixmap, int hotX = -1, int hotY = -1)
• __init__ (self, QCursor cursor)
• __init__ (self, QVariant variant)
• QBitmap bitmap (self)
• QPoint hotSpot (self)
• QBitmap mask (self)
• QPixmap pixmap (self)
• setShape (self, Qt.CursorShape newShape)
• Qt.CursorShape shape (self)

Static Methods

• QPoint pos ()
• setPos (int x, int y)
• setPos (QPoint p)

A Qt.CursorShape may be used whenever a QCursor is expected.

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 QWidget.setCursor(). To associate a cursor with all widgets (normally for a short period of time), use QApplication.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 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 QApplication, but it is not useful except as a place-holder for a real QCursor created after QApplication. Attempting to use a QCursor that was created before QApplication will result in a crash.

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

Method Documentation

QCursor.__init__ (self)

Constructs a cursor with the default arrow shape.

QCursor.__init__ (self, Qt.CursorShape shape)

Constructs a cursor with the specified shape.

See Qt.CursorShape for a list of shapes.

See also setShape().

QCursor.__init__ (self, QBitmap bitmap, 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.

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.

Note: On Windows CE, the cursor size is fixed. If the pixmap is bigger than the system size, it will be scaled.

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

QCursor.__init__ (self, 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.

Note: On Windows CE, the cursor size is fixed. If the pixmap is bigger than the system size, it will be scaled.

See also QPixmap.QPixmap() and QPixmap.setMask().

QCursor.__init__ (self, QCursor cursor)

Constructs a copy of the cursor c.

QCursor.__init__ (self, QVariant variant)

Constructs a Qt cursor from the given Windows cursor.

See also handle().

QBitmap QCursor.bitmap (self)

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

QPoint QCursor.hotSpot (self)

QBitmap QCursor.mask (self)

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

QPixmap QCursor.pixmap (self)

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

QPoint QCursor.pos ()

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

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

See also setPos(), QWidget.mapFromGlobal(), and QWidget.mapToGlobal().

QCursor.setPos (int x, int y)

Moves the cursor (hot spot) 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(), and QWidget.mapToGlobal().

QCursor.setPos (QPoint p)

This is an overloaded function.

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

QCursor.setShape (self, Qt.CursorShape newShape)

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

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

See also setShape().