SoWinCursor Class Reference

The SoWinCursor class is used to set cursors for GUI components. More...

Classes
class	CustomCursor
	The SoWinCursor::CustomCursor class is used to specify bitmap data for SoWinCursor custom cursors. More...

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

Public Member Functions
	SoWinCursor (void)
	SoWinCursor (const Shape shape)
	SoWinCursor (const CustomCursor *cc)
	SoWinCursor (const SoWinCursor &cursor)
	~SoWinCursor ()
SoWinCursor &	operator= (const SoWinCursor &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 SoWinCursor &	getZoomCursor (void)
static const SoWinCursor &	getPanCursor (void)
static const SoWinCursor &	getRotateCursor (void)
static const SoWinCursor &	getBlankCursor (void)

Detailed Description

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

The class provides both a set of pre-defined cursor shapes, aswell as the option to use custom bitmap graphics.

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

Member Enumeration Documentation

Shape

enum SoWinCursor::Shape

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

Enumerator
CUSTOM_BITMAP	Cursor is specified with our own bitmap graphics. The bitmap data must be passed into 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

SoWinCursor() [1/4]

SoWinCursor::SoWinCursor

(

void

)

Default constructor. Creates a default cursor.

SoWinCursor() [2/4]

SoWinCursor::SoWinCursor

(

const Shape

shape

)

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

SoWinCursor() [3/4]

SoWinCursor::SoWinCursor

(

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 SoWinCursor has been destructed.

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

SoWinCursor() [4/4]

SoWinCursor::SoWinCursor

(

const SoWinCursor &

cursor

)

Constructor.

~SoWinCursor()

SoWinCursor::~SoWinCursor

(

)

Destructor

Member Function Documentation

operator=()

SoWinCursor & SoWinCursor::operator=

(

const SoWinCursor &

c

)

Equal operator.

getShape()

SoWinCursor::Shape SoWinCursor::getShape

(

void

)

const

Returns the shape type.

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

setShape()

void SoWinCursor::setShape

(

const Shape

shapearg

)

Sets the cursor to a predefined shape.

getCustomCursor()

const SoWinCursor::CustomCursor & SoWinCursor::getCustomCursor

(

void

)

const

Returns a reference to the current custom bitmap cursor.

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

getZoomCursor()

const SoWinCursor & SoWinCursor::getZoomCursor ( void  )

static

Returns a "zoom" indicator cursor.

getPanCursor()

const SoWinCursor & SoWinCursor::getPanCursor ( void  )

static

Returns a cursor with "pan" graphics (ie for translation in the camera normal plane).

getRotateCursor()

const SoWinCursor & SoWinCursor::getRotateCursor ( void  )

static

Returns a "rotate" indicator cursor.

getBlankCursor()

const SoWinCursor & SoWinCursor::getBlankCursor ( void  )

static

Because all toolkits don't easily support setting up a blank cursor from pre-defined shapes or API functions, we also provide a simple completely transparent cursor.

---

The documentation for this class was generated from the following files:

• SoWinCursor.h
• SoWinCursor.cpp