Qt logo

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

Static Public Members

Related Functions

(Note that these are not member functions.)

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

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(constQBitmap&bitmap, constQBitmap&mask, inthotX=-1, inthotY=-1)

Constructs a custom bitmap cursor.

Arguments:

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(constQPixmap&pixmap, inthotX=-1, inthotY=-1)

Constructs a custom pixmap cursor.

Arguments:

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.

QCursor::QCursor(constQCursor&c)

Constructs a copy of the cursor c.

QCursor::QCursor(intshape)

Constructs a cursor with the specified shape.

QCursor::~QCursor()

Destroys the cursor.

constQBitmap*QCursor::bitmap()const

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

voidQCursor::cleanup() [static]

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

See also: initialize().

QPointQCursor::hotSpot()const

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

voidQCursor::initialize() [static]

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

See also: cleanup().

constQBitmap*QCursor::mask()const

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

QCursor&QCursor::operator=(constQCursor&c)

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

QPointQCursor::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().

voidQCursor::setPos(intx, inty) [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().

voidQCursor::setPos(constQPoint&) [static]

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

voidQCursor::setShape(intshape)

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

intQCursor::shape()const

Returns the cursor shape identifer. If a custom bitmap has been set, BitmapCursor is returned.

See also: setShape().


Related Functions

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.


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


This file is part of the Qt toolkit, copyright © 1995-99 Troll Tech, all rights reserved.


Copyright 1999 Troll TechTrademarks
Qt version 2.0.2