DELPPRLiveProcessInterfaces Interface DELIPPRLiveProcessContextualMenu

Usage: you can freely reimplement this interface.

interface DELIPPRLiveProcessContextualMenu

DELIPPRLiveProcessContextualMenu is implemented to create a Contextual Menu for the Process Tile or process nodes on the left tree in Live Process Editor.
The class implementing this function should extend one of the folloging types (point of view UI): VPMFctProcessOccurrence: the root proces node on the Live Process Editor left tree. VPMFctProcessRootOccurrence: a process node on the Live Process Editor left tree. DELPPRLiveProxy: a process tile on the life process editor. Role: This interface has to be implemented to provide user defined contextual menus for a Process tile or process nodes on the left tree in Live Process Editor.

Method Index


o GetContextualSubMenu(CATString&,CATCmdContainer*&)
The implementantion of this function should add the contextual sub menu items on the contairner identified with the name iSubMenuName.
o GetContextualSubMenusNames(CATListValCATString*)
The implementantion of this function should declare the submenus names to be added.

Methods


o GetContextualSubMenu
public virtual GetContextualSubMenu( const iSubMenuName,
oMenu)
The implementantion of this function should add the contextual sub menu items on the contairner identified with the name iSubMenuName. This function will be called for each declared SubMenu group name added on the previous function
Parameters:
name
of the actual submenu group to wich the submenu items will be added. This name corresponds to one of the names declared on the previous function
reference
to a pointer to the container in wich the submenu items should be added. To see an example of the use of this function please refers to CAAPPRLPEProcessContextualMenu use case on the doc.
Returns:
  1. S_OK sub menu entries has been added
  2. E_FAIL, E_NOTIMPL otherwise, please remark that the submenu container itself won't be displayed if the implementantion of this function returns E_FAIL
o GetContextualSubMenusNames
public virtual GetContextualSubMenusNames( pListSubMenusNames)
The implementantion of this function should declare the submenus names to be added.
Parameters:
pointer
to the list to declare the wished Submenus groups to be added, For each element on the list the system will call GetContextualSubMenu function, to add the corresponding submenu items. To see an example of the use of this function please refers to CAAPPRLPEProcessContextualMenu use case on the doc.
Returns:
  1. S_OK , SubMenus group names have been added
  2. E_FAIL, E_NOTIMPL otherwise, no SubMenus will be added
This object is included in the file: DELIPPRLiveProcessContextualMenu.h
If needed, your Imakefile.mk should include the module: DELPPRLiveProcessItf

Copyright © 1999-2014, Dassault Systèmes. All rights reserved.