Class CApaModelHeader

class CApaModelHeader : public CBase;

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

• CBase - Base class for all classes to be instantiated on the heap.

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

Members

Defined in CApaModelHeader:

• AppId()constGets the identity of the application associated with the application model.
• CApaModelHeader()Constructor for CApaModelHeader
• Reserved_1()Reserved for future use
• Reserved_2()Reserved for future use
• StoreL(CStreamStore &,CStreamDictionary &)constStores the model and its components in the specified store.

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

See also:

• CApaModelDoorA persistent representation of a door that also acts as a wrapper around an appl...
• TApaModelDoorFactoryA factory class for instantiating and restoring an application's door using the ...
• MApaModelHeaderFactoryAn interface class that applications implement to construct an application model...

protected: IMPORT_C CApaModelHeader();

Description

Constructor for CApaModelHeader

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.

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.

private: IMPORT_C virtual void Reserved_1();

Description

Reserved for future use

private: IMPORT_C virtual void Reserved_2();

Description

Reserved for future use