CApaDoorBase Class Reference

#include <mw/apadbase.h>

Link against: apparc.lib

class CApaDoorBase : public CPicture

Inherits from

CApaDoorBase
- CPicture
  - CBase

Protected Attributes
TFormat	iFormat
TUid	iSource

Public Member Enumerations
enum	TFormat { EIconic, EGlassDoor, ETemporarilyIconic }

Public Member Functions
virtual IMPORT_C TPictureCapability	Capability()
TFormat	Format()
virtual IMPORT_C void	GetCropInTwips(TMargins &)
virtual IMPORT_C TBool	LineBreakPossible(TUint, TBool, TBool)
virtual IMPORT_C TBool	NativePixelSize(TSize &)
virtual IMPORT_C TInt	ScaleFactorHeight()
virtual IMPORT_C TInt	ScaleFactorWidth()
virtual IMPORT_C void	SetCropInTwips(const TMargins &)
virtual IMPORT_C void	SetScaleFactor(TInt, TInt)
void	SetSource(TUid)
TUid	Source()
virtual IMPORT_C TStreamId	StoreL(CStreamStore &)

Protected Member Functions
	CApaDoorBase()
IMPORT_C void	ExternalizeBaseStreamL(CStreamStore &, CStreamDictionary &)
pure virtual TSize	GlassDoorSize()
IMPORT_C TSize	InternalizeBaseStreamL(const CStreamStore &, const CStreamDictionary &)

Inherited Enumerations
	CPicture:TDetach

Inherited Functions
	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::DetachFromStoreL(TDetach)
	CPicture::Draw(CGraphicsContext &,const TPoint &,const TRect &,MGraphicsDeviceMap *)const
	CPicture::ExternalizeL(RWriteStream &)const
	CPicture::GetOriginalSizeInTwips(TSize &)const
	CPicture::GetSizeInPixels(MGraphicsDeviceMap *,TSize &)const
	CPicture::GetSizeInTwips(TSize &)const
	CPicture::ResetToOriginal()
	CPicture::SetSizeInPixels(MGraphicsDeviceMap *,const TSize &)
	CPicture::SetSizeInTwips(const TSize &)
	CPicture::~CPicture()

Detailed Description

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

An embedded document can be represented either as an icon or as a glass picture. Such a graphic representation is known as a door.

The class is intended for derivation.

Member Attribute Documentation

iFormat

TFormat

iFormat

[protected]

iSource

TUid

iSource

[protected]

Member Enumeration Documentation

Enum TFormat

Defines the possible formats for the graphical representation of the embedded document.

Enumerator	Value	Description
EIconic		The representation is an icon.
EGlassDoor		The representation is a glass door.
ETemporarilyIconic		The representation is a glass door but has been temporarily switched to an icon.

Constructor & Destructor Documentation

CApaDoorBase ( )

IMPORT_C

CApaDoorBase

(

)

[protected]

Member Function Documentation

Capability ( )

IMPORT_C TPictureCapability

Capability

(

)

const [virtual]

Reimplemented from CPicture::Capability()const

Gets the Embedded Document's capabilities. These include whether it is scalable and croppable.

Return Value: The capabilities of the Embedded Document

ExternalizeBaseStreamL ( CStreamStore &, CStreamDictionary & )

IMPORT_C void	ExternalizeBaseStreamL	(	CStreamStore &	aStore,
			CStreamDictionary &	aStreamDict
		)	const [protected]

Externalises the information contained in this base class to a stream in the specified store.

The resulting stream ID is associated with an internal UID, and placed in the specified stream dictionary.

Parameters
aStore	The store to contain the stream.
aStreamDict	The stream dictionary to contain the stream ID (and an associated internal UID).

Format ( )

TFormat

Format

(

)

const [inline]

Gets the current format of the representation of the embedded document.

Return Value: The format for the representation of the embedded document.

GetCropInTwips ( TMargins & )

IMPORT_C void

GetCropInTwips

(

TMargins &

aMargins

)

const [virtual]

Reimplemented from CPicture::GetCropInTwips(TMargins &)const

Gets the cropping margins of a Embedded Document in twips. These margins are relative to the original unscaled size of the Embedded Document.

Parameters
aMargins	The cropping margins of the Embedded Document, in twips

GlassDoorSize ( )

TSize

GlassDoorSize

(

)

const [protected, pure virtual]

Returns the size of the glass door, in twips.

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

Return Value: The size of the glass door, in twips.

InternalizeBaseStreamL ( const CStreamStore &, const CStreamDictionary & )

IMPORT_C TSize	InternalizeBaseStreamL	(	const CStreamStore &	aStore,
			const CStreamDictionary &	aStreamDict
		)	[protected]

Internalises the information for this base class from a stream in the specified store, and returns the size of the icon or glass door.

The stream ID is extracted from the specified stream dictionary. The UID associated with the stream ID is the same as that used when externalising.

Parameters
aStore	The store containing the stream.
aStreamDict	The steam dictionary containing the stream ID.

Return Value: The size of the icon or glass door, in twips.

LineBreakPossible ( TUint, TBool, TBool )

IMPORT_C TBool	LineBreakPossible	(	TUint	aClass,
			TBool	aBeforePicture,
			TBool	aHaveSpaces
		)	const [virtual]

Reimplemented from CPicture::LineBreakPossible(TUint,TBool,TBool)const

States whether a line break is possible, either before or after an Embedded Document. The default implementation returns ETrue, implying that there is a break opportunity both before and after the Embedded Document, whether or not a space is present. This may be overridden for special types of Embedded Documents.

Parameters
aClass	The line breaking class of the adjacent character
aBeforePicture	ETrue, if the adjacent character is before the Embedded Document; EFalse, if the adjacent character is afterwards
aHaveSpaces	ETrue, if spaces occur between the adjacent character and the Embedded Document; EFalse, otherwise

Return Value: ETrue, if a line break is possible; EFalse, otherwise.

NativePixelSize ( TSize & )

IMPORT_C TBool

NativePixelSize

(

TSize &

aPixelSize

)

[virtual]

Reimplemented from CPicture::NativePixelSize(TSize &)

Returns the native pixel size of the bitmap.

Derived classes might be implemented as bitmaps, in that case it might be interesting to know this.

Parameters
aPixelSize	The pixel size

Return Value: TBool ETrue, if the derived classes are implemented as bitmaps; EFalse, otherwise.

ScaleFactorHeight ( )

IMPORT_C TInt

ScaleFactorHeight

(

)

const [virtual]

Reimplemented from CPicture::ScaleFactorHeight()const

Gets the Embedded Document height scale factor.

Return Value: The height scale factor, in percent

ScaleFactorWidth ( )

IMPORT_C TInt

ScaleFactorWidth

(

)

const [virtual]

Reimplemented from CPicture::ScaleFactorWidth()const

Gets the Embedded Document's width scale factor.

Return Value: The width scale factor, in percent

SetCropInTwips ( const TMargins & )

IMPORT_C void

SetCropInTwips

(

const TMargins &

aMargins

)

[virtual]

Reimplemented from CPicture::SetCropInTwips(const TMargins &)

Sets the cropping margins of a Embedded Document in twips. These are relative to the original unscaled size of the Embedded Document.

Parameters
aMargins	The cropping margins of the Embedded Document, in twips

SetScaleFactor ( TInt, TInt )

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

Reimplemented from CPicture::SetScaleFactor(TInt,TInt)

Sets the Embedded Document's scale factors

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

SetSource ( TUid )

void

SetSource

(

TUid

aSource

)

[inline]

Sets the UID that identifies this door when the source originates on a non-Symbian OS device.

This is used by converters.

Parameters
aSource	The UID for the non-Symbian OS source. For a source that originates on a Symbian OS phone, this is KNullUid.

Source ( )

TUid

Source

(

)

const [inline]

Gets the UID that identifies this door when the source originates on a non-Symbian OS device.

This is used by converters.

Return Value: The UID for the non-Symbian OS source. For a source that originates on a Symbian OS phone, this is KNullUid.

StoreL ( CStreamStore & )

IMPORT_C TStreamId

StoreL

(

CStreamStore &

aStore

)

const [virtual]

Reimplemented from CPicture::StoreL(CStreamStore &)const

Stores the Embedded Document to the specified store.

Parameters
aStore	The store containing the stream.

Return Value: The ID of the (head) stream used to store the Embedded Document