Public Member Functions | |
float | getCurrentValue (void) const |
return the current slider value. | |
float | getMaxValue (void) const |
return the maximum value set for this widget | |
float | getClickStep (void) const |
return the current click step setting for the slider. | |
Thumb * | getThumb () const |
Return a pointer to the Thumb component widget for this Slider. | |
virtual void | initialiseComponents (void) |
Initialises the Window based object ready for use. | |
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. | |
Slider (const String &type, const String &name) | |
Slider base class constructor. | |
virtual | ~Slider (void) |
Slider base class destructor. | |
Static Public Attributes | |
static const String | EventNamespace |
Namespace for global events. | |
static const String | WidgetTypeName |
Window factory name. | |
static const String | EventValueChanged |
Event fired when the slider value changes. | |
static const String | EventThumbTrackStarted |
Name of the event fired when the user begins dragging the thumb. | |
static const String | EventThumbTrackEnded |
Name of the event fired when the user releases the thumb. | |
static const String | ThumbNameSuffix |
Widget name suffix for the thumb component. | |
Protected Member Functions | |
virtual void | updateThumb (void) |
update the size and location of the thumb to properly represent the current state of the slider | |
virtual float | getValueFromThumb (void) const |
return value that best represents current slider value given the current location of the thumb. | |
virtual float | getAdjustDirectionFromPoint (const Point &pt) const |
Given window location pt, return a value indicating what change should be made to the slider. | |
bool | handleThumbMoved (const EventArgs &e) |
update the size and location of the thumb to properly represent the current state of the slider | |
bool | handleThumbTrackStarted (const EventArgs &e) |
handler function for when thumb tracking begins | |
bool | handleThumbTrackEnded (const EventArgs &e) |
handler function for when thumb tracking begins | |
virtual bool | testClassName_impl (const String &class_name) const |
Return whether this window was inherited from the given class name at some point in the inheritance hierarchy. | |
virtual bool | validateWindowRenderer (const String &name) const |
Function used in checking if a WindowRenderer is valid for this window. | |
virtual void | onValueChanged (WindowEventArgs &e) |
Handler triggered when the slider value changes. | |
virtual void | onThumbTrackStarted (WindowEventArgs &e) |
Handler triggered when the user begins to drag the slider thumb. | |
virtual void | onThumbTrackEnded (WindowEventArgs &e) |
Handler triggered when the slider thumb is released. | |
virtual void | onMouseButtonDown (MouseEventArgs &e) |
Handler called when a mouse button has been depressed within this window's area. | |
virtual void | onMouseWheel (MouseEventArgs &e) |
Handler called when the mouse wheel (z-axis) position changes within this window's area. | |
Protected Attributes | |
float | d_value |
current slider value | |
float | d_maxValue |
slider maximum value (minimum is fixed at 0) | |
float | d_step |
amount to adjust slider by when clicked (and not dragged). |
The slider widget has a default range of 0.0f - 1.0f. This enables use of the slider value to scale any value needed by way of a simple multiplication.
float CEGUI::Slider::getAdjustDirectionFromPoint | ( | const Point & | pt | ) | const [protected, virtual] |
Given window location pt, return a value indicating what change should be made to the slider.
pt | Point object describing a pixel position in window space. |
References CEGUI::Window::d_windowRenderer, and CEGUI::SliderWindowRenderer::getAdjustDirectionFromPoint().
Referenced by onMouseButtonDown().
float CEGUI::Slider::getClickStep | ( | void | ) | const [inline] |
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.
float CEGUI::Slider::getCurrentValue | ( | void | ) | const [inline] |
return the current slider value.
Referenced by CEGUI::FalagardSlider::updateThumb().
float CEGUI::Slider::getMaxValue | ( | void | ) | const [inline] |
return the maximum value set for this widget
Referenced by CEGUI::FalagardSlider::getValueFromThumb(), and CEGUI::FalagardSlider::updateThumb().
Thumb * CEGUI::Slider::getThumb | ( | ) | const |
Return a pointer to the Thumb component widget for this Slider.
UnknownObjectException | Thrown if the Thumb component does not exist. |
References CEGUI::Window::getName(), and ThumbNameSuffix.
Referenced by CEGUI::FalagardSlider::getAdjustDirectionFromPoint(), CEGUI::FalagardSlider::getValueFromThumb(), initialiseComponents(), and CEGUI::FalagardSlider::updateThumb().
float CEGUI::Slider::getValueFromThumb | ( | void | ) | const [protected, virtual] |
return value that best represents current slider value given the current location of the thumb.
References CEGUI::Window::d_windowRenderer, and CEGUI::SliderWindowRenderer::getValueFromThumb().
Referenced by handleThumbMoved().
bool CEGUI::Slider::handleThumbMoved | ( | const EventArgs & | e | ) | [protected] |
update the size and location of the thumb to properly represent the current state of the slider
return value that best represents current slider value given the current location of the thumb.
pt | Point object describing a pixel position in window space. |
References getValueFromThumb(), and setCurrentValue().
Referenced by initialiseComponents().
void CEGUI::Slider::initialiseComponents | ( | void | ) | [virtual] |
Initialises the Window based object ready for use.
Reimplemented from CEGUI::Window.
References CEGUI::Thumb::EventThumbPositionChanged, CEGUI::Thumb::EventThumbTrackEnded, CEGUI::Thumb::EventThumbTrackStarted, getThumb(), handleThumbMoved(), handleThumbTrackEnded(), handleThumbTrackStarted(), CEGUI::Window::performChildWindowLayout(), and CEGUI::EventSet::subscribeEvent().
void CEGUI::Slider::onMouseButtonDown | ( | MouseEventArgs & | e | ) | [protected, virtual] |
Handler called when a mouse button has been depressed within this window's area.
e | MouseEventArgs object. All fields are valid. |
Reimplemented from CEGUI::Window.
References CEGUI::MouseEventArgs::button, d_step, d_value, getAdjustDirectionFromPoint(), CEGUI::EventArgs::handled, CEGUI::LeftButton, CEGUI::MouseEventArgs::position, and setCurrentValue().
void CEGUI::Slider::onMouseWheel | ( | MouseEventArgs & | e | ) | [protected, virtual] |
Handler called when the mouse wheel (z-axis) position changes within this window's area.
e | MouseEventArgs object. All fields are valid. |
Reimplemented from CEGUI::Window.
References d_step, d_value, CEGUI::EventArgs::handled, setCurrentValue(), and CEGUI::MouseEventArgs::wheelChange.
void CEGUI::Slider::setClickStep | ( | float | step | ) | [inline] |
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.
step | float value representing the click step setting to use. |
void CEGUI::Slider::setCurrentValue | ( | float | value | ) |
set the current slider value.
value | float value specifying the new value for this slider widget. |
References d_maxValue, d_value, onValueChanged(), and updateThumb().
Referenced by handleThumbMoved(), onMouseButtonDown(), and onMouseWheel().
void CEGUI::Slider::setMaxValue | ( | float | maxVal | ) |
set the maximum value for the slider. Note that the minimum value is fixed at 0.
maxVal | float value specifying the maximum value for this slider widget. |
References d_maxValue, d_value, onValueChanged(), and updateThumb().
virtual bool CEGUI::Slider::testClassName_impl | ( | const String & | class_name | ) | const [inline, protected, virtual] |
Return whether this window was inherited from the given class name at some point in the inheritance hierarchy.
class_name | The class name that is to be checked. |
Reimplemented from CEGUI::Window.
References CEGUI::Window::testClassName_impl().
virtual bool CEGUI::Slider::validateWindowRenderer | ( | const String & | name | ) | const [inline, protected, virtual] |
Function used in checking if a WindowRenderer is valid for this window.
Reimplemented from CEGUI::Window.