CImageDisplay Class Reference

class CImageDisplay : public CBase

The public API for clients to call the Image Display library. This class provides functions to convert images stored in descriptors or files to bitmaps ready for display.

Inherits from

Public Member Functions
~CImageDisplay()
IMPORT_C TIntExtensionInterface(TUid, TAny *&)
IMPORT_C voidGetBitmap(const CFbsBitmap *&, const CFbsBitmap *&)
IMPORT_C TUintImageStatus()
IMPORT_C CImageDisplay *NewL(MIclImageDisplayObserver &, RFs &)
IMPORT_C TIntNumFrames(TInt &)
IMPORT_C voidPause()
IMPORT_C voidPlay()
IMPORT_C const RImageSizeArray &RecommendedImageSizes()
IMPORT_C voidReset()
IMPORT_C voidResetSourceRect()
IMPORT_C voidSetDisplayMode(TDisplayMode)
IMPORT_C TIntSetImageSource(const TMMSource &)
IMPORT_C TIntSetOptions(TUint)
IMPORT_C voidSetPluginUid(TUid)
IMPORT_C voidSetSizeInPixels(const TSize &, TBool)
IMPORT_C voidSetSourceImageType(TUid, TUid)
IMPORT_C voidSetSourceMimeType(const TDesC8 &)
IMPORT_C voidSetSourceRect(const TRect &)
IMPORT_C voidSetupL()
IMPORT_C voidStopPlay()
IMPORT_C TBoolValidBitmap()
Private Member Functions
CImageDisplay()
voidConstructL(MIclImageDisplayObserver &, RFs &)
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()
Public Member Enumerations
enumTImageOptions {
EOptionsUndefined = 0x00000000, EOptionThumbnail = 0x00000001, EOptionMainImage = 0x00000002, EOptionRotateCw90 = 0x00000004, EOptionRotateCw180 = 0x00000008, EOptionRotateCw270 = 0x00000010, EOptionMirrorHorizontal = 0x00000020, EOptionMirrorVertical = 0x00000040, EOptionAutoRotate = 0x00000080
}
enumTImageStatus {
EImageTypeUnknown = 0x00000000, EImageSingleFrame = 0x00000001, EImageMultiFrame = 0x00000002, EImageAnimated = 0x00000004, EImageMasked = 0x00000008, EImageHasThumbnail = 0x00000010, EImageIsFullyScalable = 0x00000020
}
Public Member Type Definitions
typedef RArray< TSize > RImageSizeArray
Private Attributes
CImageDisplayFramework *iBody

Constructor & Destructor Documentation

CImageDisplay()

CImageDisplay()[private]

~CImageDisplay()

IMPORT_C~CImageDisplay()

Member Functions Documentation

ConstructL(MIclImageDisplayObserver &, RFs &)

voidConstructL(MIclImageDisplayObserver &aCallback,
RFs &aFs
)[private]

Parameters

MIclImageDisplayObserver & aCallback
RFs & aFs

ExtensionInterface(TUid, TAny *&)

IMPORT_C TIntExtensionInterface(TUidaIFaceUid,
TAny *&aIFacePtr
)

Parameters

TUid aIFaceUid
TAny *& aIFacePtr

GetBitmap(const CFbsBitmap *&, const CFbsBitmap *&)

IMPORT_C voidGetBitmap(const CFbsBitmap *&aBitmap,
const CFbsBitmap *&aMask
)const

Parameters

const CFbsBitmap *& aBitmap
const CFbsBitmap *& aMask

ImageStatus()

IMPORT_C TUintImageStatus()const

NewL(MIclImageDisplayObserver &, RFs &)

IMPORT_C CImageDisplay *NewL(MIclImageDisplayObserver &aCallback,
RFs &aFs
)[static]

Parameters

MIclImageDisplayObserver & aCallback
RFs & aFs

NumFrames(TInt &)

IMPORT_C TIntNumFrames(TInt &aNumFrames)const

Parameters

TInt & aNumFrames

Pause()

IMPORT_C voidPause()

Play()

IMPORT_C voidPlay()

RecommendedImageSizes()

IMPORT_C const RImageSizeArray &RecommendedImageSizes()const

Reset()

IMPORT_C voidReset()

ResetSourceRect()

IMPORT_C voidResetSourceRect()

SetDisplayMode(TDisplayMode)

IMPORT_C voidSetDisplayMode(TDisplayModeaDisplayMode)

Parameters

TDisplayMode aDisplayMode

SetImageSource(const TMMSource &)

IMPORT_C TIntSetImageSource(const TMMSource &aSource)

Parameters

const TMMSource & aSource

SetOptions(TUint)

IMPORT_C TIntSetOptions(TUintaOptions)

Parameters

TUint aOptions

SetPluginUid(TUid)

IMPORT_C voidSetPluginUid(TUidaPluginUid)

Parameters

TUid aPluginUid

SetSizeInPixels(const TSize &, TBool)

IMPORT_C voidSetSizeInPixels(const TSize &aSize,
TBoolaMaintainAspectRatio = ETrue
)

Parameters

const TSize & aSize
TBool aMaintainAspectRatio = ETrue

SetSourceImageType(TUid, TUid)

IMPORT_C voidSetSourceImageType(TUidaImageType,
TUidaImageSubType = KNullUid
)

Parameters

TUid aImageType
TUid aImageSubType = KNullUid

SetSourceMimeType(const TDesC8 &)

IMPORT_C voidSetSourceMimeType(const TDesC8 &aMIMEType)

Parameters

const TDesC8 & aMIMEType

SetSourceRect(const TRect &)

IMPORT_C voidSetSourceRect(const TRect &aRect)

Parameters

const TRect & aRect

SetupL()

IMPORT_C voidSetupL()

StopPlay()

IMPORT_C voidStopPlay()

ValidBitmap()

IMPORT_C TBoolValidBitmap()const

Member Enumerations Documentation

Enum TImageOptions

Flags to control how the image is handled These can be combined using an OR operation. Note that the rotate and mirror options have to be set together with EOptionThumbnail or EOptionMainImage.

Enumerators

EOptionsUndefined = 0x00000000

No options defined

EOptionThumbnail = 0x00000001

Use the thumbnail image as source

EOptionMainImage = 0x00000002

Use the main image as source

EOptionRotateCw90 = 0x00000004

Rotate the image by 90 degrees clockwise

EOptionRotateCw180 = 0x00000008

Rotate the image by 180 degrees clockwise

EOptionRotateCw270 = 0x00000010

Rotate the image by 270 degrees clockwise

EOptionMirrorHorizontal = 0x00000020

Mirror an image about the horizontal axis

EOptionMirrorVertical = 0x00000040

Mirror an image about the vertical axis

EOptionAutoRotate = 0x00000080

Rotate the image automatically (if necessary)

Enum TImageStatus

Return flags from ImageStatus()

Enumerators

EImageTypeUnknown = 0x00000000

ImageStatus is unknown

EImageSingleFrame = 0x00000001

Image is single frame

EImageMultiFrame = 0x00000002

Image is multiframe

EImageAnimated = 0x00000004

Image is animated

EImageMasked = 0x00000008

Image has got a mask/alpha channel

EImageHasThumbnail = 0x00000010

Image has got a thumbnail

EImageIsFullyScalable = 0x00000020

Image is fully scalable i.e. arbitrary scaling can be perofmed quite quickly

Member Type Definitions Documentation

Typedef RImageSizeArray

typedef RArray< TSize >RImageSizeArray

An array containing the sizes of images.

Member Data Documentation

CImageDisplayFramework * iBody

CImageDisplayFramework *iBody[private]
© Nokia 2010.