om::graphics::gui::objects::TabView::Delegate Class Reference

A class that contains function objects that recieve TabView events. More...

#include <omGraphicsGUITabView.h>

Public Attributes
Function< Bool(TabView &, Index)>	selectTab
	A function object that is called whenever the selected tab of a TabView is changed. More...
Function< void(TabView &, Index)>	deselectTab
	A function object that is called whenever a tab of a TabView is deselected. More...
Function< Bool(TabView &, Index tabIndex)>	closeTab
	A function object that is called whenever a tab of a TabView wants to be closed by the user. More...
Function< void(TabView &, Index userID)>	closedTab
	A function object that is called after a tab of a TabView is closed. More...
UserData	data
	An object that stores an opaque pointer to delegate data. More...

Detailed Description

A class that contains function objects that recieve TabView events.

Any content-view-related event that might be processed has an appropriate callback function object. Each callback function is called by the tab view whenever such an event is received. If a callback function in the delegate is not initialized, a tab view ignores it.

Member Data Documentation

Function<Bool ( TabView&, Index )> om::graphics::gui::objects::TabView::Delegate::selectTab

A function object that is called whenever the selected tab of a TabView is changed.

The delegate function may choose to return either a value of TRUE, indicating that the change in tab is allowed, or a value of FALSE, indicating that the tab change should be ignored.

The TabView provides the index of the tab that was selected.

Function<void ( TabView&, Index )> om::graphics::gui::objects::TabView::Delegate::deselectTab

A function object that is called whenever a tab of a TabView is deselected.

The TabView provides the index of the tab that was deselected.

Function<Bool ( TabView&, Index tabIndex )> om::graphics::gui::objects::TabView::Delegate::closeTab

A function object that is called whenever a tab of a TabView wants to be closed by the user.

The TabView provides the index of the tab that was closed. The delegate returns whether or not the tab should be closed.

Function<void ( TabView&, Index userID )> om::graphics::gui::objects::TabView::Delegate::closedTab

A function object that is called after a tab of a TabView is closed.

The TabView provides the user ID of the tab that was closed.

UserData om::graphics::gui::objects::TabView::Delegate::data

An object that stores an opaque pointer to delegate data.

---

The documentation for this class was generated from the following file:

• omGraphicsGUITabView.h