.TH "SoQtCursor" 3 "Thu May 26 2016" "Version 1.6.0a" "SoQt" \" -*- nroff -*-
.ad l
.nh
.SH NAME
SoQtCursor \- The \fBSoQtCursor\fP class is used to set cursors for GUI components\&.
.PP
The class provides both a set of pre-defined cursor shapes, aswell as the option to use custom bitmap graphics\&.  

.SH SYNOPSIS
.br
.PP
.SS "Classes"

.in +1c
.ti -1c
.RI "class \fBCustomCursor\fP"
.br
.RI "\fIThe \fBSoQtCursor::CustomCursor\fP class is used to specify bitmap data for \fBSoQtCursor\fP custom cursors\&. \fP"
.in -1c
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum \fBShape\fP { \fBCUSTOM_BITMAP\fP = -1, \fBDEFAULT\fP = 0, \fBBUSY\fP, \fBCROSSHAIR\fP, \fBUPARROW\fP }"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBSoQtCursor\fP (void)"
.br
.ti -1c
.RI "\fBSoQtCursor\fP (const \fBShape\fP shape)"
.br
.ti -1c
.RI "\fBSoQtCursor\fP (const \fBCustomCursor\fP *cc)"
.br
.ti -1c
.RI "\fBSoQtCursor\fP (const \fBSoQtCursor\fP &cursor)"
.br
.ti -1c
.RI "\fB~SoQtCursor\fP ()"
.br
.ti -1c
.RI "\fBSoQtCursor\fP & \fBoperator=\fP (const \fBSoQtCursor\fP &c)"
.br
.ti -1c
.RI "\fBShape\fP \fBgetShape\fP (void) const "
.br
.ti -1c
.RI "void \fBsetShape\fP (const \fBShape\fP shape)"
.br
.ti -1c
.RI "const \fBCustomCursor\fP & \fBgetCustomCursor\fP (void) const "
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static void \fBinitClass\fP (void)"
.br
.ti -1c
.RI "static const \fBSoQtCursor\fP & \fBgetZoomCursor\fP (void)"
.br
.ti -1c
.RI "static const \fBSoQtCursor\fP & \fBgetPanCursor\fP (void)"
.br
.ti -1c
.RI "static const \fBSoQtCursor\fP & \fBgetRotateCursor\fP (void)"
.br
.ti -1c
.RI "static const \fBSoQtCursor\fP & \fBgetBlankCursor\fP (void)"
.br
.in -1c
.SH "Detailed Description"
.PP 
The \fBSoQtCursor\fP class is used to set cursors for GUI components\&.
.PP
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 \fBSoQtComponent::setComponentCursor()\fP and \fBSoQtComponent::setWidgetCursor()\fP methods\&. 
.SH "Member Enumeration Documentation"
.PP 
.SS "enum \fBSoQtCursor::Shape\fP"
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\&. 
.PP
\fBEnumerator\fP
.in +1c
.TP
\fB\fICUSTOM_BITMAP \fP\fP
Cursor is specified with our own bitmap graphics\&. The bitmap data must be passed into the constructor\&. 
.TP
\fB\fIDEFAULT \fP\fP
Using the native Window system's default cursor\&. 
.TP
\fB\fIBUSY \fP\fP
A busy cursor\&. 
.TP
\fB\fICROSSHAIR \fP\fP
Two thin lines in a cross\&. 
.TP
\fB\fIUPARROW \fP\fP
Thick, upward-pointing arrow\&. 
.SH "Constructor & Destructor Documentation"
.PP 
.SS "SoQtCursor::SoQtCursor (void)"
Default constructor\&. Creates a default cursor\&. 
.PP
References DEFAULT\&.
.SS "SoQtCursor::SoQtCursor (const \fBShape\fP shape)"
Constructor with Shape argument, for setting up the cursor with a pre-defined shape from the underlying native toolkit\&. 
.PP
References CUSTOM_BITMAP\&.
.SS "SoQtCursor::SoQtCursor (const \fBCustomCursor\fP * ccarg)"
Constructs a new custom bitmap cursor from \fIcc\fP\&.
.PP
Note that only a \fIshallow\fP copy will be made of the \fBCustomCursor\fP bitmap and mask references, so don't deallocate the memory they use until the \fBSoQtCursor\fP has been destructed\&.
.PP
As for the format of the cursor bitmap data, see documentation of \fBSoQtCursor::CustomCursor\fP\&. 
.PP
References CUSTOM_BITMAP\&.
.SS "SoQtCursor::SoQtCursor (const \fBSoQtCursor\fP & cursor)"
Constructor\&. 
.SS "SoQtCursor::~SoQtCursor ()"
Destructor 
.SH "Member Function Documentation"
.PP 
.SS "\fBSoQtCursor\fP & SoQtCursor::operator= (const \fBSoQtCursor\fP & c)"
Equal operator\&. 
.SS "\fBSoQtCursor::Shape\fP SoQtCursor::getShape (void) const"
Returns the shape type\&.
.PP
If the cursor has been set by the application programmer to a bitmap cursor, \fBSoQtCursor::CUSTOM_BITMAP\fP is returned\&. 
.PP
Referenced by SoQtComponent::setWidgetCursor()\&.
.SS "void SoQtCursor::setShape (const \fBShape\fP shapearg)"
Sets the cursor to a predefined shape\&. 
.SS "const \fBSoQtCursor::CustomCursor\fP & SoQtCursor::getCustomCursor (void) const"
Returns a reference to the current custom bitmap cursor\&.
.PP
Do not call this method unless \fBSoQtCursor::getShape()\fP returns \fBSoQtCursor::CUSTOM_BITMAP\fP\&. 
.PP
Referenced by SoQtComponent::setWidgetCursor()\&.
.SS "const \fBSoQtCursor\fP & SoQtCursor::getZoomCursor (void)\fC [static]\fP"
Returns a 'zoom' indicator cursor\&. 
.PP
Referenced by SoQtExaminerViewer::setViewing()\&.
.SS "const \fBSoQtCursor\fP & SoQtCursor::getPanCursor (void)\fC [static]\fP"
Returns a cursor with 'pan' graphics (ie for translation in the camera normal plane)\&. 
.PP
Referenced by SoQtPlaneViewer::afterRealizeHook(), and SoQtExaminerViewer::setViewing()\&.
.SS "const \fBSoQtCursor\fP & SoQtCursor::getRotateCursor (void)\fC [static]\fP"
Returns a 'rotate' indicator cursor\&. 
.PP
Referenced by SoQtPlaneViewer::afterRealizeHook(), and SoQtExaminerViewer::setViewing()\&.
.SS "const \fBSoQtCursor\fP & SoQtCursor::getBlankCursor (void)\fC [static]\fP"
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\&. 
.PP
Referenced by SoQtPlaneViewer::afterRealizeHook(), and SoQtExaminerViewer::setViewing()\&.

.SH "Author"
.PP 
Generated automatically by Doxygen for SoQt from the source code\&.