DigitalSpaces::DICEGUIThumb Struct Reference
[CEGUI]

#include <CEGUIInterfaces.h>

Inherits DigitalSpaces::DIObjectBase.

Public Member Functions
bool	isHotTracked ()
	return whether hot-tracking is enabled or not.
bool	isVertFree ()
	return whether the thumb is movable on the vertical axis.
bool	isHorzFree ()
	return whether the thumb is movable on the horizontal axis.
void	getVertRange (out_Pairf *range)
	Return a std::pair that describes the current range set for the vertical movement.
void	getHorzRange (out_Pairf *range)
	Return a std::pair that describes the current range set for the horizontal movement.
void	setHotTracked (bool setting)
	set whether the thumb uses hot-tracking.
void	setVertFree (bool setting)
	set whether thumb is movable on the vertical axis.
void	setHorzFree (bool setting)
	set whether thumb is movable on the horizontal axis.
void	setVertRange (float min, float max)
	set the movement range of the thumb for the vertical axis.
void	setHorzRange (float min, float max)
	set the movement range of the thumb for the horizontal axis.

---

Member Function Documentation

bool DigitalSpaces::DICEGUIThumb::isHotTracked

(

)

return whether hot-tracking is enabled or not.

Returns:

true if hot-tracking is enabled. false if hot-tracking is disabled.

bool DigitalSpaces::DICEGUIThumb::isVertFree

(

)

return whether the thumb is movable on the vertical axis.

Returns:

true if the thumb is movable along the vertical axis. false if the thumb is fixed on the vertical axis.

bool DigitalSpaces::DICEGUIThumb::isHorzFree

(

)

return whether the thumb is movable on the horizontal axis.

Returns:

true if the thumb is movable along the horizontal axis. false if the thumb is fixed on the horizontal axis.

void DigitalSpaces::DICEGUIThumb::getVertRange

(

out_Pairf *

range

)

Return a std::pair that describes the current range set for the vertical movement.

Returns:

a std::pair describing the current vertical range. The first element is the minimum value, the second element is the maximum value.

void DigitalSpaces::DICEGUIThumb::getHorzRange

(

out_Pairf *

range

)

Return a std::pair that describes the current range set for the horizontal movement.

Returns:

a std::pair describing the current horizontal range. The first element is the minimum value, the second element is the maximum value.

void DigitalSpaces::DICEGUIThumb::setHotTracked

(

bool

setting

)

set whether the thumb uses hot-tracking.

Parameters:

setting

true to enable hot-tracking. false to disable hot-tracking.

Returns:

Nothing.

void DigitalSpaces::DICEGUIThumb::setVertFree

(

bool

setting

)

set whether thumb is movable on the vertical axis.

Parameters:

setting

true to allow movement of thumb along the vertical axis. false to fix thumb on the vertical axis.

Returns:

nothing.

void DigitalSpaces::DICEGUIThumb::setHorzFree

(

bool

setting

)

set whether thumb is movable on the horizontal axis.

Parameters:

setting

true to allow movement of thumb along the horizontal axis. false to fix thumb on the horizontal axis.

Returns:

nothing.

void DigitalSpaces::DICEGUIThumb::setVertRange	(	float	min,
		float	max
	)

set the movement range of the thumb for the vertical axis.

The values specified here are relative to the parent window for the thumb, and are specified in whichever metrics mode is active for the widget.

Parameters:

	min	the minimum setting for the thumb on the vertical axis.
	max	the maximum setting for the thumb on the vertical axis.

Returns:

Nothing.

void DigitalSpaces::DICEGUIThumb::setHorzRange	(	float	min,
		float	max
	)

set the movement range of the thumb for the horizontal axis.

The values specified here are relative to the parent window for the thumb, and are specified in whichever metrics mode is active for the widget.

Parameters:

	min	the minimum setting for the thumb on the horizontal axis.
	max	the maximum setting for the thumb on the horizontal axis.

Returns:

Nothing.

---

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

• CEGUIInterfaces/CEGUIInterfaces.h