All Frameworks Class Hierarchy This Framework Indexes
DialogEngine Class 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:
- it's a component which OM derives from the
CATDialogAgent component
- it implements an interface, which derives from
CATIAfrDialog , to give its representation
- it is activated.
Example of usage: You are in a workshop, workbench or in an Add-in
- Create an instance of the class
new CATCommandHeaderWithSDOForAgent("HeaderID", IID_CATIMyVisuForMyToolbar);
- Associate this instance with a starter
// 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")
- HeaderID:Identificator of the header
- IID_CATIMyVisuForMyToolbar: IID of an interface which derives from
CATIAfrDialog
- CATMySDOTlb:Identificator of the toolbar where dialog agent will be set
- CATMySDOStr:Identificator of the starter dedicated to the header
Constructor and Destructor Index
- o
~CATCommandHeaderWithSDOForAgent()
-
- o
CATCommandHeaderWithSDOForAgent(CATString&,IID&)
- Constructs a header to represent Dialog Agent in a toolbar.
Constructor and Destructor
o ~CATCommandHeaderWithSDOForAgent
| public virtual ~CATCommandHeaderWithSDOForAgent( | ) |
-
o CATCommandHeaderWithSDOForAgent
| public CATCommandHeaderWithSDOForAgent( | const | iHeaderID, |
| const | iVisuIID) |
-
Constructs a header to represent Dialog Agent in a toolbar.
- Parameters:
-
- iHeaderID
- Identificator of the header. You must follow the nomenclature :
ZZZxxxHeaderNameHdr where
- ZZZ: The trigram of the enterprise
- xxx: The trigram of FW or the product
- 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.
This object is included in the file: CATCommandHeaderWithSDOForAgent.h
If needed, your Imakefile.mk should include the module: CATDialogEngine