All Frameworks Class Hierarchy This Framework Indexes Previous Next

ObjectModelerBase Interface CATInit

Usage: you can freely reimplement this interface.

interface CATInit

Interface to define initialization of a document's data.
Role: The Init method is called at File/New or File/Open. In this method, each application usually creates its root element. To get it, use GetRootContainer method.

Method Index

o GetRootContainer(CATIdent): Returns the root element of the given document.
o Init(CATBoolean): Initializes data of this document.

Methods

o GetRootContainer

public virtual GetRootContainer( const iInterfaceID)

Returns the root element of the given document.
Note that the return pointer type corresponds to the iInterfaceID argument. However, given the L1 exposition constraints, it is not possible to convert a CATIdent to an IID, which means that the only return possible is a CATBaseUnknown pointer which must then be cast to the proper interface handle.

Parameters:

iInterfaceID: chosen interface to handle the root element.

Returns:

the root element

o Init

public virtual Init( iDestroyExistingData)

Initializes data of this document.

Parameters:

iDestroyExistingData: FALSE : Initialization is done only if there is no existing data.
TRUE : Existing data is destroyed before new initialization.

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