CCoeBrushAndPenContext Class Reference

#include <mw/coeccntx.h>

Link against: cone.lib

class CCoeBrushAndPenContext : public CBase, public MCoeControlContext

Inherits from

CCoeBrushAndPenContext
- CBase
- MCoeControlContext

Public Member Functions
IMPORT_C const CFbsBitmap &	BrushBitmap()
IMPORT_C TRgb	BrushColor()
IMPORT_C CWindowGc::TBrushStyle	BrushStyle()
IMPORT_C CCoeBrushAndPenContext *	NewL()
IMPORT_C TRgb	PenColor()
IMPORT_C void	SetBrushBitmap(const CFbsBitmap &)
IMPORT_C void	SetBrushColor(TRgb)
IMPORT_C void	SetBrushStyle(CWindowGc::TBrushStyle)
IMPORT_C void	SetPenColor(TRgb)

Protected Member Functions
virtual IMPORT_C void	PrepareContext(CWindowGc &)

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()
	MCoeControlContext::ActivateContext(CWindowGc &,RDrawableWindow &)const
	MCoeControlContext::MCoeControlContext()
	MCoeControlContext::ResetContext(CWindowGc &)const

Detailed Description

Brush and pen graphics context.

This class allows an MCoeControlContext to be instantiated and used to set brush and pen properties before drawing a control.

Member Function Documentation

BrushBitmap ( )

IMPORT_C const CFbsBitmap &

BrushBitmap

(

)

const

Gets a reference to the bitmap used to pattern the drawing brush.

Return Value: The pattern bitmap.

BrushColor ( )

IMPORT_C TRgb

BrushColor

(

)

const

Gets the brush colour.

Return Value: The current brush colour.

BrushStyle ( )

IMPORT_C CWindowGc::TBrushStyle

BrushStyle

(

)

const

Gets the brush style.

Return Value: The current brush style.

NewL ( )

IMPORT_C CCoeBrushAndPenContext *

NewL

(

)

[static]

Allocates and constructs a new brush and pen graphics context object.

Return Value: A pointer to the newly created object

PenColor ( )

IMPORT_C TRgb

PenColor

(

)

const

Gets the pen colour.

Return Value: The current pen colour.

PrepareContext ( CWindowGc & )

IMPORT_C void

PrepareContext

(

CWindowGc &

aGc

)

const [protected, virtual]

Reimplemented from MCoeControlContext::PrepareContext(CWindowGc &)const

Prepares the graphics context for drawing the control in its normal state.

The function uses the brush and pen properties which have been set, or uses a black pen and a black solid brush by default. When a bitmap has been set a patterned style brush is selected

Parameters
aGc	The window graphics context.

SetBrushBitmap ( const CFbsBitmap & )

IMPORT_C void

SetBrushBitmap

(

const CFbsBitmap &

aBitmap

)

Sets the drawing brush pattern bitmap.

When a bitmap has been set, a patterned style brush is selected automatically.

Parameters
aBitmap	The pattern bitmap.

SetBrushColor ( TRgb )

IMPORT_C void

SetBrushColor

(

TRgb

aColor

)

Sets the brush colour.

Parameters
aColor	The brush colour.

SetBrushStyle ( CWindowGc::TBrushStyle )

IMPORT_C void

SetBrushStyle

(

CWindowGc::TBrushStyle

aBrushStyle

)

Sets the brush style.

Parameters
aBrushStyle	The brush style to be used for drawing.

SetPenColor ( TRgb )

IMPORT_C void

SetPenColor

(

TRgb

aColor

)

Sets the pen colour.

Parameters
aColor	The pen colour.