DigitalSpaces::DICEGUISlider Struct Reference
[CEGUI]

#include <CEGUIInterfaces.h>

Detailed Description

{0B65289A-3358-4113-AE2A-FFBF1913A01E}


Public Member Functions
float	GetCurrentValue ()
	return the current slider value.
float	GetMaxValue ()
	return the maximum value set for this widget
float	GetClickStep ()
	return the current click step setting for the slider.
void	setMaxValue (float maxVal)
	set the maximum value for the slider. Note that the minimum value is fixed at 0.
void	setCurrentValue (float value)
	set the current slider value.
void	setClickStep (float step)
	set the current click step setting for the slider.

float DigitalSpaces::DICEGUISlider::GetCurrentValue ( )

return the current slider value.

float DigitalSpaces::DICEGUISlider::GetMaxValue ( )

return the maximum value set for this widget

Returns:: float value equal to the currently set maximum value for this slider.

float DigitalSpaces::DICEGUISlider::GetClickStep ( )

return the current click step setting for the slider.

The click step size is the amount the slider value will be adjusted when the widget is clicked wither side of the slider thumb.

void DigitalSpaces::DICEGUISlider::setMaxValue ( float maxVal )

set the maximum value for the slider. Note that the minimum value is fixed at 0.

Parameters:

maxVal

float value specifying the maximum value for this slider widget.

void DigitalSpaces::DICEGUISlider::setCurrentValue ( float value )

set the current slider value.

Parameters:

value

float value specifying the new value for this slider widget.

void DigitalSpaces::DICEGUISlider::setClickStep ( float step )

set the current click step setting for the slider.

The click step size is the amount the slider value will be adjusted when the widget is clicked wither side of the slider thumb.

Parameters:

step

float value representing the click step setting to use.

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