CEGUI::FalagardScrollablePane Class Reference

ScrollablePane class for the FalagardBase module. More...

Inheritance diagram for CEGUI::FalagardScrollablePane:

Collaboration diagram for CEGUI::FalagardScrollablePane:

Public Member Functions
	FalagardScrollablePane (const String &type)
	type name for this widget. More...
void	render ()
	Populate render cache. More...
Rectf	getViewableArea (void) const
	Return a Rect that described the pane's viewable area, relative to this Window, in pixels. More...
Rectf	getUnclippedInnerRect () const
	Get unclipped inner rectangle that our window should return from its member function with the same name.
Public Member Functions inherited from CEGUI::ScrollablePaneWindowRenderer
	ScrollablePaneWindowRenderer (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 String &	getName () const
	Returns the factory type name of this window renderer.
Window *	getWindow () const
	Get the window this windowrenderer is attached to.
const String &	getClass () const
	Get the "minimum" Window class this renderer requires.
const WidgetLookFeel &	getLookNFeel () const
	Get the Look'N'Feel assigned to our window.
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...

Static Public Attributes
static const String	TypeName

Protected Member Functions
void	onLookNFeelAssigned ()
	Handler called when a Look'N'Feel is assigned to our window.
void	onLookNFeelUnassigned ()
	Handler called when a Look'N'Feel is removed/unassigned from our window.

Protected Attributes
bool	d_widgetLookAssigned
	flag whether target window has looknfeel assigned yet.

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

ScrollablePane class for the FalagardBase module.

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

States:

• Enabled
• Disabled

Named Areas:

• ViewableArea - area where content will be drawn when no scrollbars are visible.
• ViewableAreaHScroll - area where content will be drawn when the horizontal scrollbar is visible.
• ViewableAreaVScroll - area where content will be drawn when the vertical scrollbar is visible.
• ViewableAreaHVScroll - area where content will be drawn when both scrollbars are visible.

Child Widgets: Scrollbar based widget with name suffix "__auto_vscrollbar__" Scrollbar based widget with name suffix "__auto_hscrollbar__"

Constructor & Destructor Documentation

CEGUI::FalagardScrollablePane::FalagardScrollablePane

(

const String &

type

)

type name for this widget.

Constructor

Member Function Documentation

Rectf CEGUI::FalagardScrollablePane::getViewableArea ( void  ) const

virtual

Return a Rect that described the pane's viewable area, relative to this Window, in pixels.

Returns

Rect object describing the ScrollablePane's viewable area.

Implements CEGUI::ScrollablePaneWindowRenderer.

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