Collapse all Symbian^3 Application Developer Library

CApaDoorBase Class Reference

class CApaDoorBase : public CPicture

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.

CApaDoor CApaModelDoor

Inherits from

CApaDoorBase
- CPicture
  - CBase

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

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

Private Member Functions
IMPORT_C void	CApaDoorBase_Reserved1 ()
IMPORT_C void	CApaDoorBase_Reserved2 ()

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()

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

Inherited Enumerations
	CPicture:TDetach

Protected Attributes
TFormat	iFormat
TUid	iSource

Private Attributes
TInt	iCApaDoorBase_Spare1

Constructor & Destructor Documentation

CApaDoorBase()

IMPORT_C

CApaDoorBase

(

)

[protected]

Member Functions Documentation

CApaDoorBase_Reserved1()

IMPORT_C void

CApaDoorBase_Reserved1

(

)

[private, virtual]

Reserved for future use

CApaDoorBase_Reserved2()

IMPORT_C void

CApaDoorBase_Reserved2

(

)

[private, virtual]

Reserved for future use

Capability()

IMPORT_C TPictureCapability

Capability

(

)

const [virtual]

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

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

CStreamStore & aStore	The store to contain the stream.
CStreamDictionary & 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.

GetCropInTwips(TMargins &)

IMPORT_C void

GetCropInTwips

(

TMargins &

aMargins

)

const [virtual]

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

Parameters

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

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

const CStreamStore & aStore	The store containing the stream.
const CStreamDictionary & aStreamDict	The steam dictionary containing the stream ID.

LineBreakPossible(TUint, TBool, TBool)

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

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

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

NativePixelSize(TSize &)

IMPORT_C TBool

NativePixelSize

(

TSize &

aPixelSize

)

[virtual]

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

TSize & aPixelSize

The pixel size

ScaleFactorHeight()

IMPORT_C TInt

ScaleFactorHeight

(

)

const [virtual]

Gets the Embedded Document height scale factor.

ScaleFactorWidth()

IMPORT_C TInt

ScaleFactorWidth

(

)

const [virtual]

Gets the Embedded Document's width scale factor.

SetCropInTwips(const TMargins &)

IMPORT_C void

SetCropInTwips

(

const TMargins &

aMargins

)

[virtual]

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

Parameters

const TMargins & aMargins

The cropping margins of the Embedded Document, in twips

SetScaleFactor(TInt, TInt)

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

Sets the Embedded Document's scale factors

Parameters

TInt aScaleFactorWidth	The width scale factor, in percent
TInt 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

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

StoreL(CStreamStore &)

IMPORT_C TStreamId

StoreL

(

CStreamStore &

aStore

)

const [virtual]

Stores the Embedded Document to the specified store.

Parameters

CStreamStore & aStore

The store containing the stream.

Member Enumerations Documentation

Enum TFormat

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

Enumerators

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.

Member Data Documentation

TInt iCApaDoorBase_Spare1

TInt

iCApaDoorBase_Spare1

[private]

TFormat iFormat

TFormat

iFormat

[protected]

TUid iSource

TUid

iSource

[protected]