Qt Toolkit - QCursor Class

| Classes - Annotated - Tree - Functions - Home - Structure

# QCursor Class Reference

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

`#include <qcursor.h>`

List of all member functions.

## Public Members

- QCursor ()
- QCursor ( int shape )
- QCursor ( const QBitmap & bitmap, const QBitmap & mask, int hotX=-1, int hotY=-1 )
- QCursor ( const QPixmap & pixmap, int hotX=-1, int hotY=-1 )
- QCursor ( const QCursor & )
- ~QCursor ()
- QCursor& operator= ( const QCursor & )
- int shape () const
- void setShape ( int )
- const QBitmap* bitmap () const
- const QBitmap* mask () const
- QPoint hotSpot () const

## Static Public Members

- QPoint pos ()
- void setPos ( int x, int y )
- void setPos ( const QPoint & )
- void initialize ()
- void cleanup ()

## Related Functions

(Note that these are not member functions.)

- QDataStream & operator<< (QDataStream & s, const QCursor & c)
- QDataStream & operator>> (QDataStream & s, QCursor & c)

## Detailed Description

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

This class is used for mainly two things; to create mouse cursors to be associated with 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 use one of the predefined cursors:

- `arrowCursor` - standard arrow cursor
- `upArrowCursor` - upwards arrow
- `crossCursor` - crosshair
- `waitCursor` - hourglass/watch
- `ibeamCursor` - ibeam/text entry
- `sizeVerCursor` - vertical resize
- `sizeHorCursor` - horizontal resize
- `sizeBDiagCursor` - diagonal resize (/)
- `sizeFDiagCursor` - diagonal resize (\)
- `sizeAllCursor` - all directions resize
- `blankCursor` - blank/invisible cursor
- `splitVCursor` - vertical splitting
- `splitHCursor` - horziontal splitting
- `pointingHandCursor` - a pointing hand
- `forbiddenCursor` - a slashed circle

If you want to create a cursor with an own bitmap, use either the QCursor constructor which takes a 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().

See also QWidget and GUI Design Handbook: Cursors.

Examples: cursor/cursor.cpp

## Member Function Documentation

### QCursor::QCursor ()

Constructs a cursor with the default arrow shape.

### QCursor::QCursor ( const QBitmap & bitmap, const 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 hot spot of this cursor.

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 this way:

1. B=1 and M=1 gives black.
2. B=0 and M=1 gives white.
3. B=0 and M=0 gives transparency.
4. B=1 and M=0 gives an undefined result.

Use the global color `color0` to draw 0-pixels and `color1` to draw 1-pixels in the bitmaps.

Allowed cursor sizes depend on the display hardware (or the underlying window system). We recommend using 32x32 cursors, because this size is supported on all platforms. Some platforms also support 16x16, 48x48 and 64x64 cursors.

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

### QCursor::QCursor ( const QPixmap & pixmap, int hotX=-1, int hotY=-1 )

Constructs a custom pixmap cursor.

pixmap is the image (usually it should have a mask (set using QPixmap::setMask()) hotX and hotY define the hot spot of this cursor.

If hotX is negative, it is set to the pixmap().width()/2. If hotY is negative, it is set to the pixmap().height()/2.

Allowed cursor sizes depend on the display hardware (or the underlying window system). We recommend using 32x32 cursors, because this size is supported on all platforms. Some platforms also support 16x16, 48x48 and 64x64 cursors.

Currently, only black-and-white pixmaps can be used.

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

### QCursor::QCursor ( const QCursor & c )

Constructs a copy of the cursor c.

### QCursor::QCursor ( int shape )

Constructs a cursor with the specified shape.

shape can be one of

- `ArrowCursor` - standard arrow cursor
- `UpArrowCursor` - upwards arrow
- `CrossCursor` - crosshair
- `WaitCursor` - hourglass/watch
- `IbeamCursor` - ibeam/text entry
- `SizeVerCursor` - vertical resize
- `SizeHorCursor` - horizontal resize
- `SizeBDiagCursor` - diagonal resize (/)
- `SizeFDiagCursor` - diagonal resize (\)
- `SizeAllCursor` - all directions resize
- `BlankCursor` - blank/invisible cursor
- `SplitVCursor` - vertical splitting
- `SplitHCursor` - horziontal splitting
- `PointingHandCursor` - a pointing hand
- `BitmapCursor` - userdefined bitmap cursor

These correspond to the predefined global QCursor objects.

See also setShape().

### QCursor::~QCursor ()

Destructs the cursor.

### const QBitmap * QCursor::bitmap () const

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

### void QCursor::cleanup () `[static]`

Internal function that deinitializes the predefined cursors. This function is called from the QApplication destructor.

See also initialize().

### QPoint QCursor::hotSpot () const

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

### void QCursor::initialize () `[static]`

Internal function that initializes the predefined cursors. This function is called from the QApplication constructor.

See also cleanup().

### const QBitmap * QCursor::mask () const

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

### QCursor & QCursor::operator= ( const QCursor & c )

Assigns c to this cursor and returns a reference to this 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() and QWidget::mapToGlobal().

### void QCursor::setPos ( int x, int y ) `[static]`

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

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

See also pos(), QWidget::mapFromGlobal() and QWidget::mapToGlobal().

### void QCursor::setPos ( const QPoint & ) `[static]`

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

### void QCursor::setShape ( int shape )

Sets the cursor to the shape identified by shape.

- `ArrowCursor` - standard arrow cursor
- `UpArrowCursor` - upwards arrow
- CrossCursor - crosshair
- `WaitCursor` - hourglass/watch
- `IbeamCursor` - ibeam/text entry
- `SizeVerCursor` - vertical resize
- `SizeHorCursor` - horizontal resize
- `SizeBDiagCursor` - diagonal resize (/)
- `SizeFDiagCursor` - diagonal resize (\)
- `SizeAllCursor` - all directions resize
- `BlankCursor` - blank/invisible cursor
- `SplitVCursor` - vertical splitting
- `SplitHCursor` - horziontal splitting
- `PointingHandCursor` - a pointing hand
- `ForbiddenCursor` - a slashed circle
- `BitmapCursor` - userdefined bitmap cursor

These correspond to the predefined global QCursor objects.

See also shape().

### int QCursor::shape () const

Returns the cursor shape identifer. The return value is one of following values (cast to an int)

- `ArrowCursor` - standard arrow cursor
- `UpArrowCursor` - upwards arrow
- `CrossCursor` - crosshair
- `WaitCursor` - hourglass/watch
- `IbeamCursor` - ibeam/text entry
- `SizeVerCursor` - vertical resize
- `SizeHorCursor` - horizontal resize
- `SizeBDiagCursor` - diagonal resize (/)
- `SizeFDiagCursor` - diagonal resize (\)
- `SizeAllCursor` - all directions resize
- `BlankCursor` - blank/invisible cursor
- `SplitVCursor` - vertical splitting
- `SplitHCursor` - horziontal splitting
- `PointingHandCursor` - a pointing hand
- `ForbiddenCursor` - a slashed circle
- `BitmapCursor` - userdefined bitmap cursor

These correspond to the predefined global QCursor objects.

See also setShape().

## Related Functions

### QDataStream & operator<< (QDataStream & s, const QCursor & c)

Writes the cursor c to the stream s.

See also Format of the QDataStream operators

### QDataStream & operator>> (QDataStream & s, QCursor & c)

Reads a cursor from the stream s and sets c to the read data.

See also Format of the QDataStream operators

Search the documentation, FAQ, qt-interest archive and more (uses www.trolltech.com):

This file is part of the Qt toolkit, copyright © 1995-2000 Trolltech, all rights reserved.