GUI::Thumb Class Reference

Base class for Thumb widget. More...

Inherits GUI::PushButton.

List of all members.

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.
Vector2	getVertRange ()
	Return a Vector2 that describes the current range set for the vertical movement.
Vector2	getHorzRange ()
	Return a Vector2 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.

---

Detailed Description

Base class for Thumb widget.

The thumb widget is used to compose other widgets (like sliders and scroll bars). You would not normally need to use this widget directly unless you are making a new widget of some type.

---

Member Function Documentation

bool GUI::Thumb::isHotTracked

(

)

return whether hot-tracking is enabled or not.

Returns:

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

bool GUI::Thumb::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 GUI::Thumb::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.

Vector2 GUI::Thumb::getVertRange

(

)

Return a Vector2 that describes the current range set for the vertical movement.

Returns:

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

Vector2 GUI::Thumb::getHorzRange

(

)

Return a Vector2 that describes the current range set for the horizontal movement.

Returns:

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

void GUI::Thumb::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 GUI::Thumb::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 GUI::Thumb::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 GUI::Thumb::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 GUI::Thumb::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.