|
NX Open C++ Reference Guide
|
Represents an interface to manage Resource Bar tabs. More...
Public Types | |
| typedef NXOpen::Callback1< int, int > | ActivationCallback |
| Prototype for the callback used to activate a tab page. More... | |
Public Member Functions | |
| void | ActivateTab (int tabId) |
| Activate the resource bar tab. More... | |
| int | Create (const NXString &tabTitle, const NXString &tabIcon) |
| Create a tab by registering the tab data. More... | |
| int | Create (const char *tabTitle, const char *tabIcon) |
| Create a tab by registering the tab data. More... | |
| void | Destroy (int tabId) |
| Remove and destroy the tab asscociated with the given tab id from the resource bar area. More... | |
| NXOpen::WindowHandle * | GetWindowHandle (int tabId) |
| Return a NX docking window associated with the given tab id. More... | |
| int | RegisterActivationCallback (int tabId, const NXOpen::ResourceBarManager::ActivationCallback &activateTabCb) |
| Register a callback which will be called whenever a custom tab is about to be activated. More... | |
| void | SetTabVisibility (int tabId, bool visible) |
| Set the visibility of the tab in the resource bar area. More... | |
| tag_t | Tag () const |
| Returns the tag of this object. More... | |
Represents an interface to manage Resource Bar tabs.
The class can be used to create new tabs and manage the visibility and activation state of these tabs on the Resource Bar.
To obtain an instance of this class, refer to NXOpen::UI
Usable only on Windows
Created in NX10.0.0.
| typedef NXOpen::Callback1<int, int> NXOpen::ResourceBarManager::ActivationCallback |
Prototype for the callback used to activate a tab page.
Created in NX10.0.0.
License requirements : None
| void NXOpen::ResourceBarManager::ActivateTab | ( | int | tabId | ) |
Activate the resource bar tab.
Created in NX10.0.0.
License requirements : None
| tabId | The unique tab id |
Create a tab by registering the tab data.
The new tab will show up right away if the Resource Bar is currently visible.
| tabTitle | Tab title. This title will be displayed in tooltip as well |
| tabIcon | Tab bitmap. User can specify a NX bitmap or a new bitmap with path |
| int NXOpen::ResourceBarManager::Create | ( | const char * | tabTitle, |
| const char * | tabIcon | ||
| ) |
Create a tab by registering the tab data.
The new tab will show up right away if the Resource Bar is currently visible.
| tabTitle | Tab title. This title will be displayed in tooltip as well |
| tabIcon | Tab bitmap. User can specify a NX bitmap or a new bitmap with path |
| void NXOpen::ResourceBarManager::Destroy | ( | int | tabId | ) |
Remove and destroy the tab asscociated with the given tab id from the resource bar area.
Created in NX10.0.0.
License requirements : None
| tabId | The unique tab id |
| NXOpen::WindowHandle* NXOpen::ResourceBarManager::GetWindowHandle | ( | int | tabId | ) |
Return a NX docking window associated with the given tab id.
The docking window will be created only when the custom tab is being activated. Applications can use the docking window as the parent window to host their child window in resource bar area. Applications should create a child window as a container since it extends to the maximum bounds of the docking window.
| tabId | The unique tab id |
| int NXOpen::ResourceBarManager::RegisterActivationCallback | ( | int | tabId, |
| const NXOpen::ResourceBarManager::ActivationCallback & | activateTabCb | ||
| ) |
Register a callback which will be called whenever a custom tab is about to be activated.
| tabId | A unigue tab id identifying the callback |
| activateTabCb | Callback to register |
| void NXOpen::ResourceBarManager::SetTabVisibility | ( | int | tabId, |
| bool | visible | ||
| ) |
Set the visibility of the tab in the resource bar area.
The tab is visible by default when it gets created.
Created in NX10.0.0.
License requirements : None
| tabId | The unique tab id |
| visible | Turn the tab's visibility on or off |
| tag_t NXOpen::ResourceBarManager::Tag | ( | ) | const |
Returns the tag of this object.