Class CCoeBrushAndPenContext

CCoeBrushAndPenContext

Support

Supported from 5.1

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.

Derivation

CBase Base class for all classes to be instantiated on the heap CCoeBrushAndPenContext Brush and pen graphics context MCoeControlContext Interface to allow sharing of graphics settings between controls

Defined in CCoeBrushAndPenContext:
BrushBitmap(), BrushColor(), BrushStyle(), NewL(), PenColor(), PrepareContext(), SetBrushBitmap(), SetBrushColor(), SetBrushStyle(), SetPenColor()

Inherited from CBase:
operator new()

Inherited from MCoeControlContext:
ActivateContext(), ResetContext()

static CCoeBrushAndPenContext* NewL();

Description

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

Return value

CCoeBrushAndPenContext* A pointer to the newly created object

const CFbsBitmap& BrushBitmap() const;

Description

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

Return value

CFbsBitmap& The pattern bitmap.

TRgb BrushColor() const;

Description

Gets the brush colour.

Return value

TRgb The current brush colour.

CWindowGc::TBrushStyle BrushStyle() const;

Description

Gets the brush style.

Return value

CWindowGc::TBrushStyle The current brush style.

TRgb PenColor() const;

Description

Gets the pen colour.

Return value

TRgb The current pen colour.

void SetBrushBitmap(const CFbsBitmap& aBitmap);

Description

Sets the drawing brush pattern bitmap. When a bitmap has been set a patterned style brush is selected automatically.

Parameters

const CFbsBitmap& aBitmap The pattern bitmap.

void SetBrushColor(TRgb aColor);

Description

Sets the brush colour.

Parameters

TRgb aColor The brush colour.

void SetBrushStyle(CWindowGc::TBrushStyle aBrushStyle);

Description

Sets the brush style.

Parameters

CWindowGc::TBrushStyle aBrushStyle The brush style to be used for drawing.

void SetPenColor(TRgb aColor);

Description

Sets the pen colour.

Parameters

TRgb aColor The pen colour.

protected: void PrepareContext(CWindowGc& aGc) const;

Description

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

CWindowGc& aGc The window graphics context.