SoXt
1.4.1
Coin3D GUI toolkit binding
|
The SoXtCursor class is used to set cursors for GUI components. More...
Classes | |
class | CustomCursor |
The SoXtCursor::CustomCursor class is used to specify bitmap data for SoXtCursor custom cursors. More... | |
Public Types | |
enum | Shape { CUSTOM_BITMAP = -1 , DEFAULT = 0 , BUSY , CROSSHAIR , UPARROW } |
Public Member Functions | |
SoXtCursor (const CustomCursor *cc) | |
SoXtCursor (const Shape shape) | |
SoXtCursor (const SoXtCursor &cursor) | |
SoXtCursor (void) | |
~SoXtCursor () | |
const CustomCursor & | getCustomCursor (void) const |
Shape | getShape (void) const |
SoXtCursor & | operator= (const SoXtCursor &c) |
void | setShape (const Shape shape) |
Static Public Member Functions | |
static const SoXtCursor & | getBlankCursor (void) |
static const SoXtCursor & | getPanCursor (void) |
static const SoXtCursor & | getRotateCursor (void) |
static const SoXtCursor & | getZoomCursor (void) |
static void | initClass (void) |
The SoXtCursor 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 SoXtComponent::setComponentCursor() and SoXtComponent::setWidgetCursor() methods.
enum SoXtCursor::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.
SoXtCursor::SoXtCursor | ( | void | ) |
Default constructor. Creates a default cursor.
SoXtCursor::SoXtCursor | ( | const Shape | shape | ) |
Constructor with Shape argument, for setting up the cursor with a predefined shape from the underlying native toolkit.
SoXtCursor::SoXtCursor | ( | 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 SoXtCursor has been destructed.
As for the format of the cursor bitmap data, see documentation of SoXtCursor::CustomCursor.
SoXtCursor::SoXtCursor | ( | const SoXtCursor & | cursor | ) |
Constructor.
SoXtCursor::~SoXtCursor | ( | ) |
Destructor
|
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.
const SoXtCursor::CustomCursor & SoXtCursor::getCustomCursor | ( | void | ) | const |
Returns a reference to the current custom bitmap cursor.
Do not call this method unless SoXtCursor::getShape() returns SoXtCursor::CUSTOM_BITMAP.
|
static |
Returns a cursor with "pan" graphics (i.e. for translation in the camera normal plane).
|
static |
Returns a "rotate" indicator cursor.
SoXtCursor::Shape SoXtCursor::getShape | ( | void | ) | const |
Returns the shape type.
If the cursor has been set by the application programmer to a bitmap cursor, SoXtCursor::CUSTOM_BITMAP is returned.
|
static |
Returns a "zoom" indicator cursor.
SoXtCursor & SoXtCursor::operator= | ( | const SoXtCursor & | c | ) |
Assignment operator.
void SoXtCursor::setShape | ( | const Shape | shapearg | ) |
Sets the cursor to a predefined shape.