Crazy Eddie's GUI System  0.8.6
CEGUI::FalagardSlider Class Reference

Slider class for the FalagardBase module. More...

+ Inheritance diagram for CEGUI::FalagardSlider:
+ Collaboration diagram for CEGUI::FalagardSlider:

Public Member Functions

 FalagardSlider (const String &type)
 type name for this widget. More...
 
bool isVertical () const
 
void setVertical (bool setting)
 
bool isReversedDirection () const
 
void setReversedDirection (bool setting)
 
void render ()
 Populate render cache. More...
 
void performChildWindowLayout ()
 Method called to perform extended laying out of the window's attached child windows.
 
- Public Member Functions inherited from CEGUI::SliderWindowRenderer
 SliderWindowRenderer (const String &name)
 Constructor.
 
- Public Member Functions inherited from CEGUI::WindowRenderer
 WindowRenderer (const String &name, const String &class_name="Window")
 Constructor. More...
 
virtual ~WindowRenderer ()
 Destructor.
 
const StringgetName () const
 Returns the factory type name of this window renderer.
 
WindowgetWindow () const
 Get the window this windowrenderer is attached to.
 
const StringgetClass () const
 Get the "minimum" Window class this renderer requires.
 
const WidgetLookFeelgetLookNFeel () const
 Get the Look'N'Feel assigned to our window.
 
virtual Rectf getUnclippedInnerRect () const
 Get unclipped inner rectangle that our window should return from its member function with the same name.
 
virtual void getRenderingContext (RenderingContext &ctx) const
 update the RenderingContext as needed for our window. This is normally invoked via our window's member function with the same name.
 
virtual void update (float)
 perform any time based updates for this WindowRenderer.
 
virtual bool handleFontRenderSizeChange (const Font *const font)
 Perform any updates needed because the given font's render size has changed. More...
 

Static Public Attributes

static const String TypeName
 

Protected Member Functions

void updateThumb (void)
 update the size and location of the thumb to properly represent the current state of the slider
 
float getValueFromThumb (void) const
 return value that best represents current slider value given the current location of the thumb. More...
 
float getAdjustDirectionFromPoint (const Vector2f &pt) const
 Given window location pt, return a value indicating what change should be made to the slider. More...
 
- Protected Member Functions inherited from CEGUI::WindowRenderer
void registerProperty (Property *property, const bool ban_from_xml)
 Register a property class that will be properly managed by this window renderer. More...
 
void registerProperty (Property *property)
 Register a property class that will be properly managed by this window renderer. More...
 
virtual void onAttach ()
 Handler called when this windowrenderer is attached to a window.
 
virtual void onDetach ()
 Handler called when this windowrenderer is detached from its window.
 
virtual void onLookNFeelAssigned ()
 Handler called when a Look'N'Feel is assigned to our window.
 
virtual void onLookNFeelUnassigned ()
 Handler called when a Look'N'Feel is removed/unassigned from our window.
 

Protected Attributes

bool d_vertical
 True if slider operates in vertical direction.
 
bool d_reversed
 true if slider operates in reversed direction to 'normal'.
 
- Protected Attributes inherited from CEGUI::WindowRenderer
Windowd_window
 Pointer to the window this windowrenderer is assigned to.
 
const String d_name
 Name of the factory type used to create this window renderer.
 
const String d_class
 Name of the widget class that is the "minimum" requirement.
 
PropertyList d_properties
 The list of properties that this windowrenderer will be handling.
 

Additional Inherited Members

- Protected Types inherited from CEGUI::WindowRenderer
typedef std::pair< Property *, bool > PropertyEntry
 type used for entries in the PropertyList.
 
typedef std::vector< PropertyEntry CEGUI_VECTOR_ALLOC(PropertyEntry)> PropertyList
 type to use for the property list.
 

Detailed Description

Slider class for the FalagardBase module.

This class requires LookNFeel to be assigned. The LookNFeel should provide the following:

States:

  • Enabled
  • Disabled

Named Areas:

  • ThumbTrackArea

Child Widgets: Thumb based widget with name suffix "__auto_thumb__"

Property initialiser definitions:

  • VerticalSlider - boolean property. Indicates whether this slider will operate in the vertical or horizontal direction. Default is for horizontal. Optional.

Constructor & Destructor Documentation

CEGUI::FalagardSlider::FalagardSlider ( const String type)

type name for this widget.

Constructor

Member Function Documentation

float CEGUI::FalagardSlider::getAdjustDirectionFromPoint ( const Vector2f pt) const
protectedvirtual

Given window location pt, return a value indicating what change should be made to the slider.

Parameters
ptPoint object describing a pixel position in window space.
Returns
  • -1 to indicate slider should be moved to a lower setting.
  • 0 to indicate slider should not be moved.
  • +1 to indicate slider should be moved to a higher setting.

Implements CEGUI::SliderWindowRenderer.

float CEGUI::FalagardSlider::getValueFromThumb ( void  ) const
protectedvirtual

return value that best represents current slider value given the current location of the thumb.

Returns
float value that, given the thumb widget position, best represents the current value for the slider.

Implements CEGUI::SliderWindowRenderer.

void CEGUI::FalagardSlider::render ( )
virtual

Populate render cache.

This method must be implemented by all window renderers and should perform the rendering operations needed for this widget. Normally using the Falagard API...

Implements CEGUI::WindowRenderer.