NX Open C++ Reference Guide
|
Interface for the MenuBarManager object
To obtain an instance of this class, refer to UI
Created in NX6.0.0.
More...
Public Types | |
typedef NXOpen::Callback1 < NXOpen::MenuBar::MenuBarManager::CallbackStatus, NXOpen::MenuBar::MenuButtonEvent * > | ActionCallback |
Prototype for the action callbacks Created in NX6.0.0. | |
enum | CallbackStatus { CallbackStatusContinue, CallbackStatusCancel, CallbackStatusOverrideStandard, CallbackStatusWarning, CallbackStatusError } |
Return values for action callbacks. More... | |
typedef NXOpen::Callback0< int > | EnterMenuApplication |
Prototype for callback called whenever the application is entered Created in NX6.0.0. | |
typedef NXOpen::Callback0< int > | ExitMenuApplication |
Prototype for callback called whenever the application is exited Created in NX6.0.0. | |
typedef NXOpen::Callback0< int > | InitializeMenuApplication |
Prototype for application initialization callback Created in NX6.0.0. | |
Public Member Functions | |
void | AddMenuAction (const NXString &name, const NXOpen::MenuBar::MenuBarManager::ActionCallback &actionCallback) |
Adds the action callback. | |
void | ApplicationSwitchRequest (const NXString &applicationName) |
Registers a request to switch to specified application and open the corresponding user environment. | |
NXOpen::MenuBar::MenuButton * | GetButtonFromName (const NXString &name) |
Finds the MenuButton associated with the given name. | |
int | RegisterApplication (const NXString &name, const NXOpen::MenuBar::MenuBarManager::InitializeMenuApplication &initializeCallback, const NXOpen::MenuBar::MenuBarManager::EnterMenuApplication &enterCallback, const NXOpen::MenuBar::MenuBarManager::ExitMenuApplication &exitCallback, bool supportsDrawings, bool supportsDesignInContext, bool supportsUndo) |
Registers the application. | |
tag_t | Tag () const |
Returns the tag of this object. |
Interface for the MenuBarManager object
To obtain an instance of this class, refer to UI
Created in NX6.0.0.
typedef NXOpen::Callback1<NXOpen::MenuBar::MenuBarManager::CallbackStatus, NXOpen::MenuBar::MenuButtonEvent *> NXOpen::MenuBar::MenuBarManager::ActionCallback |
Prototype for the action callbacks
Created in NX6.0.0.
License requirements : None
Prototype for callback called whenever the application is entered
Created in NX6.0.0.
License requirements : None
Prototype for callback called whenever the application is exited
Created in NX6.0.0.
License requirements : None
Prototype for application initialization callback
Created in NX6.0.0.
License requirements : None
Return values for action callbacks.
void NXOpen::MenuBar::MenuBarManager::AddMenuAction | ( | const NXString & | name, |
const NXOpen::MenuBar::MenuBarManager::ActionCallback & | actionCallback | ||
) |
Adds the action callback.
Created in NX6.0.0.
License requirements : None
name | The name of the action. This name must match the string used in the .men file. NOTE: The full Unicode character set is not supported for this parameter. |
actionCallback | The method to execute for this action |
void NXOpen::MenuBar::MenuBarManager::ApplicationSwitchRequest | ( | const NXString & | applicationName | ) |
Registers a request to switch to specified application and open the corresponding user environment.
When the running journal or program finishes, the system will attempt to switch into the target application. The current application does not change immediately. The argument is an application button name as specified and registered in the ug_main.men file. For example specify UG_APP_MODELING to try to enter the modeling application. Button names registered for custom application as described in "Adding Custom Applications to NX" chapter of the NX Open Programmer's Guide can also be used.
Created in NX8.0.0.
License requirements : None
applicationName | Button name of requested application NOTE: The full Unicode character set is not supported for this parameter. |
NXOpen::MenuBar::MenuButton* NXOpen::MenuBar::MenuBarManager::GetButtonFromName | ( | const NXString & | name | ) |
Finds the MenuButton associated with the given name.
name | The name of the button. This name must match the button name used in the .men file. NOTE: The full Unicode character set is not supported for this parameter. |
int NXOpen::MenuBar::MenuBarManager::RegisterApplication | ( | const NXString & | name, |
const NXOpen::MenuBar::MenuBarManager::InitializeMenuApplication & | initializeCallback, | ||
const NXOpen::MenuBar::MenuBarManager::EnterMenuApplication & | enterCallback, | ||
const NXOpen::MenuBar::MenuBarManager::ExitMenuApplication & | exitCallback, | ||
bool | supportsDrawings, | ||
bool | supportsDesignInContext, | ||
bool | supportsUndo | ||
) |
Registers the application.
name | The name of the application. This name must match the string used in the .men file. NOTE: The full Unicode character set is not supported for this parameter. |
initializeCallback | The method used to initialize the application |
enterCallback | The method called when entering the application |
exitCallback | The method called when exiting the application |
supportsDrawings | Does this application support drawings? |
supportsDesignInContext | Does this application support design in context? |
supportsUndo | Does this application support undo? |
tag_t NXOpen::MenuBar::MenuBarManager::Tag | ( | ) | const |
Returns the tag of this object.