Symbian^3 Product Developer Library >

MDirectGdiEngine Class Reference

class MDirectGdiEngine

Pure virtual interface for licensee adaptation of GDI platform implementation.

Public Member Functions
TInt Activate(RDirectGdiImageTarget &)
voidBeginDrawGlyph()
voidBitBlt(const TPoint &, const CFbsBitmap &, const TRect &)
voidBitBltMasked(const TPoint &, const CFbsBitmap &, const TRect &, const CFbsBitmap &, TBool)
voidBitBltMasked(const TPoint &, const CFbsBitmap &, const TRect &, const CFbsBitmap &, const TPoint &)
voidClear(const TRect &)
voidClear()
voidCopyRect(const TPoint &, const TRect &)
voidDeactivate()
voidDrawArc(const TRect &, const TPoint &, const TPoint &)
voidDrawBitmap(const TRect &, const CFbsBitmap &, const TRect &)
voidDrawBitmapMasked(const TRect &, const CFbsBitmap &, const TRect &, const CFbsBitmap &, TBool)
voidDrawEllipse(const TRect &)
voidDrawGlyph(const TPoint &, const TChar, const TUint8 *, const TGlyphBitmapType, const TSize &, const TRect &, const DirectGdi::TGraphicsRotation)
voidDrawLine(const TPoint &, const TPoint &)
voidDrawLineBy(const TPoint &)
voidDrawLineTo(const TPoint &)
voidDrawPie(const TRect &, const TPoint &, const TPoint &)
voidDrawPolyLine(const TArray< TPoint > &)
voidDrawPolyLineNoEndPoint(const TArray< TPoint > &)
voidDrawPolygon(const TArray< TPoint > &, DirectGdi::TFillRule)
voidDrawRect(const TRect &)
voidDrawResource(const TPoint &, const RDirectGdiDrawableSource &, DirectGdi::TGraphicsRotation)
voidDrawResource(const TRect &, const RDirectGdiDrawableSource &, DirectGdi::TGraphicsRotation)
voidDrawResource(const TRect &, const RDirectGdiDrawableSource &, const TRect &, DirectGdi::TGraphicsRotation)
voidDrawResource(const TRect &, const RDirectGdiDrawableSource &, const TDesC8 &)
voidDrawRoundRect(const TRect &, const TSize &)
voidEndDrawGlyph()
voidExternalizeL(RWriteStream &)
TInt GetInterface(TUid, TAny *&)
voidInternalizeL(RReadStream &)
voidMoveBy(const TPoint &)
voidMoveTo(const TPoint &)
voidPlot(const TPoint &)
voidReset()
voidResetBrushPattern()
voidResetClippingRegion()
voidResetFont()
voidSetBrushColor(const TRgb &)
voidSetBrushOrigin(const TPoint &)
TInt SetBrushPattern(const CFbsBitmap &)
voidSetBrushStyle(DirectGdi::TBrushStyle)
voidSetClippingRegion(const TRegion &)
voidSetDrawMode(DirectGdi::TDrawMode)
voidSetFont(TUint32)
voidSetOrigin(const TPoint &)
voidSetPenColor(const TRgb &)
voidSetPenSize(const TSize &)
voidSetPenStyle(DirectGdi::TPenStyle)
voidSetTextShadowColor(const TRgb &)

Member Functions Documentation

Activate(RDirectGdiImageTarget &)

TInt Activate(RDirectGdiImageTarget &aTarget)[pure virtual]

CDirectGdiContext::Activate() Deactivate()

Parameters

RDirectGdiImageTarget & aTarget

BeginDrawGlyph()

voidBeginDrawGlyph()[pure virtual]

Prepares the drawing engine for drawing text as multiple DrawGlyph() commands. This function must always have a corresponding call to EndDrawGlyph() after the multiple DrawGlyph() commands have been made. Other than DrawGlyph(), no other rendering should be issued to the engine until EndDrawGlyph() has been called.

EndDrawGlyph() DrawGlyph()
Pre-condition
None.
Post-condition
None.

BitBlt(const TPoint &, const CFbsBitmap &, const TRect &)

voidBitBlt(const TPoint &aDestPos,
const CFbsBitmap &aBitmap,
const TRect &aSourceRect
)[pure virtual]

CDirectGdiContext::BitBlt(const TPoint&, const CFbsBitmap&, const TRect&)

Parameters

const TPoint & aDestPos
const CFbsBitmap & aBitmap
const TRect & aSourceRect

BitBltMasked(const TPoint &, const CFbsBitmap &, const TRect &, const CFbsBitmap &, TBool)

voidBitBltMasked(const TPoint &aDestPos,
const CFbsBitmap &aBitmap,
const TRect &aSourceRect,
const CFbsBitmap &aMask,
TBoolaInvertMask
)[pure virtual]

CDirectGdiContext::BitBltMasked(const TPoint&, const CFbsBitmap&, const TRect&, const CFbsBitmap&, TBool)

Parameters

const TPoint & aDestPos
const CFbsBitmap & aBitmap
const TRect & aSourceRect
const CFbsBitmap & aMask
TBool aInvertMask

BitBltMasked(const TPoint &, const CFbsBitmap &, const TRect &, const CFbsBitmap &, const TPoint &)

voidBitBltMasked(const TPoint &aDestPos,
const CFbsBitmap &aBitmap,
const TRect &aSourceRect,
const CFbsBitmap &aMask,
const TPoint &aMaskPos
)[pure virtual]

CDirectGdiContext::BitBltMasked(const TPoint&, const CFbsBitmap&, const TRect&, const CFbsBitmap&, const TPoint&)

Parameters

const TPoint & aDestPos
const CFbsBitmap & aBitmap
const TRect & aSourceRect
const CFbsBitmap & aMask
const TPoint & aMaskPos

Clear(const TRect &)

voidClear(const TRect &aRect)[pure virtual]

CDirectGdiContext::Clear(const TRect&) Clear() SetBrushColor()

Parameters

const TRect & aRect

Clear()

voidClear()[pure virtual]

CDirectGdiContext::Clear() Clear(const TRect&) SetBrushColor()

CopyRect(const TPoint &, const TRect &)

voidCopyRect(const TPoint &aOffset,
const TRect &aRect
)[pure virtual]

Copies the contents of a rectangular area on the target to another location. The source rectangle will be intersected with the full extent of the target.

Pre-condition
The rendering target has been activated.
Post-condition
Request to copy an area has been accepted. There is no guarantee that the request has been processed when this method returns.

Parameters

const TPoint & aOffsetOffset from the top left corner of the rectangle to be copied to the top left corner of the copy.
const TRect & aRectArea to be copied.

Deactivate()

voidDeactivate()[pure virtual]

Unbinds the current rendering target (if any) from drawing engine. Drawing engine states or settings which are not dependent or non-target-specific remain unchanged.

The DirectGDI generic layer will call this method prior to activating the drawing engine for another rendering target.

Activate()
Pre-condition
None.
Post-condition
Drawing engine is no longer associated with any rendering target.

DrawArc(const TRect &, const TPoint &, const TPoint &)

voidDrawArc(const TRect &aRect,
const TPoint &aStart,
const TPoint &aEnd
)[pure virtual]

CDirectGdiContext::DrawArc() DrawPie()

Parameters

const TRect & aRect
const TPoint & aStart
const TPoint & aEnd

DrawBitmap(const TRect &, const CFbsBitmap &, const TRect &)

voidDrawBitmap(const TRect &aDestRect,
const CFbsBitmap &aBitmap,
const TRect &aSourceRect
)[pure virtual]

CDirectGdiContext::DrawBitmap(const TRect&, const CFbsBitmap&, const TRect&)

Parameters

const TRect & aDestRect
const CFbsBitmap & aBitmap
const TRect & aSourceRect

DrawBitmapMasked(const TRect &, const CFbsBitmap &, const TRect &, const CFbsBitmap &, TBool)

voidDrawBitmapMasked(const TRect &aDestRect,
const CFbsBitmap &aBitmap,
const TRect &aSourceRect,
const CFbsBitmap &aMask,
TBoolaInvertMask
)[pure virtual]

CDirectGdiContext::DrawBitmapMasked(const TRect&, const CFbsBitmap&, const TRect&, const CFbsBitmap&, TBool)

Parameters

const TRect & aDestRect
const CFbsBitmap & aBitmap
const TRect & aSourceRect
const CFbsBitmap & aMask
TBool aInvertMask

DrawEllipse(const TRect &)

voidDrawEllipse(const TRect &aRect)[pure virtual]

CDirectGdiContext::DrawEllipse()

Parameters

const TRect & aRect

DrawGlyph(const TPoint &, const TChar, const TUint8 *, const TGlyphBitmapType, const TSize &, const TRect &, const DirectGdi::TGraphicsRotation)

voidDrawGlyph(const TPoint &aPos,
const TCharaChar,
const TUint8 *aGlyphImage,
const TGlyphBitmapTypeaBitmapType,
const TSize &aGlyphImageSize,
const TRect &aClipRect,
const DirectGdi::TGraphicsRotationaRotation = DirectGdi::EGraphicsRotationNone
)[pure virtual]

Draws a glyph.

Pre-condition
The rendering target has been activated.
Post-condition
Request to draw the glyph has been accepted.

Parameters

const TPoint & aPosPosition to start drawing the glyph after rotation has been applied (if necessary).
const TChar aCharCharacter being drawn.
const TUint8 * aGlyphImagePointer to the glyph image data.
const TGlyphBitmapType aBitmapTypeType of bitmap format.
const TSize & aGlyphImageSizeGlyph image size.
const TRect & aClipRectClipping rect.
const DirectGdi::TGraphicsRotation aRotation = DirectGdi::EGraphicsRotationNoneRotation specifying how the glyph will be drawn.

DrawLine(const TPoint &, const TPoint &)

voidDrawLine(const TPoint &aStart,
const TPoint &aEnd
)[pure virtual]

CDirectGdiContext::DrawLine() DrawLineTo() DrawLineBy() SetPenSize() SetPenStyle() SetPenColor() SetDrawMode()

Parameters

const TPoint & aStart
const TPoint & aEnd

DrawLineBy(const TPoint &)

voidDrawLineBy(const TPoint &aVector)[pure virtual]

CDirectGdiContext::DrawLineBy() DrawLine() DrawLineTo() SetPenSize() SetPenStyle() SetPenColor() DrawMode() MoveTo() MoveBy()

Parameters

const TPoint & aVector

DrawLineTo(const TPoint &)

voidDrawLineTo(const TPoint &aPoint)[pure virtual]

CDirectGdiContext::DrawLineTo() DrawLine() DrawLineBy() SetPenSize() SetPenStyle() SetPenColor() SetDrawMode() MoveTo() MoveBy()

Parameters

const TPoint & aPoint

DrawPie(const TRect &, const TPoint &, const TPoint &)

voidDrawPie(const TRect &aRect,
const TPoint &aStart,
const TPoint &aEnd
)[pure virtual]

CDirectGdiContext::DrawPie()

Parameters

const TRect & aRect
const TPoint & aStart
const TPoint & aEnd

DrawPolyLine(const TArray< TPoint > &)

voidDrawPolyLine(const TArray< TPoint > &aPointList)[pure virtual]

CDirectGdiContext::DrawPolyLine() SetPenColor() SetPenSize() SetPenStyle() SetDrawMode()

Parameters

const TArray< TPoint > & aPointList

DrawPolyLineNoEndPoint(const TArray< TPoint > &)

voidDrawPolyLineNoEndPoint(const TArray< TPoint > &aPointList)[pure virtual]

CDirectGdiContext::DrawPolyLineNoEndPoint() SetPenColor() SetPenSize() SetPenStyle() SetDrawMode()

Parameters

const TArray< TPoint > & aPointList

DrawPolygon(const TArray< TPoint > &, DirectGdi::TFillRule)

voidDrawPolygon(const TArray< TPoint > &aPoints,
DirectGdi::TFillRuleaRule
)[pure virtual]

CDirectGdiContext::DrawPolygon()

Parameters

const TArray< TPoint > & aPoints
DirectGdi::TFillRule aRule

DrawRect(const TRect &)

voidDrawRect(const TRect &aRect)[pure virtual]

CDirectGdiContext::DrawRect()

Parameters

const TRect & aRect

DrawResource(const TPoint &, const RDirectGdiDrawableSource &, DirectGdi::TGraphicsRotation)

voidDrawResource(const TPoint &aPos,
const RDirectGdiDrawableSource &aSource,
DirectGdi::TGraphicsRotationaRotation
)[pure virtual]

CDirectGdiContext::DrawResource(const TPoint&, const RDirectGdiImageSource&, DirectGdi::TGraphicsRotation)

Parameters

const TPoint & aPos
const RDirectGdiDrawableSource & aSource
DirectGdi::TGraphicsRotation aRotation

DrawResource(const TRect &, const RDirectGdiDrawableSource &, DirectGdi::TGraphicsRotation)

voidDrawResource(const TRect &aDestRect,
const RDirectGdiDrawableSource &aSource,
DirectGdi::TGraphicsRotationaRotation
)[pure virtual]

CDirectGdiContext::DrawResource(const TRect&, const RDirectGdiImageSource&, DirectGdi::TGraphicsRotation)

Parameters

const TRect & aDestRect
const RDirectGdiDrawableSource & aSource
DirectGdi::TGraphicsRotation aRotation

DrawResource(const TRect &, const RDirectGdiDrawableSource &, const TRect &, DirectGdi::TGraphicsRotation)

voidDrawResource(const TRect &aDestRect,
const RDirectGdiDrawableSource &aSource,
const TRect &aSourceRect,
DirectGdi::TGraphicsRotationaRotation
)[pure virtual]

CDirectGdiContext::DrawResource(const TRect&, const RDirectGdiImageSource&, const TRect&, DirectGdi::TGraphicsRotation)

Parameters

const TRect & aDestRect
const RDirectGdiDrawableSource & aSource
const TRect & aSourceRect
DirectGdi::TGraphicsRotation aRotation

DrawResource(const TRect &, const RDirectGdiDrawableSource &, const TDesC8 &)

voidDrawResource(const TRect &aDestRect,
const RDirectGdiDrawableSource &aSource,
const TDesC8 &aParam
)[pure virtual]

CDirectGdiContext::DrawResource(const TRect&, const RDirectGdiDrawableSource&, const TDesC8&)

Parameters

const TRect & aDestRect
const RDirectGdiDrawableSource & aSource
const TDesC8 & aParam

DrawRoundRect(const TRect &, const TSize &)

voidDrawRoundRect(const TRect &aRect,
const TSize &aCornerSize
)[pure virtual]

CDirectGdiContext::DrawRoundRect()

Parameters

const TRect & aRect
const TSize & aCornerSize

EndDrawGlyph()

voidEndDrawGlyph()[pure virtual]

Notifies the drawing engine that the last call to DrawGlyph() has been made for the text string. This function must always be matched to a corresponding BeginDrawGlyph() call. Other than DrawGlyph(), no other rendering should be issued to the engine until EndDrawGlyph() has been called.

BeginDrawGlyph() DrawGlyph()
Pre-condition
BeginDrawGlyph() has been called.
Post-condition
None.

ExternalizeL(RWriteStream &)

voidExternalizeL(RWriteStream &aWriteStream)[pure virtual]

Writes the drawing engine object state to the passed write stream.

CDirectGdiContext::ExternalizeL() InternalizeL()
Pre-condition
None.
Post-condition
The drawing engine object state has been written to the write stream.

Parameters

RWriteStream & aWriteStreamWrite stream.

GetInterface(TUid, TAny *&)

TInt GetInterface(TUidaInterfaceId,
TAny *&aInterface
)[pure virtual]

CDirectGdiContext::GetInterface()

Parameters

TUid aInterfaceId
TAny *& aInterface

InternalizeL(RReadStream &)

voidInternalizeL(RReadStream &aReadStream)[pure virtual]

Sets the drawing engine object state from the read stream.

CDirectGdiContext::InternalizeL() ExternalizeL()
Pre-condition
None.
Post-condition
The drawing engine object state has been updated with the values from the read stream.

Parameters

RReadStream & aReadStreamRead stream.

MoveBy(const TPoint &)

voidMoveBy(const TPoint &aVector)[pure virtual]

CDirectGdiContext::MoveBy() MoveTo()

Parameters

const TPoint & aVector

MoveTo(const TPoint &)

voidMoveTo(const TPoint &aPoint)[pure virtual]

CDirectGdiContext::MoveTo() MoveBy()

Parameters

const TPoint & aPoint

Plot(const TPoint &)

voidPlot(const TPoint &aPoint)[pure virtual]

CDirectGdiContext::Plot() SetPenSize() SetPenColor() SetDrawMode()

Parameters

const TPoint & aPoint

Reset()

voidReset()[pure virtual]

Resets the engine state to default values.

CDirectGdiContext::Reset()

ResetBrushPattern()

voidResetBrushPattern()[pure virtual]

CDirectGdiContext::ResetBrushPattern() SetBrushPattern()

ResetClippingRegion()

voidResetClippingRegion()[pure virtual]

CDirectGdiContext::ReetClippingRegion() SetClippingRegion()

ResetFont()

voidResetFont()[pure virtual]

CDirectGdiContext::ResetFont()

SetBrushColor(const TRgb &)

voidSetBrushColor(const TRgb &aColor)[pure virtual]

CDirectGdiContext::SetBrushColor()

Parameters

const TRgb & aColor

SetBrushOrigin(const TPoint &)

voidSetBrushOrigin(const TPoint &aOrigin)[pure virtual]

CDirectGdiContext::SetBrushOrigin() SetBrushPattern()

Parameters

const TPoint & aOrigin

SetBrushPattern(const CFbsBitmap &)

TInt SetBrushPattern(const CFbsBitmap &aPattern)[pure virtual]

CDirectGdiContext::SetBrushPattern() ResetBrushPattern()

Parameters

const CFbsBitmap & aPattern

SetBrushStyle(DirectGdi::TBrushStyle)

voidSetBrushStyle(DirectGdi::TBrushStyleaStyle)[pure virtual]

CDirectGdiContext::SetBrushStyle() SetBrushPattern()

Parameters

DirectGdi::TBrushStyle aStyle

SetClippingRegion(const TRegion &)

voidSetClippingRegion(const TRegion &aRegion)[pure virtual]

CDirectGdiContext::ResetClippingRegion() SetClippingRegion()

Parameters

const TRegion & aRegion

SetDrawMode(DirectGdi::TDrawMode)

voidSetDrawMode(DirectGdi::TDrawModeaMode)[pure virtual]

CDirectGdiContext::SetDrawMode()

Parameters

DirectGdi::TDrawMode aMode

SetFont(TUint32)

voidSetFont(TUint32aFontId)[pure virtual]

CDirectGdiContext::SetFont()

Parameters

TUint32 aFontIdThe Font identifier.

SetOrigin(const TPoint &)

voidSetOrigin(const TPoint &aOrigin)[pure virtual]

CDirectGdiContext::SetOrigin()

Parameters

const TPoint & aOrigin

SetPenColor(const TRgb &)

voidSetPenColor(const TRgb &aColor)[pure virtual]

CDirectGdiContext::SetPenColor() DrawLine() DrawLineTo() DrawLineBy() DrawPolyLine() DrawPolygon() DrawRect() DrawRoundRect()

Parameters

const TRgb & aColor

SetPenSize(const TSize &)

voidSetPenSize(const TSize &aSize)[pure virtual]

CDirectGdiContext::SetPenSize() DrawLine() DrawLineTo() DrawLineBy() DrawPolyLine() DrawPolygon() DrawRect() DrawRoundRect() Plot()

Parameters

const TSize & aSize

SetPenStyle(DirectGdi::TPenStyle)

voidSetPenStyle(DirectGdi::TPenStyleaStyle)[pure virtual]

CDirectGdiContext::SetPenStyle() DrawLine() DrawLineTo() DrawLineBy() DrawPolyLine() DrawPolygon() DrawRect() DrawRoundRect()

Parameters

DirectGdi::TPenStyle aStyle

SetTextShadowColor(const TRgb &)

voidSetTextShadowColor(const TRgb &aColor)[pure virtual]

CDirectGdiContext::SetTextShadowColor()

Parameters

const TRgb & aColor

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.