Coin Logo http://www.sim.no
http://www.coin3d.org

SoQtCursor Class Reference
[Miscellaneous Classes]

List of all members.

Detailed Description

The SoQtCursor 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 SoQtComponent::setComponentCursor() and SoQtComponent::setWidgetCursor() methods.


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 ()
SoQtCursoroperator= (const SoQtCursor &c)
Shape getShape (void) const
void setShape (const Shape shape)
const CustomCursorgetCustomCursor (void) const

Static Public Member Functions

static void initClass (void)
static const SoQtCursorgetZoomCursor (void)
static const SoQtCursorgetPanCursor (void)
static const SoQtCursorgetRotateCursor (void)
static const SoQtCursorgetBlankCursor (void)

Classes

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


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

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 pre-defined 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  ) 

Equal 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 (ie 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 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:

Copyright © 1998-2005 by Systems in Motion AS. All rights reserved.

Generated on Wed May 9 11:46:57 2007 for SoQt by Doxygen. 1.5.1