All Frameworks Class Hierarchy This Framework Previous Next Indexes
ComponentsCatalogsInterfaces Interface CATICatalogInstantiation
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATICatalogInstantiation
Usage: you can freely reimplement this interface.
interface CATICatalogInstantiation
Interface to instantiate a component catalog.
Role:This interface launches an interactive command to instantiate
in context a component catalog.
To instantiate a component there are two ways:
In the two cases, the unique method,
RunInstantiationCmd , of this interface is called
- on current workbench
- on current workshop
- on object referenced by description
in this order. If all failed or don't implement this interface, the
Copy/Paste code is used.
This interface is implemented on a component when it must be integrated
into a catalog document. To integrate a new type of component in a catalog document there
are two others interfaces to considere:
Method Index
- o
RunInstantiationCmd(CATICatalogLink*,CATICatalogBrowser*,int,int,int&)
- Launches an instantiation command.
Methods
o RunInstantiationCmd
-
Launches an instantiation command.
- Parameters:
-
- iCatalogLink
- An interface on an object which contains informations on the selected
description.
- iBrowser
- The pointer of the browser which launches the instantiation. This pointer can be NULL.
It enables to hide or to close it during the instantiation step.
- iInstantiateMode
- The mode of instantiation.
Legal values:
- 1: copy the referenced object keeping the link to it. (Recommanded).
- 0: copy the referenced object.
- iRepeatMode
- the instantiate command repeat mode.
Legal values:
- oNotDone
- This output argument is valuated to 1 when an interactive command has been launched otherwise 0.
This object is included in the file: CATICatalogInstantiation.h
If needed, your Imakefile.mk should include the module: CATCclInterfaces