QCursor(3qt)

NAME
QCursor - Mouse cursor with an arbitrary shape

SYNOPSIS

#include <qcursor.h>

  Public Members
QCursor ()
QCursor ( int shape )
QCursor ( const QBitmap & bitmap, const QBitmap & mask, 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
HANDLE handle () const

  Static Public Members
QPoint pos ()
void setPos ( int x, int y )
void setPos ( const QPoint & )
void initialize ()
void cleanup ()

RELATED FUNCTION DOCUMENTATION
(Note that these are not member functions.)
QDataStream & operator<< (QDataStream & s, const QCursor & c)
QDataStream & operator>> (QDataStream & s, QCursor & c)

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 bitmap, a mask and a hotspot.

To associate a cursor with a widget, use QWidget::setCursor(). To associate a cursor with all widgets (maybe for a short period of time), use QApplication::setOverrideCursor().

The predefined cursor objects are:

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

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.

Arguments:

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.

QCursor::QCursor ( const QCursor & c )
Constructs a copy of the cursor c.

QCursor::QCursor ( int shape )
Constructs a cursor with the specified shape.

QCursor::~QCursor ()
Destroys 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 cleans up the predefined cursors. This function is called from the QApplication destructor.

See also: initialize().

HANDLE QCursor::handle () const
Returns the window system cursor handle.

Warning: Portable in principle, but if you use it you are probably about to do something non-portable. Be careful.

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

The allowed shapes are: ArrowCursor, UpArrowCursor, CrossCursor, WaitCursor, IbeamCursor, SizeVerCursor, SizeHorCursor, SizeBDiagCursor, SizeFDiagCursor, SizeAllCursor, BlankCursor. These correspond to the predefined global QCursor objects.

See also: shape().

int QCursor::shape () const
Returns the cursor shape identifer. If a custom bitmap has been set, BitmapCursor is returned.

See also: setShape().

RELATED FUNCTION DOCUMENTATION

QDataStream & operator<< (QDataStream & s, const QCursor & c)
Writes a cursor to the stream.

QDataStream & operator>> (QDataStream & s, QCursor & c)
Reads a cursor from the stream.

SEE ALSO
http://www.troll.no/qt/qcursor.html

COPYRIGHT
Copyright 1992-1997 Troll Tech AS. See the LICENSE file included in the distribution for a complete license statement.

AUTHOR
Generated automatically from the source code.