Inheritance diagram for CEGUI::TabControl:
Public Member Functions | ||||
uint | getTabCount (void) const | |||
Return number of tabs. | ||||
void | setSelectedTab (const String &name) | |||
Set the selected tab by the name of the root window within it.
| ||||
void | setSelectedTab (uint ID) | |||
Set the selected tab by the ID of the root window within it.
| ||||
void | setSelectedTabAtIndex (uint index) | |||
Set the selected tab by the index position in the tab control.
| ||||
Window * | getTabContentsAtIndex (uint index) const | |||
Return the Window which is the first child of the tab at index position index. | ||||
Window * | getTabContents (const String &name) const | |||
Return the Window which is the tab content with the given name. | ||||
Window * | getTabContents (uint ID) const | |||
Return the Window which is the tab content with the given ID. | ||||
bool | isTabContentsSelected (Window *wnd) const | |||
Return whether the tab contents window is currently selected. | ||||
uint | getSelectedTabIndex () const | |||
Return the index of the currently selected tab. | ||||
float | getRelativeTabHeight (void) const | |||
Return the relative height of the tabs. | ||||
float | getAbsoluteTabHeight (void) const | |||
Return the absolute height of the tabs. | ||||
float | getTabHeight (void) const | |||
Return the height of the tabs in the current metrics mode. | ||||
float | getTabTextPadding (void) const | |||
Return the amount of padding to add either side of the text in the tab, according to the current metrics mode. | ||||
float | getRelativeTabTextPadding (void) const | |||
Return the relative amount of padding to add either side of the text in the tab. | ||||
float | getAbsoluteTabTextPadding (void) const | |||
Return the absolute amount of padding to add either side of the text in the tab. | ||||
virtual void | initialise (void) | |||
Initialise the Window based object ready for use. | ||||
void | setRelativeTabHeight (float height) | |||
Set the relative height of the tabs. | ||||
void | setAbsoluteTabHeight (float height) | |||
Set the absolute height of the tabs. | ||||
void | setTabHeight (float height) | |||
Set the height of the tabs in the current metrics mode. | ||||
void | setTabTextPadding (float) | |||
Set the amount of padding to add either side of the text in the tab, according to the current metrics mode. | ||||
void | setRelativeTabTextPadding (float) | |||
Set the relative amount of padding to add either side of the text in the tab. | ||||
void | setAbsoluteTabTextPadding (float) | |||
Set the absolute amount of padding to add either side of the text in the tab. | ||||
void | addTab (Window *wnd) | |||
Add a new tab to the tab control. | ||||
void | removeTab (const String &name) | |||
Remove the named tab from the tab control. | ||||
void | removeTab (uint ID) | |||
Remove the tab with the given ID from the tab control. | ||||
TabControl (const String &type, const String &name) | ||||
Constructor for TabControl base class. | ||||
virtual | ~TabControl (void) | |||
Destructor for Listbox base class. | ||||
Static Public Attributes | ||||
static const String | EventNamespace | |||
Namespace for global events. | ||||
static const String | EventSelectionChanged | |||
Event triggered when there is a change to the currently selected tab. | ||||
Protected Types | ||||
typedef std::map< uint, TabButton * > | TabButtonIndexMap | |||
Protected Member Functions | ||||
virtual void | drawSelf (float z) | |||
Perform the actual rendering for this Window. | ||||
void | addTabControlEvents (void) | |||
Add tab control specific events. | ||||
virtual void | addButtonForTabContent (Window *wnd) | |||
Add a TabButton for the specified child Window. | ||||
virtual void | removeButtonForTabContent (Window *wnd) | |||
Remove the TabButton for the specified child Window. | ||||
TabButton * | getButtonForTabContents (Window *wnd) const | |||
Return the TabButton associated with this Window.
| ||||
String | makeButtonName (Window *wnd) | |||
Construct a button name to handle a window. | ||||
virtual void | selectTab_impl (Window *wnd) | |||
Internal implementation of select tab. | ||||
virtual bool | testClassName_impl (const String &class_name) const | |||
Return whether this window was inherited from the given class name at some point in the inheritance heirarchy. | ||||
void | performChildWindowLayout () | |||
method called to perform extended laying out of attached child windows. | ||||
int | writeChildWindowsXML (OutStream &out_stream) const | |||
virtual void | onSelectionChanged (WindowEventArgs &e) | |||
Handler called internally when the currently selected item or items changes. | ||||
virtual void | onFontChanged (WindowEventArgs &e) | |||
Handler called when the window's font is changed. | ||||
virtual TabPane * | createTabContentPane (const String &name) const =0 | |||
create and return a pointer to a TabPane widget for use as content area | ||||
virtual Window * | createTabButtonPane (const String &name) const | |||
create and return a pointer to a widget for use as tab button area | ||||
virtual TabButton * | createTabButton (const String &name) const =0 | |||
create and return a pointer to a TabButton widget for use as a clickable tab header | ||||
void | calculateTabButtonSizePosition (TabButton *btn, uint targetIndex) | |||
Calculate the correct position and size of a tab button, based on the index it is due to be placed at. | ||||
void | addTabControlProperties (void) | |||
void | addChild_impl (Window *wnd) | |||
Add given window to child list at an appropriate position. | ||||
void | removeChild_impl (Window *wnd) | |||
Remove given window from child list. | ||||
bool | handleContentWindowTextChanged (const EventArgs &args) | |||
bool | handleTabButtonClicked (const EventArgs &args) | |||
Protected Attributes | ||||
Window * | d_tabButtonPane | |||
The area containing the tab buttons. | ||||
TabPane * | d_tabContentPane | |||
The content area window. | ||||
float | d_abs_tabHeight | |||
The height of the tabs in pixels. | ||||
float | d_rel_tabHeight | |||
The height of the tabs relative to parent. | ||||
float | d_abs_tabPadding | |||
The padding of the tabs in pixels. | ||||
float | d_rel_tabPadding | |||
The padding of the tabs relative to parent. | ||||
uint | d_nextTabIndex | |||
The index to give the next tab. | ||||
TabButtonIndexMap | d_tabButtonIndexMap | |||
Sorting for tabs. | ||||
Static Protected Attributes | ||||
static TabControlProperties::TabHeight | d_tabHeightProperty | |||
static TabControlProperties::AbsoluteTabHeight | d_absoluteTabHeightProperty | |||
static TabControlProperties::RelativeTabHeight | d_relativeTabHeightProperty | |||
static TabControlProperties::TabTextPadding | d_tabTextPaddingProperty | |||
static TabControlProperties::AbsoluteTabTextPadding | d_absoluteTabTextPaddingProperty | |||
static TabControlProperties::RelativeTabTextPadding | d_relativeTabTextPaddingProperty |
|
Add a new tab to the tab control.
|
|
Calculate the correct position and size of a tab button, based on the index it is due to be placed at.
|
|
create and return a pointer to a TabButton widget for use as a clickable tab header
|
|
create and return a pointer to a widget for use as tab button area
|
|
create and return a pointer to a TabPane widget for use as content area
|
|
Perform the actual rendering for this Window.
Reimplemented from CEGUI::Window. |
|
Return the index of the currently selected tab.
|
|
Return the Window which is the tab content with the given ID.
|
|
Return the Window which is the tab content with the given name.
|
|
Return the Window which is the first child of the tab at index position index.
|
|
Return number of tabs.
|
|
Initialise the Window based object ready for use.
Reimplemented from CEGUI::Window. |
|
Return whether the tab contents window is currently selected.
|
|
Handler called when the window's font is changed.
Reimplemented from CEGUI::Window. |
|
method called to perform extended laying out of attached child windows. The system may call this at various times (like when it is resized for example), and it may be invoked directly where required.
Reimplemented from CEGUI::Window. |
|
Remove the tab with the given ID from the tab control.
|
|
Remove the named tab from the tab control.
|
|
Internal implementation of select tab.
|
|
Return whether this window was inherited from the given class name at some point in the inheritance heirarchy.
Reimplemented from CEGUI::Window. |