Symbian Developer Library

SYMBIAN OS V6.1 EDITION FOR C++

[Index] [Glossary] [Previous] [Next]



Location: apgdoor.h
Link against: apgrfx.lib

Class TApaPictureFactory

TApaPictureFactory

Support

Supported from 5.0

Description

A factory class for instantiating and restoring an application's door.

A door factory object is constructed by the UI environment and can be accessed by calling CEikonEnv::PictureFactory().

Derivation

MPictureFactoryAbstract interface for instantiating and restoring new CPicture derived objects
TApaPictureFactoryA factory class for instantiating and restoring an application's door

Defined in TApaPictureFactory:
NewPictureL(), SetIconSize(), TApaPictureFactory()

See also:


Construction


TApaPictureFactory()

TApaPictureFactory(CApaProcess* aAppProcess);

Description

Constructs a door factory object for the specified application process.

Parameters

CApaProcess* aAppProcess

The application process.

[Top]


Member functions


NewPictureL()

void NewPictureL(TPictureHeader& aPictureHeader,const CStreamStore& aPictureStore) const;

Description

Constructs and restores an application's door (picture) from a stream in the specified store.

The restored door is a CApaDoor type object.

Note that the function can leave with KErrNoMemory if creation of the CApaDoor object fails.

Parameters

TPictureHeader& aPictureHeader

The header identifying the door to be restored. The UID identifying the door must be KUidPictureTypeDoor, otherwise the function leaves with KErrNotSupported. On entry, the door picture must be represented by a stream ID, otherwise the function leaves with KErrBadHandle; on return, the door picture is represented by a pointer to an internalized CApaDoor object.

const CStreamStore& aPictureStore

The store from which the door will be restored.

See also:


SetIconSize()

void SetIconSize(TSize aIconSizeInTwips);

Description

Sets the size of the icon.

Parameters

TSize aIconSizeInTwips

The size of the icon, in twips.