All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

DialogEngine Class CATCommandHeaderWithSDOForAgent

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---System.CATEventSubscriber
        |
        +---ApplicationFrame.CATCommandHeader
          |
          +---ApplicationFrame.CATCommandHeaderWithSDO
            |
            +---CATCommandHeaderWithSDOForAgent
 

Usage: you must use this class as is. You should never derive it.


public class CATCommandHeaderWithSDOForAgent

Class for command headers to represent Dialog Agents in a toolbar.
Role: This header allows you to see a CATDialogAgent in a toolbar. The agents are set in the Set of Dialog Objects (SDO) by the CATStateCommand thanks to the CATStateCommand.AddSDOElement method.
An object in the SDO is visualized thanks this class under these three conditions:

  1. it's a component which OM derives from the CATDialogAgent component
  2. it implements an interface, which derives from CATIAfrDialog , to give its representation
  3. it is activated.

Example of usage: You are in a workshop, workbench or in an Add-in

  1. Create an instance of the class
  2.     new CATCommandHeaderWithSDOForAgent("HeaderID", IID_CATIMyVisuForMyToolbar);
      
  3. Associate this instance with a starter
  4.     // The container which represents the toolbar
        NewAccess(CATCmdContainer,pCATMySDOTlb,CATMySDOTlb);
          ......
          // Starter to visualize all objects in the SDO
          NewAccess(CATCmdStarter,pCATMySDOStr,CATMySDOStr);
           .....
          // Associate the command header with the starter
          SetAccessCommand(pCATMySDOStr,"HeaderID")
      


Constructor and Destructor Index


o CATCommandHeaderWithSDOForAgent(CATString&,IID&)
Constructs a header to represent Dialog Agent in a toolbar.
o ~CATCommandHeaderWithSDOForAgent()

Constructor and Destructor


o CATCommandHeaderWithSDOForAgent
public CATCommandHeaderWithSDOForAgent( const CATString& iHeaderID,
const IID& iVisuIID)
Constructs a header to represent Dialog Agent in a toolbar.
Parameters:
iHeaderID
Identificator of the header. You must follow the nomenclature :
ZZZxxxHeaderNameHdr where
  1. ZZZ: The trigram of the enterprise
  2. xxx: The trigram of FW or the product
  3. Hdr: For Header

This identificator is not used for any Nls or Rsc Resources.
iVisuIID
Interface deriving from
CATIAfrDialog.
Agent must implement this interface to be visualized.
o ~CATCommandHeaderWithSDOForAgent
public virtual ~CATCommandHeaderWithSDOForAgent()

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

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