NX Open C++ Reference Guide
|
Represents a Context Menu
Created in NX8.5.0.
More...
Public Member Functions | |
NXOpen::MenuBar::ContextMenuEntry * | AddMenuButton (NXOpen::MenuBar::MenuButton *button, int index) |
Adds a menu bar button to the context menu. More... | |
NXOpen::MenuBar::ContextMenuEntry * | AddMenuLabel (const NXString &label, int index) |
Adds a label to the context menu. More... | |
NXOpen::MenuBar::ContextMenuEntry * | AddMenuLabel (const char *label, int index) |
Adds a label to the context menu. More... | |
void | AddSeparator (int index) |
Adds a separator to the context menu. More... | |
NXOpen::MenuBar::ContextMenu * | AddSubmenu (const NXString &label, int index) |
Adds a submenu to the context menu. More... | |
NXOpen::MenuBar::ContextMenu * | AddSubmenu (const char *label, int index) |
Adds a submenu to the context menu. More... | |
NXOpen::MenuBar::ContextMenuEntry * | GetEntry (int index) |
Returns the MenuBar::ContextMenuEntry at the specified index in the menu. More... | |
NXOpen::MenuBar::ContextMenuEntry * | GetEntryWithName (const NXString &name) |
Given the name of a menu entry, returns the first MenuBar::ContextMenuEntry in this menu which matches. More... | |
NXOpen::MenuBar::ContextMenuEntry * | GetEntryWithName (const char *name) |
Given the name of a menu entry, returns the first MenuBar::ContextMenuEntry in this menu which matches. More... | |
int | GetIndexOfEntry (NXOpen::MenuBar::ContextMenuEntry *entry) |
Returns the index of the MenuBar::ContextMenuEntry object within this menu. More... | |
NXOpen::MenuBar::ContextMenu * | GetSubmenu (int index) |
Returns the submenu for the entry at the specified index in the menu. More... | |
bool | HasEntryWithName (const NXString &name) |
Indicates whether or not this menu contains a MenuBar::ContextMenuEntry which has the given name. More... | |
bool | HasEntryWithName (const char *name) |
Indicates whether or not this menu contains a MenuBar::ContextMenuEntry which has the given name. More... | |
void | HideEntry (NXOpen::MenuBar::ContextMenuEntry *entry) |
Prevents the indicated menu entry from being shown on the menu. More... | |
void | MoveEntry (NXOpen::MenuBar::ContextMenuEntry *entry, int index) |
Reorders the menu to move a menu entry to a new position in the list. More... | |
int | NumberOfEntries () |
Returns the number of MenuBar::ContextMenuEntry objects in this menu. More... | |
void | SetDefaultEntry (NXOpen::MenuBar::ContextMenuEntry *entry) |
Makes a specified menu entry the default for the menu. More... | |
virtual | ~ContextMenu () |
Frees the object from memory. More... | |
Public Member Functions inherited from NXOpen::TransientObject | |
void * | GetHandle () |
Handle of the internal object represented by this object. More... | |
Represents a Context Menu
Created in NX8.5.0.
|
virtual |
Frees the object from memory.
After this method is called, it is illegal to use the object. In .NET, this method is automatically called when the object is deleted by the garbage collector.
Created in NX8.5.0.
License requirements : None
NXOpen::MenuBar::ContextMenuEntry* NXOpen::MenuBar::ContextMenu::AddMenuButton | ( | NXOpen::MenuBar::MenuButton * | button, |
int | index | ||
) |
Adds a menu bar button to the context menu.
Use MenuBar::MenuBarManager::GetButtonFromName to find the button to add to the menu.
button | the menu bar button to add to the menu |
index | position at which to create the new button. Use -1 to add the button to the end of the menu. |
NXOpen::MenuBar::ContextMenuEntry* NXOpen::MenuBar::ContextMenu::AddMenuLabel | ( | const NXString & | label, |
int | index | ||
) |
Adds a label to the context menu.
label | label for the label entry |
index | position at which to create the label entry. Use -1 to add the label to the end of the menu. |
NXOpen::MenuBar::ContextMenuEntry* NXOpen::MenuBar::ContextMenu::AddMenuLabel | ( | const char * | label, |
int | index | ||
) |
Adds a label to the context menu.
label | label for the label entry |
index | position at which to create the label entry. Use -1 to add the label to the end of the menu. |
void NXOpen::MenuBar::ContextMenu::AddSeparator | ( | int | index | ) |
Adds a separator to the context menu.
Created in NX8.5.0.
License requirements : None
index | position at which to create the separator. Use -1 to add the separator to the end of the menu. |
NXOpen::MenuBar::ContextMenu* NXOpen::MenuBar::ContextMenu::AddSubmenu | ( | const NXString & | label, |
int | index | ||
) |
Adds a submenu to the context menu.
label | label for the cascade menu |
index | position at which to create the sub-menu. Use -1 to add the sub-menu to the end of the menu. |
NXOpen::MenuBar::ContextMenu* NXOpen::MenuBar::ContextMenu::AddSubmenu | ( | const char * | label, |
int | index | ||
) |
Adds a submenu to the context menu.
label | label for the cascade menu |
index | position at which to create the sub-menu. Use -1 to add the sub-menu to the end of the menu. |
NXOpen::MenuBar::ContextMenuEntry* NXOpen::MenuBar::ContextMenu::GetEntry | ( | int | index | ) |
Returns the MenuBar::ContextMenuEntry at the specified index in the menu.
index | index of menu entry to return |
NXOpen::MenuBar::ContextMenuEntry* NXOpen::MenuBar::ContextMenu::GetEntryWithName | ( | const NXString & | name | ) |
Given the name of a menu entry, returns the first MenuBar::ContextMenuEntry in this menu which matches.
name | name of menu entry to search for |
NXOpen::MenuBar::ContextMenuEntry* NXOpen::MenuBar::ContextMenu::GetEntryWithName | ( | const char * | name | ) |
Given the name of a menu entry, returns the first MenuBar::ContextMenuEntry in this menu which matches.
name | name of menu entry to search for |
int NXOpen::MenuBar::ContextMenu::GetIndexOfEntry | ( | NXOpen::MenuBar::ContextMenuEntry * | entry | ) |
Returns the index of the MenuBar::ContextMenuEntry object within this menu.
entry | an entry in the menu |
NXOpen::MenuBar::ContextMenu* NXOpen::MenuBar::ContextMenu::GetSubmenu | ( | int | index | ) |
Returns the submenu for the entry at the specified index in the menu.
The menu entry at this index must be of type MenuBar::ContextMenuEntry::TypeSubmenu .
index | index of submenu to return |
bool NXOpen::MenuBar::ContextMenu::HasEntryWithName | ( | const NXString & | name | ) |
Indicates whether or not this menu contains a MenuBar::ContextMenuEntry which has the given name.
name | name of menu entry to search for |
bool NXOpen::MenuBar::ContextMenu::HasEntryWithName | ( | const char * | name | ) |
Indicates whether or not this menu contains a MenuBar::ContextMenuEntry which has the given name.
name | name of menu entry to search for |
void NXOpen::MenuBar::ContextMenu::HideEntry | ( | NXOpen::MenuBar::ContextMenuEntry * | entry | ) |
Prevents the indicated menu entry from being shown on the menu.
Created in NX8.5.0.
License requirements : None
entry | the menu entry to hide |
void NXOpen::MenuBar::ContextMenu::MoveEntry | ( | NXOpen::MenuBar::ContextMenuEntry * | entry, |
int | index | ||
) |
Reorders the menu to move a menu entry to a new position in the list.
Created in NX8.5.0.
License requirements : None
entry | the menu entry to be moved |
index | the new position |
int NXOpen::MenuBar::ContextMenu::NumberOfEntries | ( | ) |
Returns the number of MenuBar::ContextMenuEntry objects in this menu.
Created in NX8.5.0.
License requirements : None
void NXOpen::MenuBar::ContextMenu::SetDefaultEntry | ( | NXOpen::MenuBar::ContextMenuEntry * | entry | ) |
Makes a specified menu entry the default for the menu.
This entry will be displayed in bold text on the menu. It will be the action that is performed in response to a double-click event in the UI.
The menu entry must have a type of MenuBar::ContextMenuEntry::TypePushButton or MenuBar::ContextMenuEntry::TypeToggleButton .
Created in NX8.5.0.
License requirements : None
entry | the menu entry to become the default for the menu |