NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::CustomPopupMenuHandler Class Reference

Represents Custom Popup Menu Handler class
Created in NX6.0.4. More...

Inheritance diagram for NXOpen::CustomPopupMenuHandler:
NXOpen::TransientObject

Public Types

typedef NXOpen::Callback0< int > AddCustomPopupMenuCallback
 This callback will be invoked by NX application when a RMB click is performed on NX Tc Navigator application. More...
 
typedef NXOpen::Callback0< int > CustomPopupMenuInvokedCallback
 This callback will be invoked by NX when user clicks on a custom menu item. More...
 

Public Member Functions

NXOpen::CustomPopupMenuAddMenu (int menuId, const NXString &menuName)
 Adds and returns a menu to the COTS (Commercial, off-the-shelf) RMB menu. More...
 
NXOpen::CustomPopupMenuAddMenu (int menuId, const char *menuName)
 Adds and returns a menu to the COTS (Commercial, off-the-shelf) RMB menu. More...
 
NXOpen::CustomPopupMenuItemAddMenuItem (int menuItemId, const NXString &menuItemName)
 Adds and returns a menu item to the COTS (Commercial, off-the-shelf) RMB menu. More...
 
NXOpen::CustomPopupMenuItemAddMenuItem (int menuItemId, const char *menuItemName)
 Adds and returns a menu item to the COTS (Commercial, off-the-shelf) RMB menu. More...
 
void AddMenuSeparator ()
 Adds a separator to the COTS (Commercial, off-the-shelf) RMB menu
Created in NX6.0.4. More...
 
NXOpen::CustomPopupMenuItemGetInvokedCommand ()
 Returns the menu item for the command invoked. More...
 
void GetSelectedNodes (std::vector< NXOpen::TreeListNode * > &selectedNodes)
 Returns a list of node(s) selected during a RMB click. More...
 
void RegisterAddCustomPopupMenuCallback (const NXOpen::CustomPopupMenuHandler::AddCustomPopupMenuCallback &popupCb)
 Registers the add_custom_popup_menu_callback callback method with the popup menu handler object. More...
 
void RegisterCustomPopupMenuInvokedCallback (const NXOpen::CustomPopupMenuHandler::CustomPopupMenuInvokedCallback &popupCb)
 Registers the add_custom_popup_menu_callback callback method with the popup menu handler object. More...
 
virtual ~CustomPopupMenuHandler ()
 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...
 

Detailed Description

Represents Custom Popup Menu Handler class
Created in NX6.0.4.


Member Typedef Documentation

This callback will be invoked by NX application when a RMB click is performed on NX Tc Navigator application.

Customer can query the selected object(s) and set the cascading custom popup menu to be appended to the existing COTS (Commercial, off-the-shelf) RMB popup menu.
Created in NX6.0.4.

License requirements : None

This callback will be invoked by NX when user clicks on a custom menu item.

The picked menu and object(s) selected can be queried from within this callback.The custom implementation can perform appropriate action associated with this menu pick.
Created in NX6.0.4.

License requirements : None

Constructor & Destructor Documentation

virtual NXOpen::CustomPopupMenuHandler::~CustomPopupMenuHandler ( )
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 NX6.0.4.

License requirements : None

Member Function Documentation

NXOpen::CustomPopupMenu* NXOpen::CustomPopupMenuHandler::AddMenu ( int  menuId,
const NXString menuName 
)

Adds and returns a menu to the COTS (Commercial, off-the-shelf) RMB menu.

Returns
menu
Created in NX6.0.4.

License requirements : None
Parameters
menuIdId of the menu
menuNamename of the menu
NXOpen::CustomPopupMenu* NXOpen::CustomPopupMenuHandler::AddMenu ( int  menuId,
const char *  menuName 
)

Adds and returns a menu to the COTS (Commercial, off-the-shelf) RMB menu.

Returns
menu
Created in NX6.0.4.

License requirements : None
Parameters
menuIdId of the menu
menuNamename of the menu
NXOpen::CustomPopupMenuItem* NXOpen::CustomPopupMenuHandler::AddMenuItem ( int  menuItemId,
const NXString menuItemName 
)

Adds and returns a menu item to the COTS (Commercial, off-the-shelf) RMB menu.

Returns
menu item
Created in NX6.0.4.

License requirements : None
Parameters
menuItemIdId of the menu item
menuItemNamename of the menu item
NXOpen::CustomPopupMenuItem* NXOpen::CustomPopupMenuHandler::AddMenuItem ( int  menuItemId,
const char *  menuItemName 
)

Adds and returns a menu item to the COTS (Commercial, off-the-shelf) RMB menu.

Returns
menu item
Created in NX6.0.4.

License requirements : None
Parameters
menuItemIdId of the menu item
menuItemNamename of the menu item
void NXOpen::CustomPopupMenuHandler::AddMenuSeparator ( )

Adds a separator to the COTS (Commercial, off-the-shelf) RMB menu
Created in NX6.0.4.



License requirements : None

NXOpen::CustomPopupMenuItem* NXOpen::CustomPopupMenuHandler::GetInvokedCommand ( )

Returns the menu item for the command invoked.

Returns
menu item
Created in NX6.0.4.

License requirements : None
void NXOpen::CustomPopupMenuHandler::GetSelectedNodes ( std::vector< NXOpen::TreeListNode * > &  selectedNodes)

Returns a list of node(s) selected during a RMB click.

Customer can call this query API inside the implementation of NXOpen::CustomPopupMenuHandler::AddCustomPopupMenuCallback or NXOpen::CustomPopupMenuHandler::CustomPopupMenuInvokedCallback to obtain additional information
Created in NX6.0.4.

License requirements : None

Parameters
selectedNodesSelected Nodes
void NXOpen::CustomPopupMenuHandler::RegisterAddCustomPopupMenuCallback ( const NXOpen::CustomPopupMenuHandler::AddCustomPopupMenuCallback popupCb)

Registers the add_custom_popup_menu_callback callback method with the popup menu handler object.


Created in NX6.0.4.

License requirements : None

Parameters
popupCbpopup cb
void NXOpen::CustomPopupMenuHandler::RegisterCustomPopupMenuInvokedCallback ( const NXOpen::CustomPopupMenuHandler::CustomPopupMenuInvokedCallback popupCb)

Registers the add_custom_popup_menu_callback callback method with the popup menu handler object.


Created in NX6.0.4.

License requirements : None

Parameters
popupCbpopup cb

The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.