Class CApaModelHeader

CApaModelHeader

Support

Supported from 5.0

Description

An interface class that acts as a wrapper for an application model.

This is also known as an application model header.

The class provides the knowledge for internalizing and externalizing an application model's data. An instance of the class is used by CApaModelDoor.

A concrete implementation of the class must be supplied by the application model (not the application UI). An instance of the class is constructed by a factory object that implements the MApaModelHeaderFactory interface; the factory object is also supplied by the application model (not the application UI).

Derivation

CApaModelHeader An interface class that acts as a wrapper for an application model CBase Base class for all classes to be instantiated on the heap

Defined in CApaModelHeader:
AppId(), DetachFromStoreL(), StoreL()

Inherited from CBase:
operator new()

See also:

• CApaModelDoor
• TApaModelDoorFactory
• MApaModelHeaderFactory

virtual TApaAppIdentifier AppId() const = 0;

Description

Gets the identity of the application associated with the application model.

Return value

TApaAppIdentifier The application identity.

virtual void DetachFromStoreL(CPicture::TDetach aDegree) = 0;

Description

Restores the model to the specified degree.

An implementation of this function should propagate this call to all components of the model.

Parameters

CPicture::TDetach aDegree The degree to which restoration is needed.

virtual void StoreL(CStreamStore& aStore,CStreamDictionary& aDict) const = 0;

Description

Stores the model and its components in the specified store.

Parameters

CStreamStore& aStore The store in which the model's components are to be stored. CStreamDictionary& aDict The stream dictionary into which stream IDs and associated UIDs are put.