CEGUI::FalagardScrollbar Class Reference

Scrollbar class for the FalagardBase module. More...

Inheritance diagram for CEGUI::FalagardScrollbar:

Inheritance graph
[legend]
Collaboration diagram for CEGUI::FalagardScrollbar:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 FalagardScrollbar (const String &type)
 type name for this widget.
bool isVertical () const
void setVertical (bool setting)
void render ()
 Populate render cache.
void performChildWindowLayout ()
 Method called to perform extended laying out of the window's attached child windows.

Static Public Attributes

static const utf8 TypeName [] = "Falagard/Scrollbar"

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.
float getAdjustDirectionFromPoint (const Point &pt) const
 Given window location pt, return a value indicating what change should be made to the scroll bar.

Protected Attributes

bool d_vertical
 True if slider operates in vertical direction.

Static Protected Attributes

static
FalagardScrollbarProperties::VerticalScrollbar 
d_verticalProperty


Detailed Description

Scrollbar class for the FalagardBase module.

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

States:

Named Areas:

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:


Constructor & Destructor Documentation

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

type name for this widget.

Constructor

References CEGUI::WindowRenderer::registerProperty().


Member Function Documentation

float CEGUI::FalagardScrollbar::getAdjustDirectionFromPoint ( const Point pt  )  const [protected, virtual]

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

Parameters:
pt Point 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.

References d_vertical, CEGUI::WindowRenderer::d_window, CEGUI::Vector2::d_x, CEGUI::Vector2::d_y, CEGUI::Scrollbar::getThumb(), and CEGUI::Window::getUnclippedPixelRect().

float CEGUI::FalagardScrollbar::getValueFromThumb ( void   )  const [protected, 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.

Implements CEGUI::ScrollbarWindowRenderer.

References CEGUI::Size::d_height, d_vertical, CEGUI::Size::d_width, CEGUI::WindowRenderer::d_window, CEGUI::NamedArea::getArea(), CEGUI::Scrollbar::getDocumentSize(), CEGUI::WindowRenderer::getLookNFeel(), CEGUI::WidgetLookFeel::getNamedArea(), CEGUI::Scrollbar::getPageSize(), CEGUI::ComponentArea::getPixelRect(), CEGUI::Window::getPixelSize(), and CEGUI::Scrollbar::getThumb().

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.

References CEGUI::WindowRenderer::d_window, CEGUI::WindowRenderer::getLookNFeel(), CEGUI::WidgetLookFeel::getStateImagery(), CEGUI::Window::isDisabled(), and CEGUI::StateImagery::render().


Generated on Thu Nov 27 20:34:45 2008 for Crazy Eddies GUI System by  doxygen 1.5.7.1