CopperSpice API  1.7.2
QCursor Class Reference

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

Public Methods

 QCursor ()
 
 QCursor (const QBitmap &bitmap, const QBitmap &mask, int hotX=-1, int hotY=-1)
 
 QCursor (const QCursor &other)
 
 QCursor (const QPixmap &pixmap, int hotX=-1, int hotY=-1)
 
 QCursor (QCursor &&other)
 
 QCursor (Qt::CursorShape shape)
 
 ~QCursor ()
 
const QBitmapbitmap () const
 
QPoint hotSpot () const
 
const QBitmapmask () const
 
 operator QVariant () const
 
QCursor & operator= (const QCursor &cursor)
 
QCursor & operator= (QCursor &&other)
 
QPixmap pixmap () const
 
void setShape (Qt::CursorShape newShape)
 
Qt::CursorShape shape () const
 

Static Public Methods

static QPoint pos ()
 
static QPoint pos (const QScreen *screen)
 
static void setPos (const QPoint &p)
 
static void setPos (int x, int y)
 
static void setPos (QScreen *screen, const QPoint &p)
 
static void setPos (QScreen *screen, int x, int y)
 

Related Functions

These are not member functions

QDataStreamoperator<< (QDataStream &stream, const QCursor &cursor)
 
QDataStreamoperator>> (QDataStream &stream, QCursor &cursor)
 

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

CopperSpice has a number of standard cursor shapes. You can aslo create 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.

X11 Users

On X11 CopperSpice 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 can not 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.

ShapeQt::CursorShape ValueCursor NameShape Qt::CursorShape ValueCursor 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

Constructor & Destructor Documentation

QCursor::QCursor ( )

Constructs a cursor with the default arrow shape.

QCursor::QCursor ( Qt::CursorShape  shape)

Constructs a cursor with the specified shape. Refer to Qt::CursorShape for a list of shapes.

See also
setShape()
QCursor::QCursor ( const QBitmap bitmap,
const QBitmap mask,
int  hotX = -1,
int  hotY = -1 
)

Constructs a custom bitmap cursor. Values for bitmap and mask make up the bitmap. The values for 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 behavior on all other platforms.

Use the global 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.

See also
QBitmap::QBitmap(), QBitmap::setMask()
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(), QPixmap::setMask()
QCursor::QCursor ( const QCursor &  other)

Copy constructs a new QCursor from other.

QCursor::QCursor ( QCursor &&  other)
inline

Move constructs a new QCursor from other.

QCursor::~QCursor ( )

Destroys the cursor.

Method Documentation

const QBitmap * QCursor::bitmap ( ) const

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

QPoint QCursor::hotSpot ( ) const

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

const QBitmap * QCursor::mask ( ) const

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

QCursor::operator QVariant ( ) const

Returns the cursor as a QVariant.

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

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

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

Move assigns from other and returns a reference to this object.

QPixmap QCursor::pixmap ( ) const

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

QPoint QCursor::pos ( )
static

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(), QWidget::mapToGlobal()
QPoint QCursor::pos ( const QScreen screen)
static

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(), QWidget::mapToGlobal()
void QCursor::setPos ( const QPoint p)
inlinestatic

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

void QCursor::setPos ( int  x,
int  y 
)
static

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(), QWidget::mapToGlobal()
void QCursor::setPos ( QScreen screen,
const QPoint p 
)
inlinestatic

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

void QCursor::setPos ( QScreen screen,
int  x,
int  y 
)
static

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.

Calling this method 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 method 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.

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

See also
pos(), QWidget::mapFromGlobal(), QWidget::mapToGlobal()
void QCursor::setShape ( Qt::CursorShape  newShape)

Sets the cursor to the shape identified by newShape.

See also
shape(), Qt::CursorShape
Qt::CursorShape QCursor::shape ( ) const

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

See also
setShape()

Friends And Related Function Documentation

QDataStream & operator<< ( QDataStream stream,
const QCursor &  cursor 
)
related

Writes the cursor to the stream.

See also
Refer to Serializing Data Types for additional information
QDataStream & operator>> ( QDataStream stream,
QCursor &  cursor 
)
related

Reads the cursor from the stream.

See also
Refer to Serializing Data Types for additional information