DigitalSpaces::DICEGUISpinner Struct Reference
[CEGUI]

#include <CEGUIInterfaces.h>

Inherits DigitalSpaces::DIObjectBase.

Public Member Functions
float	getCurrentValue ()
	Return the current spinner value.
float	getStepSize ()
	Return the current step value.
float	getMaximumValue ()
	Return the current maximum limit value for the Spinner.
float	getMinimumValue ()
	Return the current minimum limit value for the Spinner.
CEGUITextInputMode	getTextInputMode ()
	Return the current text input / display mode setting.
void	setCurrentValue (float value)
	Set the current spinner value.
void	setStepSize (float step)
	Set the current step value.
void	setMaximumValue (float maxValue)
	Set the spinner maximum value.
void	setMinimumValue (float minVaue)
	Set the spinner minimum value.
void	setTextInputMode (CEGUITextInputMode mode)
	Set the spinner input / display mode.

---

Member Function Documentation

float DigitalSpaces::DICEGUISpinner::getCurrentValue

(

)

Return the current spinner value.

Returns:

current float value of the Spinner.

float DigitalSpaces::DICEGUISpinner::getStepSize

(

)

Return the current step value.

Returns:

float step value. This is the value added to the spinner vaue when the up / down buttons are clicked.

float DigitalSpaces::DICEGUISpinner::getMaximumValue

(

)

Return the current maximum limit value for the Spinner.

Returns:

Maximum value that is allowed for the spinner.

float DigitalSpaces::DICEGUISpinner::getMinimumValue

(

)

Return the current minimum limit value for the Spinner.

Returns:

Minimum value that is allowed for the spinner.

CEGUITextInputMode DigitalSpaces::DICEGUISpinner::getTextInputMode

(

)

Return the current text input / display mode setting.

Returns:

One of the TextInputMode enumerated values indicating the current text input and display mode.

void DigitalSpaces::DICEGUISpinner::setCurrentValue

(

float

value

)

Set the current spinner value.

Parameters:

value

value to be assigned to the Spinner.

Returns:

Nothing.

void DigitalSpaces::DICEGUISpinner::setStepSize

(

float

step

)

Set the current step value.

Parameters:

step

The value added to be the spinner value when the up / down buttons are clicked.

Returns:

Nothing.

void DigitalSpaces::DICEGUISpinner::setMaximumValue

(

float

maxValue

)

Set the spinner maximum value.

Parameters:

maxValue

The maximum value to be allowed by the spinner.

Returns:

Nothing.

void DigitalSpaces::DICEGUISpinner::setMinimumValue

(

float

minVaue

)

Set the spinner minimum value.

Parameters:

minVaue

The minimum value to be allowed by the spinner.

Returns:

Nothing.

void DigitalSpaces::DICEGUISpinner::setTextInputMode

(

CEGUITextInputMode

mode

)

Set the spinner input / display mode.

Parameters:

mode

One of the TextInputMode enumerated values indicating the text input / display mode to be used by the spinner.

Returns:

Nothing.

---

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

• CEGUIInterfaces/CEGUIInterfaces.h