PoXtSliderData Class Reference
[Dialog]

Abstract class for a slider. More...

#include <Inventor/dialog/PoXtSliderData.h>

Inheritance diagram for PoXtSliderData:

Public Types
enum	TriggerMode { CONTINUOUS_TRIGGER, MOUSE_ON_RELEASE_TRIGGER }
typedef void	PoXtSliderAppearanceCB (const SbVec2s &start, const SbVec2s &end, void *userData)
Public Member Functions
virtual	~PoXtSliderData ()
SoNONUNICODE void	setLabel (const char *label)
void	setLabel (const SbString &label)
SbString	getLabel () const
SbBool	isNumericFieldVisible () const
void	setNumericFieldVisibility (SbBool flag)
void	setTrigger (TriggerMode mode)
TriggerMode	getTrigger () const
void	setFixedLimits (SbBool flag)
SbBool	isFixedLimits () const
void	setAppearance (const SbColor &color)
void	setAppearance (const SbColor &startColor, const SbColor &endColor)
void	setAppearance (int numColors, const SbColor *colors, SbBool isColorShaded=TRUE)
void	setAppearance (PoXtSliderAppearanceCB function, void userData=NULL)
virtual TypeXtElement	getType () const =0

Detailed Description

Abstract class for a slider.

This element contains a text label on the left, a GL slider in the center and an editable text field on the right. Futhermore, the appearance of the slider can be defined. By default, the editable text is visible, the text of label is an empty string, and the trigger mode is MOUSE_ON_RELEASE_TRIGGER.

Deprecated:: Deprecated since Open Inventor 8000
Please use DialogViz classes for new development.

Member Typedef Documentation

typedef void PoXtSliderData::PoXtSliderAppearanceCB(const SbVec2s &start, const SbVec2s &end, void *userData)

Prototype of the callback used by the next setAppearance method.

The parameters represent the left inferior and the right superior corners of the slider.

Member Enumeration Documentation

enum PoXtSliderData::TriggerMode

Type of slider's triggering.

Enumerator:

CONTINUOUS_TRIGGER	The slider is triggered each time the mouse move.
MOUSE_ON_RELEASE_TRIGGER	The slider is triggered only when the mouse is released.

Constructor & Destructor Documentation

virtual PoXtSliderData::~PoXtSliderData ( ) [virtual]

Destructor.

Member Function Documentation

SbString PoXtSliderData::getLabel ( ) const

Gets the text of the label on the left of the GL slider.

TriggerMode PoXtSliderData::getTrigger ( ) const

Gets the trigger mode.

Either the slider is triggered when the mouse is released on the thumb of the slider (MOUSE_ON_RELEASE_TRIGGER ) or each time the thumb of the slider is moved (CONTINUOUS_TRIGGER).

virtual TypeXtElement PoXtSliderData::getType ( ) const [pure virtual]

Returns the type of the Xt element.

Reimplemented from PoXtElementData.

Implemented in PoXtIntSliderData, and PoXtRealSliderData.

SbBool PoXtSliderData::isFixedLimits ( ) const

Indicates if the limits are fixed or not.

SbBool PoXtSliderData::isNumericFieldVisible ( ) const

Returns the visibility of the numerical field on the right of the GL slider.

void PoXtSliderData::setAppearance	(	PoXtSliderAppearanceCB *	function,
		void *	userData = `NULL`
	)

Defines the appearance of the slider by a function given by the user.

This function will be called when the slider is drawn. The parameters start and end of the function represent the lower left and the upper right corners of the slider. To draw the appearance of the slider, you must imperatively call OpenGL functions only.

void PoXtSliderData::setAppearance	(	int	numColors,
		const SbColor *	colors,
		SbBool	isColorShaded = `TRUE`
	)

Defines the appearance of the slider.

It is represented by a list of colors, and according to the state of isColorsShaded,

void PoXtSliderData::setAppearance	(	const SbColor &	startColor,
		const SbColor &	endColor
	)

Defines the appearance of the slider.

It has a shade of colors from the startColor to the endColor.

void PoXtSliderData::setAppearance ( const SbColor & color )

Defines the appearance of the slider with a constant color.

void PoXtSliderData::setFixedLimits ( SbBool flag )

Sets if the limits are fixed or not.

The limits are not fixed by default.

void PoXtSliderData::setLabel ( const SbString & label )

Sets the text of the label on the left of the GL slider.

SoNONUNICODE void PoXtSliderData::setLabel ( const char * label )

Sets the text of the label on the left of the GL slider.

Non Unicode List:: This function should not be used in a Unicode application.

void PoXtSliderData::setNumericFieldVisibility ( SbBool flag )

Sets the visibility of the numeric field on the right of the GL slider.

void PoXtSliderData::setTrigger ( TriggerMode mode )

Sets the trigger mode.

Either the slider is triggered when the mouse is released on the thumb of the slider (MOUSE_ON_RELEASE_TRIGGER ) or each time the thumb of the slider is moved (CONTINUOUS_TRIGGER).

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

Inventor/dialog/PoXtSliderData.h

PoXtSliderData Class Reference [Dialog]