 |
Om
1.0.0
A universal framework for multimedia simulation
|
A class that represents a single page from a TabView and its attributes. More...
#include <omGUITabViewPage.h>
Classes | |
| class | Delegate |
| A class that contains function objects that recieve tab view page events. More... | |
Public Member Functions | |
| TabViewPage () | |
| Create a new tab view page with no name or view. More... | |
| TabViewPage (const UTF8String &name) | |
| Create a new tab view page with the specified name string and no view. More... | |
| TabViewPage (const UTF8String &name, View *view) | |
| Create a new tab view page which uses the specified view as a subview. More... | |
| ~TabViewPage () | |
| Destroy a tab view page and release all internal state. More... | |
| Bool | hasView () const |
| Return whether or not this tab view page has a child view associated with it. More... | |
| View * | getView () const |
| Return a pointer to the child view associated with this tab view page. More... | |
| Bool | setView (View *newSubview) |
| Set the child view which should be associated with this tab view page. More... | |
| void | removeView () |
| Remove any child view that was associated with this tab view page. More... | |
| UTF8String | getName () const |
| Return a string representing the name of this tab view page. More... | |
| Bool | setName (const UTF8String &newName) |
| Set a string that specifies a new name for this tab view page. More... | |
| Bool | getIsEnabled () const |
| Return whether or not this tab view page is currently able to be selected by the user. More... | |
| Bool | setIsEnabled (Bool newIsEnabled) |
| Set whether or not this tab view page should be able to be selected by the user. More... | |
| Bool | getIsSelected () const |
| Return whether or not this tab view page is currently selected by the user within the parent view. More... | |
| const Delegate & | getDelegate () const |
| Return a reference to the delegate object associated with this tab view page. More... | |
| void | setDelegate (const Delegate &delegate) |
| Set the delegate object to which this tab view page sends events. More... | |
| TabView * | getParentView () const |
| Return a pointer to the view that this tab view page belongs to. More... | |
| Bool | hasParentView () const |
| Return whether or not this tab view page is part of a view. More... | |
| virtual void * | getInternalPointer () const |
| Get a pointer to this tab view page's platform-specific internal representation. More... | |
 Public Member Functions inherited from om::gui::objects::GUIObject | |
| virtual | ~GUIObject () |
| Destroy a GUI element and release all resources associated with it. More... | |
A class that represents a single page from a TabView and its attributes.
| om::gui::objects::TabViewPage::TabViewPage | ( | ) |
Create a new tab view page with no name or view.
| om::gui::objects::TabViewPage::TabViewPage | ( | const UTF8String & | name | ) |
Create a new tab view page with the specified name string and no view.
| om::gui::objects::TabViewPage::TabViewPage | ( | const UTF8String & | name, |
| View * | view | ||
| ) |
Create a new tab view page which uses the specified view as a subview.
| om::gui::objects::TabViewPage::~TabViewPage | ( | ) |
Destroy a tab view page and release all internal state.
The destructor for a tab view page should not be called until it is not being used as part of any active GUI.
| Bool om::gui::objects::TabViewPage::hasView | ( | ) | const |
Return whether or not this tab view page has a child view associated with it.
This method always returns FALSE is this tab view page is a separator or a normal tab view page.
| View* om::gui::objects::TabViewPage::getView | ( | ) | const |
Return a pointer to the child view associated with this tab view page.
If there is no such view a NULL pointer is returned.
Set the child view which should be associated with this tab view page.
If the specified view pointer is NULL, this has the effect of clearing any existing child view from this tab view page. The method returns whether or not the view set operation was successful.
| void om::gui::objects::TabViewPage::removeView | ( | ) |
Remove any child view that was associated with this tab view page.
| UTF8String om::gui::objects::TabViewPage::getName | ( | ) | const |
Return a string representing the name of this tab view page.
| Bool om::gui::objects::TabViewPage::setName | ( | const UTF8String & | newName | ) |
Set a string that specifies a new name for this tab view page.
If the name change operation is not successful, FALSE is returned. Otherwise, the name of the tab view page is changed and TRUE is returned.
| Bool om::gui::objects::TabViewPage::getIsEnabled | ( | ) | const |
Return whether or not this tab view page is currently able to be selected by the user.
Set whether or not this tab view page should be able to be selected by the user.
The method returns whether or not the state of the tab view page was able to be changed.
| Bool om::gui::objects::TabViewPage::getIsSelected | ( | ) | const |
Return whether or not this tab view page is currently selected by the user within the parent view.
| const Delegate& om::gui::objects::TabViewPage::getDelegate | ( | ) | const |
Return a reference to the delegate object associated with this tab view page.
| void om::gui::objects::TabViewPage::setDelegate | ( | const Delegate & | delegate | ) |
Set the delegate object to which this tab view page sends events.
| TabView* om::gui::objects::TabViewPage::getParentView | ( | ) | const |
Return a pointer to the view that this tab view page belongs to.
This method returns a NULL pointer if the tab view page doesn't have a parent view. Use the hasParentMenu() function to detect if the tab view page has a parent view.
| Bool om::gui::objects::TabViewPage::hasParentView | ( | ) | const |
Return whether or not this tab view page is part of a view.
|
virtual |
Get a pointer to this tab view page's platform-specific internal representation.
On Mac OS X, this method returns a pointer to a subclass of NSTabViewItem which represents the tab view page.
On Windows, this method returns
Implements om::gui::objects::GUIObject.
1.8.11
