Collapse all Symbian^3 Product Developer Library

MIHLFileImage Class Reference

class MIHLFileImage : public MIHLImage

Pure virtual interface for file based image class. This class acts as a window into single image or animation in one physical file. Note that file will be locked as long as instance of this class is present.

If interface needs to be pushed into CleanupStack, remember to use CleanupDeletePushL() function! DO NOT USE CleanupStack::PushL()!!

IHL.lib

Since: 3.0

Inherits from

MIHLFileImage
- MIHLImage

Public Member Functions
	~MIHLFileImage()
TInt	AnimationFrameCount()
TTimeIntervalMicroSeconds32	AnimationFrameDelay(TInt)
TRgb	BackgroundColor()
void	CancelLoad()
const RArray< TSize > &	CustomLoadSizeArray()
TDisplayMode	DisplayMode()
TInt	ImageCount()
TInt	ImageIndex()
const TUid &	ImageSubType()
const TUid &	ImageType()
TBool	IsAnimation()
TBool	IsBusy()
TBool	IsFullyScaleable()
TInt	Load(TRequestStatus &, MIHLBitmap &, TInt)
TInt	LoadAnimation(TRequestStatus &, MIHLBitmap &, TInt)
TDisplayMode	MaskDisplayMode()
void	SetFilter(MIHLFilter *)
TSize	Size()

Inherited Functions
	MIHLImage::Type()const
	MIHLImage::~MIHLImage()

Public Member Enumerations
enum	TOptions { EOptionNoDRMConsume = 0x01 }

Constructor & Destructor Documentation

~MIHLFileImage()

~MIHLFileImage

(

)

[inline, virtual]

Virtual destructor.

Member Functions Documentation

AnimationFrameCount()

TInt

AnimationFrameCount

(

)

const [pure virtual]

Return animation frame count. If image is not animated, it has no animation frames either.

Since: 3.0

AnimationFrameDelay(TInt)

TTimeIntervalMicroSeconds32

AnimationFrameDelay

(

TInt

aAnimationFrameIndex

)

const [pure virtual]

Return animation frame delay. If image is not animated, it has no animation frames either.

Since: 3.0

Parameters

TInt aAnimationFrameIndex

Animation frame index.

BackgroundColor()

TRgb

BackgroundColor

(

)

const [pure virtual]

Return image background color.

Since: 3.0

CancelLoad()

void

CancelLoad

(

)

[pure virtual]

Cancel pending load request. If not active, method does nothing.

Since: 3.0

CustomLoadSizeArray()

const RArray< TSize > &

CustomLoadSizeArray

(

)

const [pure virtual]

Return array of fixed load sizes which can be used in bitmap loading operation. Array contain only sizes that differs from image original size. If image can be loaded only to original size or it's fully scaleable, array is empty. Sizes starts from smallest and ends at largest.

Since: 3.0

DisplayMode()

TDisplayMode

DisplayMode

(

)

const [pure virtual]

Return preferred display mode for image. Note that this display mode may differ from images original display mode. Image processing may need more colors than image has originally.

Since: 3.0

ImageCount()

TInt

ImageCount

(

)

const [pure virtual]

Return count of images in source file. Note that animation is counted as an single image.

Since: 3.0

ImageIndex()

TInt

ImageIndex

(

)

const [pure virtual]

Return image index of this instance from source file. Note that animation is counted as an single image.

Since: 3.0

ImageSubType()

const TUid &

ImageSubType

(

)

const [pure virtual]

Return image subtype's unique identifier.

Since: 3.0

ImageType()

const TUid &

ImageType

(

)

const [pure virtual]

Return image type's unique identifier.

Since: 3.0

IsAnimation()

TBool

IsAnimation

(

)

const [pure virtual]

Check if image is animated.

Since: 3.0

IsBusy()

TBool

IsBusy

(

)

const [pure virtual]

Check if image has load request pending.

Since: 3.0

IsFullyScaleable()

TBool

IsFullyScaleable

(

)

const [pure virtual]

Check if image can be loaded directly into any given load size.

Since: 3.0

Load(TRequestStatus &, MIHLBitmap &, TInt)

TInt	Load	(	TRequestStatus &	aStatus,
			MIHLBitmap &	aDestination,
			TInt	aFrameIndex = 0
		)	[pure virtual]

Load image into bitmap. If using scale support, given bitmap must be created with wanted size from CustomLoadSizeArray(). Displaymode can be get from Displaymode() method. Mask bitmap is always reseted. It's recreated if image is transparent by using size of given bitmap and displaymode from MaskDisplayMode() method. If image is animated, first animation frame is loaded.

Since: 3.0

Parameters

TRequestStatus & aStatus	Load request status reference.
MIHLBitmap & aDestination	Destination bitmap reference.
TInt aFrameIndex = 0	for loading single frame from image

LoadAnimation(TRequestStatus &, MIHLBitmap &, TInt)

TInt	LoadAnimation	(	TRequestStatus &	aStatus,
			MIHLBitmap &	aDestination,
			TInt	aAnimationFrameIndex
		)	[pure virtual]

Load animation frame into bitmap. If using scale support, given bitmap must be created with wanted size from CustomLoadSizeArray(). Displaymode can be get from Displaymode() method. Because some animations are build on top of previous frames, passing already loaded previous frame as a destination bitmap will increase load speed of next frames. Method will panic if given animation frame index is out of bounds.

Since: 3.0

Parameters

TRequestStatus & aStatus	Load request status reference.
MIHLBitmap & aDestination	Destination bitmap reference.
TInt aAnimationFrameIndex	Animation frame index.

MaskDisplayMode()

TDisplayMode

MaskDisplayMode

(

)

const [pure virtual]

Return display mode of mask bitmap. If image doesn't support transparency, ENone is returned.

Since: 3.0

SetFilter(MIHLFilter *)

void

SetFilter

(

MIHLFilter *

aFilter

)

[pure virtual]

Set filter. For future use, not used currently!

Since: 3.0

Parameters

MIHLFilter * aFilter

Size()

TSize

Size

(

)

const [pure virtual]

Return image size.

Since: 3.0

Member Enumerations Documentation

Enum TOptions

Flags to control file image functionality. These can be combined using an OR operation.

Since: 3.0

Enumerators

EOptionNoDRMConsume = 0x01