Class CApaDoorBase

CApaDoorBase

Support

Supported from 5.0

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

CApaDoorBase The base class for the graphic representation of an embedded document 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 restoring the picture

Defined in CApaDoorBase:
EGlassDoor, EIconic, ETemporarilyIconic, ExternalizeBaseStreamL(), Format(), GlassDoorSize(), InternalizeBaseStreamL(), SetSource(), Source(), TFormat

Inherited from CBase:
operator new()

Inherited from CPicture:
AddCropInPixels(), Capability(), DetachFromStoreL(), Draw(), EDetachDraw, EDetachFull, ExternalizeL(), GetCropInTwips(), GetOriginalSizeInTwips(), GetSizeInPixels(), GetSizeInTwips(), LineBreakPossible(), ResetToOriginal(), ScaleFactorHeight(), ScaleFactorWidth(), SetCropInTwips(), SetScaleFactor(), SetSizeInPixels(), SetSizeInTwips(), StoreL(), TDetach

See also:

• CApaDoor
• CApaModelDoor

TFormat Format() const;

Description

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

Return value

TFormat The format for the representation of the embedded document.

void SetSource(TUid aSource);

Description

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

This is used by converters.

Parameters

TUid aSource The UID for the non-Symbian source. For source that originates on a Symbian platform, this is KNullUid.

TUid Source() const;

Description

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

This is used by converters.

Return value

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

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

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.