Class CApaModelDoor

class CApaModelDoor : public CApaDoorBase;

Description

A persistent representation of a door that also acts as a wrapper around an application's model.

The class allows embedded data to be manipulated without requiring the whole associated application.

Derivation

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

• CPicture - Abstract base class for: drawing a picture to a graphics context, storing and re...

• CApaDoorBase - The base class for the graphic representation of an embedded document.

• CApaModelDoor - A persistent representation of a door that also acts as a wrapper around an appl...

Members

Defined in CApaModelDoor:

• DetachFromStoreL(TDetach)Restores the model to the specified degree.
• Draw(CGraphicsContext &,const TPoint &,const TRect &,MGraphicsDeviceMap *)constNot supported; if called, raises an APPARC 17 panic.
• ExternalizeL(RWriteStream &)constNot supported; if called, raises an APPARC 17 panic.
• GetOriginalSizeInTwips(TSize &)constGets the door's original size, in twips.
• GlassDoorSize()constReturns the size of the glass door, in twips.
• ModelHeader()Gets the application model wrapper object.
• NewL(CApaModelHeader *)Creates a model door object.
• NewL(const CStreamStore &,TStreamId,const MApaModelHeaderFactory *)Creates a model door object and restores it from an embedded store within the sp...
• NewLC(CApaModelHeader *)Creates a model door object, and puts a pointer to it onto the cleanup stack.
• RestoreL(const CStreamStore &,TStreamId,const MApaModelHeaderFactory *)Restores the embedded model data from the specified store.
• ScaleFactorHeight()constGets the door's height scale factor.
• ScaleFactorWidth()constGets the door's width scale factor.
• SetFormat(TFormat)Sets the format of the door.
• SetScaleFactor(TInt,TInt)Sets the door's scale factors.
• StoreL(CStreamStore &)constStores the model data in the specified store as an embedded store.
• ~CApaModelDoor()Destructor.

Inherited from CApaDoorBase:

• Capability()constGets the Embedded Document's capabilities. These include whether it is scalable ...
• EGlassDoorThe representation is a glass door.
• EIconicThe representation is an icon.
• ETemporarilyIconicThe representation is a glass door but has been temporarily switched to an icon....
• ExternalizeBaseStreamL(CStreamStore &,CStreamDictionary &)constExternalises the information contained in this base class to a stream in the spe...
• Format()constGets the current format of the representation of the embedded document.
• GetCropInTwips(TMargins &)constGets the cropping margins of a Embedded Document in twips. These margins are rel...
• InternalizeBaseStreamL(const CStreamStore &,const CStreamDictionary &)Internalises the information for this base class from a stream in the specified ...
• LineBreakPossible(TUint,TBool,TBool)constStates whether a line break is possible, either before or after an Embedded Docu...
• NativePixelSize(TSize &)Returns the native pixel size of the bitmap.
• SetCropInTwips(const TMargins &)Sets the cropping margins of a Embedded Document in twips. These are relative to...
• SetSource(TUid)Sets the UID that identifies this door when the source originates on a non-Symbi...
• Source()constGets the UID that identifies this door when the source originates on a non-Symbi...
• TFormatDefines the possible formats for the graphical representation of the embedded do...
• iFormat
• iSource

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...

Inherited from CPicture:

• AddCropInPixels(MGraphicsDeviceMap *,const TMargins &)Adds pixel cropping margins to the picture.
• EDetachDrawInternalise enough information to draw the picture (and no more); null any refer...
• EDetachFullInternalise all data that is required to fully store the picture later; null any...
• GetSizeInPixels(MGraphicsDeviceMap *,TSize &)constGets the picture's size in pixels.
• GetSizeInTwips(TSize &)constGets the picture's size, in twips.
• ResetToOriginal()Resets the picture's scaling and cropping attributes to their original values.
• SetSizeInPixels(MGraphicsDeviceMap *,const TSize &)Sets the picture's size in pixels.
• SetSizeInTwips(const TSize &)Sets the picture's size, in twips
• TDetachOptions for detaching pictures from stores. Used by CPicture::DetachFromStoreL(T...

IMPORT_C static CApaModelDoor* NewL(CApaModelHeader *aHeader);

Description

Creates a model door object.

Parameters

CApaModelHeader *aHeader A pointer to an existing concrete application model wrapper object.

Return value

CApaModelDoor * A pointer to the new model door object.

IMPORT_C static CApaModelDoor* NewLC(CApaModelHeader *aHeader);

Description

Creates a model door object, and puts a pointer to it onto the cleanup stack.

Parameters

CApaModelHeader *aHeader A pointer to an existing concrete application model wrapper object.

Return value

CApaModelDoor * A pointer to the new model door object.

IMPORT_C static CApaModelDoor* NewL(const CStreamStore &aStore, TStreamId aHeadStreamId, const MApaModelHeaderFactory *aFactory);

Description

Creates a model door object and restores it from an embedded store within the specified store.

Parameters

const CStreamStore &aStore The store from which the model door is to be restored. TStreamId aHeadStreamId The head stream ID. This is the ID of the stream containing the stream dictionary which is restored as part of the process of creating this model door object. The stream dictionary contains the ID of the stream hosting the embedded store. const MApaModelHeaderFactory *aFactory A pointer to a factory object for constructing the application model wrapper object, also known as the application model header, a CApaModelHeader type.

Return value

CApaModelDoor * A pointer to the new model door object.

See also:

• MApaModelHeaderFactoryAn interface class that applications implement to construct an application model...

IMPORT_C ~CApaModelDoor();

Description

Destructor.

Frees all resources owned by the object, prior to its destruction.

inline CApaModelHeader* ModelHeader();

Description

Gets the application model wrapper object.

Return value

CApaModelHeader * A pointer to the application model wrapper object.

inline void SetFormat(TFormat aFormat);

Description

Sets the format of the door.

Parameters

CApaDoorBase::TFormat aFormat The format for the graphical representation of the embedded document.

IMPORT_C virtual TStreamId StoreL(CStreamStore &aStore) const;

Description

Stores the model data in the specified store as an embedded store.

The function stores the model data, if the model exists in memory, otherwise, it simply copies the stream containing the embedded document into the specified store.

Parameters

CStreamStore &aStore The store in which the model data is to be stored.

Return value

TStreamId The stream ID of the head stream for the embedded model data. This stream contains the stream dictionary through which the embedded data and its door can be restored.

IMPORT_C void RestoreL(const CStreamStore &aStore, TStreamId aHeadStreamId, const MApaModelHeaderFactory *aFactory);

Description

Restores the embedded model data from the specified store.

Parameters

const CStreamStore &aStore The store from which the embedded model data is to be restored. TStreamId aHeadStreamId The stream ID of the head stream for the embedded model data. This stream contains the stream dictionary through which the embedded model data and its door can be restored. const MApaModelHeaderFactory *aFactory A pointer to a factory object for constructing the application model wrapper object, also known as the application model header, a CApaModelHeader type. The application model wrapper is provided by the application model (not the application UI), and supplies the knowledge for internalizing the application model data from an embedded store. The pointer must not be null, otherwise the function raises an APPARC 22 panic.

IMPORT_C virtual void DetachFromStoreL(TDetach=EDetachFull);

Description

Restores the model to the specified degree.

Parameters

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

Interface status:

removed

IMPORT_C virtual void ExternalizeL(RWriteStream &aStream) const;

Description

Not supported; if called, raises an APPARC 17 panic.

Parameters

RWriteStream &aStream

Interface status:

removed

IMPORT_C virtual void Draw(CGraphicsContext &aGc, const TPoint &aTopLeft, const TRect &aClipRect, MGraphicsDeviceMap *aMap) const;

Description

Not supported; if called, raises an APPARC 17 panic.

Parameters

CGraphicsContext &aGc const TPoint &aTopLeft const TRect &aClipRect MGraphicsDeviceMap *aMap

IMPORT_C virtual void GetOriginalSizeInTwips(TSize &aSize) const;

Description

Gets the door's original size, in twips.

Parameters

TSize &aSize This size, in twips.

IMPORT_C virtual void SetScaleFactor(TInt aScaleFactorWidth, TInt aScaleFactorHeight);

Description

Sets the door's scale factors.

Parameters

TInt aScaleFactorWidth The width scale factor, in percent. TInt aScaleFactorHeight The height scale factor, in percent.

IMPORT_C virtual TInt ScaleFactorWidth() const;

Description

Gets the door's width scale factor.

Return value

TInt The width scale factor, in percent.

IMPORT_C virtual TInt ScaleFactorHeight() const;

Description

Gets the door's height scale factor.

Return value

TInt The height scale factor, in percent.

private: virtual TSize GlassDoorSize() const;

Description

Returns the size of the glass door, in twips.

A concrete implementation of this function is provided by derived classes.

Return value

TSize The size of the glass door, in twips.