Collapse all Symbian^3 Product Developer Library

MIHLBitmap Class Reference

class 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)
void	Draw(CBitmapContext &, const TPoint &)
void	Draw(CBitmapContext &, const TPoint &, const TRect &)
TBool	HasMask()
TBool	IsCreated()
const CFbsBitmap &	Mask()
void	Reset()

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,
			TBool	aDuplicate
		)	[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 & aBitmap	Source bitmap that is copied or duplicated.
TBool aDuplicate	ETrue to duplicate, EFalse to copy.

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

TInt	Copy	(	const CFbsBitmap &	aBitmap,
			const CFbsBitmap &	aMask,
			TBool	aDuplicate
		)	[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 & aBitmap	Source aMask that is copied or duplicated.
const CFbsBitmap & aMask
TBool aDuplicate	ETrue to duplicate, EFalse to copy.

Copy(const MIHLBitmap &, TBool)

TInt	Copy	(	const MIHLBitmap &	aBitmap,
			TBool	aDuplicate
		)	[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 & aBitmap	Source MIHLBitmap that is copied or duplicated.
TBool aDuplicate	ETrue to duplicate, EFalse to copy.

Create(const TSize &, TDisplayMode)

TInt	Create	(	const TSize &	aSize,
			TDisplayMode	aDisplayMode
		)	[pure virtual]

Create new bitmap.

Since: 3.0

Parameters

const TSize & aSize	Bitmap size.
TDisplayMode aDisplayMode	Bitmap displaymode.

Create(const TSize &, TDisplayMode, TDisplayMode)

TInt	Create	(	const TSize &	aSize,
			TDisplayMode	aBitmapDisplayMode,
			TDisplayMode	aMaskDisplayMode
		)	[pure virtual]

Create new bitmap and mask.

Since: 3.0

Parameters

const TSize & aSize	Bitmap and mask size.
TDisplayMode aBitmapDisplayMode	Bitmap displaymode.
TDisplayMode aMaskDisplayMode	Mask displaymode (EGray2 or EGray256)

Draw(CBitmapContext &, const TPoint &)

void	Draw	(	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 & aContext	Bitmap context where bitmap is drawn.
const TPoint & aPoint	Draw position.

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

void	Draw	(	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 & aContext	Bitmap context where bitmap is drawn.
const TPoint & aPoint	Draw position.
const TRect & aSourceRect	Source 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()

void

Reset

(

)

[pure virtual]

Release bitmap and mask server handles. Create() and Copy() methods will call this automatically if any old bitmaps exist.

Since: 3.0