All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATAnalysisInterfaces Interface CATISamCtxMenuProvider

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATISamCtxMenuProvider
 

Usage: you can freely reimplement this interface.


interface CATISamCtxMenuProvider

Interface used to add applicative contextual menus on an AnalysisFeature in the analysis context.
Default implementation of CATIContextualMenu is implemented on AnalysisFeature by DASSAULT SYSTEMES.
this implementation scan all the declared providers and call them order to complete the menu. You should not reset the CATCmdContainer by only complete it.

Note that it is always possible for a CATCommandHeader to decide to disable or not each command by overriding the CATCommandHeader.BecomeAvailable and CATCommandHeader.BecomeUnavailable methods.


Method Index


o GetContextualMenu(CATBaseUnknown*,CATCmdContainer*&)
Returns the contextual menu defined for an Analysis Feature.
o IsPermanent()
Returns if the provider is permanent of not.

Methods


o GetContextualMenu
public virtual HRESULT GetContextualMenu(CATBaseUnknown* iObj,
CATCmdContainer*& ioCtxMenu) = 0
Returns the contextual menu defined for an Analysis Feature.
Parameters:
iObj
The extended object.
oCtxMenu
The contextual menu for the extended object.
o IsPermanent
public virtual CATBoolean IsPermanent()=0
Returns if the provider is permanent of not.
A permanent provider is created and released by the Analysis Infrastructure with the document LifeCycle.
Legal values:

This object is included in the file: CATISamCtxMenuProvider.h
If needed, your Imakefile.mk should include the module: CATAnalysisInterface

Copyright © 2003, Dassault Systèmes. All rights reserved.