TQCursor Class

Home | All Classes | Main Classes | Annotated | Grouped Classes | Functions |

# TQCursor Class Reference

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

`#include <tqcursor.h>`

Inherits TQt.

List of all member functions.

## Public Members

- TQCursor ()
- TQCursor ( int shape )
- TQCursor ( const TQBitmap & bitmap, const TQBitmap & mask, int hotX = -1, int hotY = -1 )
- TQCursor ( const TQPixmap & pixmap, int hotX = -1, int hotY = -1 )
- TQCursor ( const TQCursor & c )
- ~TQCursor ()
- TQCursor & operator= ( const TQCursor & c )
- int shape () const
- void setShape ( int shape )
- const TQBitmap * bitmap () const
- const TQBitmap * mask () const
- TQPoint hotSpot () const
- HCURSOR handle () const
- TQCursor ( HCURSOR handle )
- HANDLE handle () const

## Static Public Members

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

## Related Functions

- TQDataStream & operator<< ( TQDataStream & s, const TQCursor & c )
- TQDataStream & operator>> ( TQDataStream & s, TQCursor & c )

## Detailed Description

The TQCursor 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.

TQt has a number of standard cursor shapes, but you can also make custom cursor shapes based on a TQBitmap, a mask and a hotspot.

To associate a cursor with a widget, use TQWidget::setCursor(). To associate a cursor with all widgets (normally for a short period of time), use TQApplication::setOverrideCursor().

To set a cursor shape use TQCursor::setShape() or use the TQCursor constructor which takes the shape as argument, or you can use one of the predefined cursors defined in the CursorShape enum.

If you want to create a cursor with your own bitmap, either use the TQCursor 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 TQCursor::pos() and TQCursor::setPos().

See also TQWidget, GUI Design Handbook: Cursors, Widget Appearance and Style, and Implicitly and Explicitly Shared Classes.

On X11, TQt supports the Xcursor library, which allows for full color icon themes. The table below shows the cursor name used for each TQt::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 TQt::CursorShape values. It is possible that some cursors will be taken from the Xcursor theme, while others will use an internal bitmap cursor.

TQt::CursorShape Values | Cursor Names
--- | ---
TQt::ArrowCursor | left_ptr
TQt::UpArrowCursor | up_arrow
TQt::CrossCursor | cross
TQt::WaitCursor | wait
TQt::BusyCursor | left_ptr_watch
TQt::IbeamCursor | ibeam
TQt::SizeVerCursor | size_ver
TQt::SizeHorCursor | size_hor
TQt::SizeBDiagCursor | size_bdiag
TQt::SizeFDiagCursor | size_fdiag
TQt::SizeAllCursor | size_all
TQt::SplitVCursor | split_v
TQt::SplitHCursor | split_h
TQt::PointingHandCursor | pointing_hand
TQt::ForbiddenCursor | forbidden
TQt::WhatsThisCursor | whats_this

## Member Function Documentation

### TQCursor::TQCursor ()

Constructs a cursor with the default arrow shape.

### TQCursor::TQCursor ( int shape )

Constructs a cursor with the specified shape.

See CursorShape for a list of shapes.

See also setShape().

### TQCursor::TQCursor ( const TQBitmap & bitmap, const TQBitmap & 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 undefined result.

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

Valid 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 TQBitmap::TQBitmap() and TQBitmap::setMask().

### TQCursor::TQCursor ( const TQPixmap & 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 TQPixmap::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 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 TQPixmap::TQPixmap() and TQPixmap::setMask().

### TQCursor::TQCursor ( const TQCursor & c )

Constructs a copy of the cursor c.

### TQCursor::TQCursor ( HCURSOR handle )

Creates a cursor with the specified window system handle handle.

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

### TQCursor::~TQCursor ()

Destroys the cursor.

### const TQBitmap * TQCursor::bitmap () const

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

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

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

See also initialize().

### HANDLE TQCursor::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.

### TQPoint TQCursor::hotSpot () const

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

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

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

See also cleanup().

### const TQBitmap * TQCursor::mask () const

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

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

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

### TQPoint TQCursor::pos ()`[static]`

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

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

See also setPos(), TQWidget::mapFromGlobal(), and TQWidget::mapToGlobal().

Examples: chart/canvasview.cpp, fileiconview/tqfileiconview.cpp, and menu/menu.cpp.

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

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

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

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

### void TQCursor::setPos ( const TQPoint & )`[static]`

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

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

Sets the cursor to the shape identified by shape.

See CursorShape for the list of cursor shapes.

See also shape().

### int TQCursor::shape () const

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

See also setShape().

## Related Functions

### TQDataStream & operator<< ( TQDataStream & s, const TQCursor & c )

Writes the cursor c to the stream s.

See also Format of the TQDataStream operators.

### TQDataStream & operator>> ( TQDataStream & s, TQCursor & c )

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

See also Format of the TQDataStream operators.

This file is part of the TQt toolkit. Copyright © 1995-2007 Trolltech. All Rights Reserved.