Class CCoeBrushAndPenContext

class CCoeBrushAndPenContext : public CBase, public MCoeControlContext;

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

• MCoeControlContext - Interface to allow sharing of graphics settings between controls.
• CBase - Base class for all classes to be instantiated on the heap.

• CCoeBrushAndPenContext - Brush and pen graphics context.

Members

Defined in CCoeBrushAndPenContext:

• BrushBitmap()constGets a reference to the bitmap used to pattern the drawing brush.
• BrushColor()constGets the brush colour.
• BrushStyle()constGets the brush style.
• NewL()Allocates and constructs a new brush and pen graphics context object.
• PenColor()constGets the pen colour.
• PrepareContext(CWindowGc &)constPrepares the graphics context for drawing the control in its normal state.
• SetBrushBitmap(const CFbsBitmap &)Sets the drawing brush pattern bitmap.
• SetBrushColor(TRgb)Sets the brush colour.
• SetPenColor(TRgb)Sets the pen colour.

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

Inherited from MCoeControlContext:

• ActivateContext(CWindowGc &,RDrawableWindow &)constActivates a graphics context for the specified window.
• ResetContext(CWindowGc &)constResets the control context.

IMPORT_C 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

IMPORT_C void SetBrushStyle(CWindowGc::TBrushStyle aBrushStyle);

Description

Sets the brush style.

Parameters

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

IMPORT_C void SetBrushColor(TRgb aColor);

Description

Sets the brush colour.

Parameters

TRgb aColor The brush colour.

IMPORT_C 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.

IMPORT_C void SetPenColor(TRgb aColor);

Description

Sets the pen colour.

Parameters

TRgb aColor The pen colour.

IMPORT_C CWindowGc::TBrushStyle BrushStyle() const;

Description

Gets the brush style.

Return value

CGraphicsContext::TBrushStyle The current brush style.

IMPORT_C TRgb BrushColor() const;

Description

Gets the brush colour.

Return value

TRgb The current brush colour.

IMPORT_C const CFbsBitmap& BrushBitmap() const;

Description

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

Return value

const CFbsBitmap & The pattern bitmap.

IMPORT_C TRgb PenColor() const;

Description

Gets the pen colour.

Return value

TRgb The current pen colour.

protected: IMPORT_C virtual 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.