MIHLBitmap Class Reference

class MIHLBitmap

MIHLBitmap

Pure virtual interface to bitmap and mask container.

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

IHL.lib
Since
3.0
Public Member Functions
~MIHLBitmap()
const CFbsBitmap &Bitmap()
TInt Copy(const CFbsBitmap &, TBool)
TInt Copy(const CFbsBitmap &, const CFbsBitmap &, TBool)
TInt Copy(const MIHLBitmap &, TBool)
TInt Create(const TSize &, TDisplayMode)
TInt Create(const TSize &, TDisplayMode, TDisplayMode)
voidDraw(CBitmapContext &, const TPoint &)
voidDraw(CBitmapContext &, const TPoint &, const TRect &)
TBool HasMask()
TBool IsCreated()
const CFbsBitmap &Mask()
voidReset()

Constructor & Destructor Documentation

~MIHLBitmap()

~MIHLBitmap()[inline, virtual]

Virtual destructor.

Member Functions Documentation

Bitmap()

const CFbsBitmap &Bitmap()const [pure virtual]
Return bitmap reference. Use MIHLBitmap::IsCreated() method to check if bitmap actually exist.
Since
3.0

Copy(const CFbsBitmap &, TBool)

TInt Copy(const CFbsBitmap &aBitmap,
TBoolaDuplicate
)[pure virtual]
Copy or duplicate bitmap. Copied bitmap has unique server handle and it can be modified without risk of changes in given source bitmap. Duplicated bitmap has same server handle than source bitmap and modifying duplicated bitmap will also modify source bitmap.
Since
3.0

Parameters

const CFbsBitmap & aBitmapSource bitmap that is copied or duplicated.
TBool aDuplicateETrue to duplicate, EFalse to copy.

Copy(const CFbsBitmap &, const CFbsBitmap &, TBool)

TInt Copy(const CFbsBitmap &aBitmap,
const CFbsBitmap &aMask,
TBoolaDuplicate
)[pure virtual]
Copy or duplicate bitmap and mask. Copied bitmaps has unique server handles and they can be modified without risk of changes in given source bitmaps. Duplicated bitmaps has same server handles than source bitmaps and modifying duplicated bitmaps will also modify source bitmaps.
Since
3.0

Parameters

const CFbsBitmap & aBitmapSource aMask that is copied or duplicated.
const CFbsBitmap & aMask
TBool aDuplicateETrue to duplicate, EFalse to copy.

Copy(const MIHLBitmap &, TBool)

TInt Copy(const MIHLBitmap &aBitmap,
TBoolaDuplicate
)[pure virtual]
Copy or duplicate MIHLBitmap. Copied bitmaps has unique server handles and they can be modified without risk of changes in given source bitmaps. Duplicated bitmaps has same server handles than source bitmaps and modifying duplicated bitmaps will also modify source bitmaps.
Since
3.0

Parameters

const MIHLBitmap & aBitmapSource MIHLBitmap that is copied or duplicated.
TBool aDuplicateETrue to duplicate, EFalse to copy.

Create(const TSize &, TDisplayMode)

TInt Create(const TSize &aSize,
TDisplayModeaDisplayMode
)[pure virtual]
Create new bitmap.
Since
3.0

Parameters

const TSize & aSizeBitmap size.
TDisplayMode aDisplayModeBitmap displaymode.

Create(const TSize &, TDisplayMode, TDisplayMode)

TInt Create(const TSize &aSize,
TDisplayModeaBitmapDisplayMode,
TDisplayModeaMaskDisplayMode
)[pure virtual]
Create new bitmap and mask.
Since
3.0

Parameters

const TSize & aSizeBitmap and mask size.
TDisplayMode aBitmapDisplayModeBitmap displaymode.
TDisplayMode aMaskDisplayModeMask displaymode (EGray2 or EGray256)

Draw(CBitmapContext &, const TPoint &)

voidDraw(CBitmapContext &aContext,
const TPoint &aPoint
)const [pure virtual]
Draw bitmap to bitmap context. If bitmaps are not created, method does nothing.
Since
3.0

Parameters

CBitmapContext & aContextBitmap context where bitmap is drawn.
const TPoint & aPointDraw position.

Draw(CBitmapContext &, const TPoint &, const TRect &)

voidDraw(CBitmapContext &aContext,
const TPoint &aPoint,
const TRect &aSourceRect
)const [pure virtual]
Draw bitmap to bitmap context. If bitmaps are not created, method does nothing.
Since
3.0

Parameters

CBitmapContext & aContextBitmap context where bitmap is drawn.
const TPoint & aPointDraw position.
const TRect & aSourceRectSource rectangle that is drawn.

HasMask()

TBool HasMask()const [pure virtual]
Check if mask bitmap handle is valid and exist.
Since
3.0

IsCreated()

TBool IsCreated()const [pure virtual]
Check if bitmap is created or copied. This checks that bitmap handle is valid and exist.
Since
3.0

Mask()

const CFbsBitmap &Mask()const [pure virtual]
Return mask reference. Use MIHLBitmap::HasMask() method to check if mask actually exist.
Since
3.0

Reset()

voidReset()[pure virtual]
Release bitmap and mask server handles. Create() and Copy() methods will call this automatically if any old bitmaps exist.
Since
3.0