CApaDoorBase in Application Framework Application

class CApaDoorBase : public CPicture;

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.

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.

Members

Defined in CApaDoorBase:

CApaDoorBase()
CApaDoorBase_Reserved1()Reserved for future use
CApaDoorBase_Reserved2()Reserved for future use
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...
GlassDoorSize()constReturns the size of the glass door, in twips.
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.
ScaleFactorHeight()constGets the Embedded Document height scale factor.
ScaleFactorWidth()constGets the Embedded Document's width scale factor.
SetCropInTwips(const TMargins &)Sets the cropping margins of a Embedded Document in twips. These are relative to...
SetScaleFactor(TInt,TInt)Sets the Embedded Document's scale factors
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...
StoreL(CStreamStore &)constStores the Embedded Document to the specified store.
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.
DetachFromStoreL(TDetach)
Draw(CGraphicsContext &,const TPoint &,const TRect &,MGraphicsDeviceMap *)constDraws a 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...
ExternalizeL(RWriteStream &)constExternalises the picture to a stream.
GetOriginalSizeInTwips(TSize &)constGets the pictur's original size, in twips.
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...

Description

inline TFormat Format() const;

Description

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

Return value


                                 						CApaDoorBase::TFormat

The format for the representation of the embedded document.

inline TUid Source() const;

Description

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

This is used by converters.

Return value


                                 						TUid

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

inline void SetSource(TUid aSource);

Description

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.

IMPORT_C virtual TStreamId StoreL(CStreamStore &aStore) const;

Description

Stores the Embedded Document to the specified store.

Parameters


                                 						CStreamStore &aStore

The store containing the stream.

Return value

TStreamId

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

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

Description

Sets the Embedded Document's scale factors

Parameters

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

IMPORT_C virtual void SetCropInTwips(const TMargins &aMargins);

Description

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

IMPORT_C virtual TPictureCapability Capability() const;

Description

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

Return value

TPictureCapability

The capabilities of the Embedded Document

IMPORT_C virtual void GetCropInTwips(TMargins &aMargins) const;

Description

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

IMPORT_C virtual TInt ScaleFactorWidth() const;

Description

Gets the Embedded Document's width scale factor.

Return value

TInt

The width scale factor, in percent

IMPORT_C virtual TInt ScaleFactorHeight() const;

Description

Gets the Embedded Document height scale factor.

Return value

TInt

The height scale factor, in percent

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

Description

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

Return value

TBool

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

IMPORT_C virtual TBool NativePixelSize(TSize &aPixelSize);

Description

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

Return value

TBool

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

protected: IMPORT_C void ExternalizeBaseStreamL(CStreamStore &aStore, CStreamDictionary &aStreamDict) const;

Description

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

protected: IMPORT_C TSize InternalizeBaseStreamL(const CStreamStore &aStore, const CStreamDictionary &aStreamDict);

Description

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.

Return value

TSize

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

private: IMPORT_C virtual void CApaDoorBase_Reserved1();

Description

Reserved for future use

private: IMPORT_C virtual void CApaDoorBase_Reserved2();

Description

Reserved for future use

protected: virtual TSize GlassDoorSize() const=0;

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.

TFormat

Description

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

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

protected: TFormat iFormat;

Description

protected: TUid iSource;

Class CApaDoorBase

Description

Derivation

Members

See also:

Construction and destruction

CApaDoorBase()

Description

Member functions

Format()const

Description

Return value

Source()const

Description

Return value

SetSource(TUid)

Description

Parameters

StoreL(CStreamStore &)const

Description

Parameters

Return value

SetScaleFactor(TInt,TInt)

Description

Parameters

SetCropInTwips(const TMargins &)

Description

Parameters

Capability()const

Description

Return value

GetCropInTwips(TMargins &)const

Description

Parameters

ScaleFactorWidth()const

Description

Return value

ScaleFactorHeight()const

Description

Return value

LineBreakPossible(TUint,TBool,TBool)const

Description

Parameters

Return value

NativePixelSize(TSize &)

Description

Parameters

Return value

ExternalizeBaseStreamL(CStreamStore &,CStreamDictionary &)const

Description

Parameters

InternalizeBaseStreamL(const CStreamStore &,const CStreamDictionary &)

Description

Parameters

Return value

CApaDoorBase_Reserved1()

Description

CApaDoorBase_Reserved2()

Description

GlassDoorSize()const

Description

Return value

Member enumerations

Enum TFormat

Description

Member data

iFormat

Description

iSource

Description

Class `CApaDoorBase`

`CApaDoorBase()`

`Format()const`

`Source()const`

`SetSource(TUid)`

`StoreL(CStreamStore &)const`

`SetScaleFactor(TInt,TInt)`

`SetCropInTwips(const TMargins &)`

`Capability()const`

`GetCropInTwips(TMargins &)const`

`ScaleFactorWidth()const`

`ScaleFactorHeight()const`

`LineBreakPossible(TUint,TBool,TBool)const`

`NativePixelSize(TSize &)`

`ExternalizeBaseStreamL(CStreamStore &,CStreamDictionary &)const`

`InternalizeBaseStreamL(const CStreamStore &,const CStreamDictionary &)`

`CApaDoorBase_Reserved1()`

`CApaDoorBase_Reserved2()`

`GlassDoorSize()const`

Enum `TFormat`

`iFormat`

`iSource`