Crazy Eddie's GUI System  0.8.3
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
CEGUI::ScrollbarWindowRenderer Class Referenceabstract

Base class for Scrollbar window renderer objects. More...

+ Inheritance diagram for CEGUI::ScrollbarWindowRenderer:
+ Collaboration diagram for CEGUI::ScrollbarWindowRenderer:

Public Member Functions

 ScrollbarWindowRenderer (const String &name)
 
virtual void updateThumb (void)=0
 update the size and location of the thumb to properly represent the current state of the scroll bar
 
virtual float getValueFromThumb (void) const =0
 return value that best represents current scroll bar position given the current location of the thumb. More...
 
virtual float getAdjustDirectionFromPoint (const Vector2f &pt) const =0
 Given window location pt, return a value indicating what change should be made to the scroll bar. More...
 
- Public Member Functions inherited from CEGUI::WindowRenderer
 WindowRenderer (const String &name, const String &class_name="Window")
 Constructor. More...
 
virtual ~WindowRenderer ()
 Destructor.
 
virtual void render ()=0
 Populate render cache. More...
 
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 performChildWindowLayout ()
 Method called to perform extended laying out of the window's attached child windows.
 
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...
 

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.
 
- 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 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.
 

Detailed Description

Base class for Scrollbar window renderer objects.

Member Function Documentation

virtual float CEGUI::ScrollbarWindowRenderer::getAdjustDirectionFromPoint ( const Vector2f pt) const
pure virtual

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.

Implemented in CEGUI::FalagardScrollbar.

virtual float CEGUI::ScrollbarWindowRenderer::getValueFromThumb ( void  ) const
pure virtual

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.

Implemented in CEGUI::FalagardScrollbar.