CEGUI::FalagardTabControl Class Reference

TabControl class for the FalagardBase module. More...

Inheritance diagram for CEGUI::FalagardTabControl:

Collaboration diagram for CEGUI::FalagardTabControl:

Public Member Functions
	FalagardTabControl (const String &type)
	type name for this widget. More...
const String &	getTabButtonType () const
void	setTabButtonType (const String &type)
void	render ()
	Populate render cache. More...
Public Member Functions inherited from CEGUI::TabControlWindowRenderer
	TabControlWindowRenderer (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 Rect	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.

Static Public Attributes
static const utf8	TypeName []

Protected Member Functions
TabButton *	createTabButton (const String &name) const
	create and return a pointer to a TabButton widget for use as a clickable tab header More...

Protected Attributes
String	d_tabButtonType

Static Protected Attributes
static FalagardTabControlProperties::TabButtonType	d_tabButtonTypeProperty

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 >	PropertyList
	type to use for the property list.

Detailed Description

TabControl class for the FalagardBase module.

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

States:
    - Enabled
    - Disabled

Child Widgets:
    TabPane based widget with name suffix "__auto_TabPane__"
    optional: DefaultWindow to contain tab buttons with name suffix "__auto_TabPane__Buttons"

Property initialiser definitions:
    - TabButtonType - specifies a TabButton based widget type to be
      created each time a new tab button is required.

Note

The current TabControl base class enforces a strict layout, so while imagery can be customised as desired, the general layout of the component widgets is, at least for the time being, fixed.

Constructor & Destructor Documentation

CEGUI::FalagardTabControl::FalagardTabControl

(

const String &

type

)

type name for this widget.

Constructor

Member Function Documentation

TabButton* CEGUI::FalagardTabControl::createTabButton ( const String &  name ) const

protectedvirtual

create and return a pointer to a TabButton widget for use as a clickable tab header

Parameters

name	Button name

Returns

Pointer to a TabButton to be used for changing tabs.

Implements CEGUI::TabControlWindowRenderer.

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