CApaModelDoor Class Reference

#include <mw/apamdr.h>

Link against: apparc.lib

class CApaModelDoor : public CApaDoorBase

Inherits from

CApaModelDoor
- CApaDoorBase
  - CPicture
    - CBase

Public Member Functions
	~CApaModelDoor()
virtual IMPORT_C void	DetachFromStoreL(TDetach)
virtual IMPORT_C void	Draw(CGraphicsContext &, const TPoint &, const TRect &, MGraphicsDeviceMap *)
virtual IMPORT_C void	ExternalizeL(RWriteStream &)
virtual IMPORT_C void	GetOriginalSizeInTwips(TSize &)
CApaModelHeader *	ModelHeader()
IMPORT_C CApaModelDoor *	NewL(CApaModelHeader *)
IMPORT_C CApaModelDoor *	NewL(const CStreamStore &, TStreamId, const MApaModelHeaderFactory *)
IMPORT_C CApaModelDoor *	NewLC(CApaModelHeader *)
IMPORT_C void	RestoreL(const CStreamStore &, TStreamId, const MApaModelHeaderFactory *)
virtual IMPORT_C TInt	ScaleFactorHeight()
virtual IMPORT_C TInt	ScaleFactorWidth()
void	SetFormat(TFormat)
virtual IMPORT_C void	SetScaleFactor(TInt, TInt)
virtual IMPORT_C TStreamId	StoreL(CStreamStore &)

Inherited Attributes
	CApaDoorBase::iFormat
	CApaDoorBase::iSource

Inherited Enumerations
	CApaDoorBase:TFormat
	CPicture:TDetach

Inherited Functions
	CApaDoorBase::CApaDoorBase()
	CApaDoorBase::Capability()const
	CApaDoorBase::ExternalizeBaseStreamL(CStreamStore &,CStreamDictionary &)const
	CApaDoorBase::Format()const
	CApaDoorBase::GetCropInTwips(TMargins &)const
	CApaDoorBase::InternalizeBaseStreamL(const CStreamStore &,const CStreamDictionary &)
	CApaDoorBase::LineBreakPossible(TUint,TBool,TBool)const
	CApaDoorBase::NativePixelSize(TSize &)
	CApaDoorBase::SetCropInTwips(const TMargins &)
	CApaDoorBase::SetSource(TUid)
	CApaDoorBase::Source()const
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()
	CPicture::AddCropInPixels(MGraphicsDeviceMap *,const TMargins &)
	CPicture::CPicture()
	CPicture::GetSizeInPixels(MGraphicsDeviceMap *,TSize &)const
	CPicture::GetSizeInTwips(TSize &)const
	CPicture::ResetToOriginal()
	CPicture::SetSizeInPixels(MGraphicsDeviceMap *,const TSize &)
	CPicture::SetSizeInTwips(const TSize &)
	CPicture::~CPicture()

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

Constructor & Destructor Documentation

~CApaModelDoor ( )

IMPORT_C

~CApaModelDoor

(

)

Destructor.

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

Member Function Documentation

DetachFromStoreL ( TDetach )

IMPORT_C void

DetachFromStoreL

(

TDetach

= EDetachFull

)

[virtual]

Reimplemented from CPicture::DetachFromStoreL(TDetach)

Restores the model to the specified degree.

Parameters
	The degree to which restoration is needed.

Draw ( CGraphicsContext &, const TPoint &, const TRect &, MGraphicsDeviceMap * )

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

Reimplemented from CPicture::Draw(CGraphicsContext &,const TPoint &,const TRect &,MGraphicsDeviceMap *)const

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

ExternalizeL ( RWriteStream & )

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

const [virtual]

Reimplemented from CPicture::ExternalizeL(RWriteStream &)const

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

GetOriginalSizeInTwips ( TSize & )

IMPORT_C void

GetOriginalSizeInTwips

(

TSize &

aSize

)

const [virtual]

Reimplemented from CPicture::GetOriginalSizeInTwips(TSize &)const

Gets the door's original size, in twips.

Parameters
aSize	This size, in twips.

ModelHeader ( )

CApaModelHeader *

ModelHeader

(

)

[inline]

Gets the application model wrapper object.

Return Value: A pointer to the application model wrapper object.

NewL ( CApaModelHeader * )

IMPORT_C CApaModelDoor *

NewL

(

CApaModelHeader *

aHeader

)

[static]

Creates a model door object.

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

Return Value: A pointer to the new model door object.

NewL ( const CStreamStore &, TStreamId, const MApaModelHeaderFactory * )

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

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

Parameters
aStore	The store from which the model door is to be restored.
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.
aFactory	A pointer to a factory object for constructing the application model wrapper object, also known as the application model header, a CApaModelHeader type.

NewLC ( CApaModelHeader * )

IMPORT_C CApaModelDoor *

NewLC

(

CApaModelHeader *

aHeader

)

[static]

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

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

Return Value: A pointer to the new model door object.

RestoreL ( const CStreamStore &, TStreamId, const MApaModelHeaderFactory * )

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

Restores the embedded model data from the specified store.

Parameters
aStore	The store from which the embedded model data is to be restored.
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.
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.

ScaleFactorHeight ( )

IMPORT_C TInt

ScaleFactorHeight

(

)

const [virtual]

Reimplemented from CApaDoorBase::ScaleFactorHeight()const

Gets the door's height scale factor.

Return Value: The height scale factor, in percent.

ScaleFactorWidth ( )

IMPORT_C TInt

ScaleFactorWidth

(

)

const [virtual]

Reimplemented from CApaDoorBase::ScaleFactorWidth()const

Gets the door's width scale factor.

Return Value: The width scale factor, in percent.

SetFormat ( TFormat )

void

SetFormat

(

TFormat

aFormat

)

[inline]

Sets the format of the door.

Parameters
aFormat	The format for the graphical representation of the embedded document.

SetScaleFactor ( TInt, TInt )

IMPORT_C void	SetScaleFactor	(	TInt	aScaleFactorWidth,
			TInt	aScaleFactorHeight
		)	[virtual]

Reimplemented from CApaDoorBase::SetScaleFactor(TInt,TInt)

Sets the door's scale factors.

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

StoreL ( CStreamStore & )

IMPORT_C TStreamId

StoreL

(

CStreamStore &

aStore

)

const [virtual]

Reimplemented from CApaDoorBase::StoreL(CStreamStore &)const

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
aStore	The store in which the model data is to be stored.

Return Value: 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.