TFrameFormat Class Reference

#include <imageframe.h>

class TFrameFormat : public TFrameFormatBase

Inherits from

Public Member Functions
TFrameFormat(TUid)
IMPORT_C TUidColourSpace()
virtual IMPORT_C TFrameFormatBase *DuplicateL()
IMPORT_C TUidFormatCode()
IMPORT_C TUidSampling()
IMPORT_C voidSetColourSpace(TUid)
Inherited Functions
TFrameFormatBase::TFrameFormatBase(TUid)
TFrameFormatBase::Type()const

Detailed Description

This class is a specific implementation of TFrameFormatBase. An object of this class provides colour space and sampling information based on a specific image format code.

Constructor & Destructor Documentation

TFrameFormat ( TUid )

IMPORT_CTFrameFormat(TUidaFormatCode)[explicit]

Constructor for the TFrameFormat class.

See also: imageframeformats.hrh

Note:

If the format code is not recognised, the format code, colour space and sampling are initialised as KNullUid.

Parameters
aFormatCodeUnique UID specifying an image format code. The list of recognised formats is stored in file imageframeformats.hrh.

Member Function Documentation

ColourSpace ( )

IMPORT_C TUidColourSpace()const
Returns the colour space for the TFrameFormat object.
Note:

File imageframeconst.h contains the recognised colour space codes. These are named KUidColourSpaceXXX.

See also: imageframeconst.h

Return Value
The UID of the colour space.

DuplicateL ( )

IMPORT_C TFrameFormatBase *DuplicateL()const [virtual]

Reimplemented from TFrameFormatBase::DuplicateL()const

Creates an identical object to itself and places it on the heap.

Return Value
The pointer to the newly created object cast as its base class TFrameFormatBase.
Leave Codes
KErrNoMemory.

FormatCode ( )

IMPORT_C TUidFormatCode()const
Returns the format code which uniquely identifies the TFrameFormat object.
Note:

File imageframeconst.h contains the recognised format codes. These are named KUidFormatXXX.

See also: imageframeconst.h

Return Value
The UID of the format code.

Sampling ( )

IMPORT_C TUidSampling()const
Returns the sampling format for the TFrameFormat object.
Note:

File imageframeconst.h contains the recognised sampling codes. These are named KUidSamplingColorXXX.

See also: imageframeconst.h

Return Value
The UID of the sampling format.

SetColourSpace ( TUid )

IMPORT_C voidSetColourSpace(TUidaColourSpace)
Sets a new colour space.
Note:

File imageframeconst.h contains the recognised colour space codes. These are named KUidColourSpaceXXX.

See also: imageframeconst.h

Parameters
aColourSpaceThe UID of the new colour space.
© Nokia 2005.