SoQtCursor - Man Page

The SoQtCursor class is used to set cursors for GUI components.

Synopsis

Classes

class CustomCursor
The SoQtCursor::CustomCursor class is used to specify bitmap data for SoQtCursor custom cursors.

Public Types

enum Shape { CUSTOM_BITMAP = -1, DEFAULT = 0, BUSY, CROSSHAIR, UPARROW }

Public Member Functions

SoQtCursor (void)
SoQtCursor (const Shape shape)
SoQtCursor (const CustomCursor *cc)
SoQtCursor (const SoQtCursor &cursor)
~SoQtCursor ()
SoQtCursor & operator= (const SoQtCursor &c)
Shape getShape (void) const
void setShape (const Shape shape)
const CustomCursor & getCustomCursor (void) const

Static Public Member Functions

static void initClass (void)
static const SoQtCursor & getZoomCursor (void)
static const SoQtCursor & getPanCursor (void)
static const SoQtCursor & getRotateCursor (void)
static const SoQtCursor & getBlankCursor (void)

Detailed Description

The SoQtCursor class is used to set cursors for GUI components.

The class provides both a set of predefined cursor shapes, as well as the option to use custom bitmap graphics.

Instances of this class is usually made for passing in to the SoQtComponent::setComponentCursor() and SoQtComponent::setWidgetCursor() methods.

Member Enumeration Documentation

enum SoQtCursor::Shape

For enumerating built-in shape types, that can be used without having to specify cursor graphics. These are mapped to predefined cursor shapes from the underlying toolkit.

Enumerator

CUSTOM_BITMAP

Cursor is specified with our own bitmap graphics. The bitmap data must be passed to the constructor.

DEFAULT

Using the native Window system's default cursor.

BUSY

A busy cursor.

CROSSHAIR

Two thin lines in a cross.

UPARROW

Thick, upward-pointing arrow.

Constructor & Destructor Documentation

SoQtCursor::SoQtCursor (void)

Default constructor. Creates a default cursor.

SoQtCursor::SoQtCursor (const Shape shape)

Constructor with Shape argument, for setting up the cursor with a predefined shape from the underlying native toolkit.

SoQtCursor::SoQtCursor (const CustomCursor * ccarg)

Constructs a new custom bitmap cursor from cc.

Note that only a shallow copy will be made of the CustomCursor bitmap and mask references, so don't deallocate the memory they use until the SoQtCursor has been destructed.

As for the format of the cursor bitmap data, see documentation of SoQtCursor::CustomCursor.

SoQtCursor::SoQtCursor (const SoQtCursor & cursor)

Constructor.

SoQtCursor::~SoQtCursor ()

Destructor

Member Function Documentation

SoQtCursor & SoQtCursor::operator= (const SoQtCursor & c)

Assignment operator.

SoQtCursor::Shape SoQtCursor::getShape (void) const

Returns the shape type.

If the cursor has been set by the application programmer to a bitmap cursor, SoQtCursor::CUSTOM_BITMAP is returned.

void SoQtCursor::setShape (const Shape shapearg)

Sets the cursor to a predefined shape.

const SoQtCursor::CustomCursor & SoQtCursor::getCustomCursor (void) const

Returns a reference to the current custom bitmap cursor.

Do not call this method unless SoQtCursor::getShape() returns SoQtCursor::CUSTOM_BITMAP.

const SoQtCursor & SoQtCursor::getZoomCursor (void) [static]

Returns a 'zoom' indicator cursor.

const SoQtCursor & SoQtCursor::getPanCursor (void) [static]

Returns a cursor with 'pan' graphics (i.e. for translation in the camera normal plane).

const SoQtCursor & SoQtCursor::getRotateCursor (void) [static]

Returns a 'rotate' indicator cursor.

const SoQtCursor & SoQtCursor::getBlankCursor (void) [static]

Because not all toolkits do easily support setting up a blank cursor from predefined shapes or API functions, we also provide a simple completely transparent cursor.

Author

Generated automatically by Doxygen for SoQt from the source code.

Info

Mon Jan 25 2021 Version 1.6.0 SoQt