TImageBitmapUtil Class Reference

#include <icl/imageprocessor.h>

class TImageBitmapUtil
Public Member Functions
TImageBitmapUtil()
IMPORT_C voidBegin()
IMPORT_C TBoolBegin(const TPoint &)
IMPORT_C voidEnd()
IMPORT_C voidSetBitmapL(CFbsBitmap *)
IMPORT_C voidSetPixel(TUint32)
IMPORT_C voidSetPixels(TUint32 *, TInt)
IMPORT_C TBoolSetPos(const TPoint &)

Detailed Description

Bitmap utility class.

Constructor & Destructor Documentation

TImageBitmapUtil ( )

IMPORT_CTImageBitmapUtil()

Default constructor for this class.

Member Function Documentation

Begin ( )

IMPORT_C voidBegin()

Requests a lock for the current bitmap from the font & bitmap server and sets the current position in the bitmap to the first pixel.

Begin ( const TPoint & )

IMPORT_C TBoolBegin(const TPoint &aPosition)

Requests a lock for the current bitmap from the font & bitmap server and sets the current position in the bitmap to aPosition.

Parameters
aPositionThe position to move to.
Return Value
A boolean indicating if the position was out of bounds. EFalse if the position was out of bounds, otherwise ETrue.

End ( )

IMPORT_C voidEnd()

Releases a lock previously acquired using TImageBitmapUtil::Begin().

SetBitmapL ( CFbsBitmap * )

IMPORT_C voidSetBitmapL(CFbsBitmap *aBitmap)

Sets the current bitmap to aBitmap.

Parameters
aBitmapA pointer to the bitmap.
Leave Codes
KErrNotFoundThe bitmap or its handle is NULL or its display mode is not recognised.

SetPixel ( TUint32 )

IMPORT_C voidSetPixel(TUint32aPixelIndex)

Sets the pixel value at the current bitmap position using aPixelIndex.

Post-condition
The current position is updated.
Parameters
aPixelIndexThe pixel index.

SetPixels ( TUint32 *, TInt )

IMPORT_C voidSetPixels(TUint32 *aPixelIndex,
TIntaNumberOfPixels
)

Sets an array of pixel values, starting at the current bitmap position using the values supplied in aPixelIndex.

Post-condition
The current position is updated.
Parameters
aPixelIndexA pointer to the first element in the array.
aNumberOfPixelsThe number of elements in the array.

SetPos ( const TPoint & )

IMPORT_C TBoolSetPos(const TPoint &aPosition)

Sets the current position in the bitmap to aPosition.

Parameters
aPositionThe position to move to.
Return Value
A boolean indicating if the position was out of bounds. EFalse if the position was out of bounds, otherwise ETrue.
© Nokia 2005.