Crazy Eddie's GUI System  0.8.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
CEGUI::FalagardScrollbar Class Reference

Scrollbar class for the FalagardBase module. More...

+ Inheritance diagram for CEGUI::FalagardScrollbar:
+ Collaboration diagram for CEGUI::FalagardScrollbar:

Public Member Functions

 FalagardScrollbar (const String &type)
 type name for this widget. More...
 
bool isVertical () const
 
void setVertical (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::ScrollbarWindowRenderer
 ScrollbarWindowRenderer (const String &name)
 
- 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 scroll bar
 
float getValueFromThumb (void) const
 return value that best represents current scroll bar position 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 scroll bar. More...
 

Protected Attributes

bool d_vertical
 True if slider operates in vertical direction.
 

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

Scrollbar 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__" PushButton based widget with name suffix "__auto_incbtn__" PushButton based widget with name suffix "__auto_decbtn__"

Property initialiser definitions:

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

Constructor & Destructor Documentation

CEGUI::FalagardScrollbar::FalagardScrollbar ( const String type)

type name for this widget.

Constructor

Member Function Documentation

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

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

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

Implements CEGUI::ScrollbarWindowRenderer.

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

return value that best represents current scroll bar position given the current location of the thumb.

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

Implements CEGUI::ScrollbarWindowRenderer.

void CEGUI::FalagardScrollbar::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.