Symbian^3 Application Developer Library >

MDirectGdiEngine Class Reference

class MDirectGdiEngine

Pure virtual interface for licensee adaptation of GDI platform implementation.

Public Member Functions
TInt Activate ( RDirectGdiImageTarget &)
void BeginDrawGlyph ()
void BitBlt (const TPoint &, const CFbsBitmap &, const TRect &)
void BitBltMasked (const TPoint &, const CFbsBitmap &, const TRect &, const CFbsBitmap &, TBool )
void BitBltMasked (const TPoint &, const CFbsBitmap &, const TRect &, const CFbsBitmap &, const TPoint &)
void Clear (const TRect &)
void Clear ()
void CopyRect (const TPoint &, const TRect &)
void Deactivate ()
void DrawArc (const TRect &, const TPoint &, const TPoint &)
void DrawBitmap (const TRect &, const CFbsBitmap &, const TRect &)
void DrawBitmapMasked (const TRect &, const CFbsBitmap &, const TRect &, const CFbsBitmap &, TBool )
void DrawEllipse (const TRect &)
void DrawGlyph (const TPoint &, const TChar , const TUint8 *, const TGlyphBitmapType , const TSize &, const TRect &, const DirectGdi::TGraphicsRotation )
void DrawLine (const TPoint &, const TPoint &)
void DrawLineBy (const TPoint &)
void DrawLineTo (const TPoint &)
void DrawPie (const TRect &, const TPoint &, const TPoint &)
void DrawPolyLine (const TArray < TPoint > &)
void DrawPolyLineNoEndPoint (const TArray < TPoint > &)
void DrawPolygon (const TArray < TPoint > &, DirectGdi::TFillRule )
void DrawRect (const TRect &)
void DrawResource (const TPoint &, const RDirectGdiDrawableSource &, DirectGdi::TGraphicsRotation )
void DrawResource (const TRect &, const RDirectGdiDrawableSource &, DirectGdi::TGraphicsRotation )
void DrawResource (const TRect &, const RDirectGdiDrawableSource &, const TRect &, DirectGdi::TGraphicsRotation )
void DrawResource (const TRect &, const RDirectGdiDrawableSource &, const TDesC8 &)
void DrawRoundRect (const TRect &, const TSize &)
void EndDrawGlyph ()
void ExternalizeL ( RWriteStream &)
TInt GetInterface ( TUid , TAny *&)
void InternalizeL ( RReadStream &)
void MoveBy (const TPoint &)
void MoveTo (const TPoint &)
void Plot (const TPoint &)
void Reset ()
void ResetBrushPattern ()
void ResetClippingRegion ()
void ResetFont ()
void SetBrushColor (const TRgb &)
void SetBrushOrigin (const TPoint &)
TInt SetBrushPattern (const CFbsBitmap &)
void SetBrushStyle ( DirectGdi::TBrushStyle )
void SetClippingRegion (const TRegion &)
void SetDrawMode ( DirectGdi::TDrawMode )
void SetFont ( TUint32 )
void SetOrigin (const TPoint &)
void SetPenColor (const TRgb &)
void SetPenSize (const TSize &)
void SetPenStyle ( DirectGdi::TPenStyle )
void SetTextShadowColor (const TRgb &)

Member Functions Documentation

Activate(RDirectGdiImageTarget &)

TInt Activate ( RDirectGdiImageTarget & aTarget ) [pure virtual]

CDirectGdiContext::Activate() Deactivate()

Parameters

RDirectGdiImageTarget & aTarget

BeginDrawGlyph()

void BeginDrawGlyph ( ) [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 &)

void BitBlt ( 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)

void BitBltMasked ( const TPoint & aDestPos,
const CFbsBitmap & aBitmap,
const TRect & aSourceRect,
const CFbsBitmap & aMask,
TBool aInvertMask
) [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 &)

void BitBltMasked ( 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 &)

void Clear ( const TRect & aRect ) [pure virtual]

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

Parameters

const TRect & aRect

Clear()

void Clear ( ) [pure virtual]

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

CopyRect(const TPoint &, const TRect &)

void CopyRect ( 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 & aOffset Offset from the top left corner of the rectangle to be copied to the top left corner of the copy.
const TRect & aRect Area to be copied.

Deactivate()

void Deactivate ( ) [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 &)

void DrawArc ( 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 &)

void DrawBitmap ( 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)

void DrawBitmapMasked ( const TRect & aDestRect,
const CFbsBitmap & aBitmap,
const TRect & aSourceRect,
const CFbsBitmap & aMask,
TBool aInvertMask
) [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 &)

void DrawEllipse ( 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)

void DrawGlyph ( const TPoint & aPos,
const TChar aChar,
const TUint8 * aGlyphImage,
const TGlyphBitmapType aBitmapType,
const TSize & aGlyphImageSize,
const TRect & aClipRect,
const DirectGdi::TGraphicsRotation aRotation = 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 & aPos Position to start drawing the glyph after rotation has been applied (if necessary).
const TChar aChar Character being drawn.
const TUint8 * aGlyphImage Pointer to the glyph image data.
const TGlyphBitmapType aBitmapType Type of bitmap format.
const TSize & aGlyphImageSize Glyph image size.
const TRect & aClipRect Clipping rect.
const DirectGdi::TGraphicsRotation aRotation = DirectGdi::EGraphicsRotationNone Rotation specifying how the glyph will be drawn.

DrawLine(const TPoint &, const TPoint &)

void DrawLine ( 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 &)

void DrawLineBy ( const TPoint & aVector ) [pure virtual]

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

Parameters

const TPoint & aVector

DrawLineTo(const TPoint &)

void DrawLineTo ( 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 &)

void DrawPie ( 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 > &)

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

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

Parameters

const TArray < TPoint > & aPointList

DrawPolyLineNoEndPoint(const TArray< TPoint > &)

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

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

Parameters

const TArray < TPoint > & aPointList

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

void DrawPolygon ( const TArray < TPoint > & aPoints,
DirectGdi::TFillRule aRule
) [pure virtual]

CDirectGdiContext::DrawPolygon()

Parameters

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

DrawRect(const TRect &)

void DrawRect ( const TRect & aRect ) [pure virtual]

CDirectGdiContext::DrawRect()

Parameters

const TRect & aRect

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

void DrawResource ( const TPoint & aPos,
const RDirectGdiDrawableSource & aSource,
DirectGdi::TGraphicsRotation aRotation
) [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)

void DrawResource ( const TRect & aDestRect,
const RDirectGdiDrawableSource & aSource,
DirectGdi::TGraphicsRotation aRotation
) [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)

void DrawResource ( const TRect & aDestRect,
const RDirectGdiDrawableSource & aSource,
const TRect & aSourceRect,
DirectGdi::TGraphicsRotation aRotation
) [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 &)

void DrawResource ( 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 &)

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

CDirectGdiContext::DrawRoundRect()

Parameters

const TRect & aRect
const TSize & aCornerSize

EndDrawGlyph()

void EndDrawGlyph ( ) [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 &)

void ExternalizeL ( 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 & aWriteStream Write stream.

GetInterface(TUid, TAny *&)

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

CDirectGdiContext::GetInterface()

Parameters

TUid aInterfaceId
TAny *& aInterface

InternalizeL(RReadStream &)

void InternalizeL ( 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 & aReadStream Read stream.

MoveBy(const TPoint &)

void MoveBy ( const TPoint & aVector ) [pure virtual]

CDirectGdiContext::MoveBy() MoveTo()

Parameters

const TPoint & aVector

MoveTo(const TPoint &)

void MoveTo ( const TPoint & aPoint ) [pure virtual]

CDirectGdiContext::MoveTo() MoveBy()

Parameters

const TPoint & aPoint

Plot(const TPoint &)

void Plot ( const TPoint & aPoint ) [pure virtual]

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

Parameters

const TPoint & aPoint

Reset()

void Reset ( ) [pure virtual]

Resets the engine state to default values.

CDirectGdiContext::Reset()

ResetBrushPattern()

void ResetBrushPattern ( ) [pure virtual]

CDirectGdiContext::ResetBrushPattern() SetBrushPattern()

ResetClippingRegion()

void ResetClippingRegion ( ) [pure virtual]

CDirectGdiContext::ReetClippingRegion() SetClippingRegion()

ResetFont()

void ResetFont ( ) [pure virtual]

CDirectGdiContext::ResetFont()

SetBrushColor(const TRgb &)

void SetBrushColor ( const TRgb & aColor ) [pure virtual]

CDirectGdiContext::SetBrushColor()

Parameters

const TRgb & aColor

SetBrushOrigin(const TPoint &)

void SetBrushOrigin ( 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)

void SetBrushStyle ( DirectGdi::TBrushStyle aStyle ) [pure virtual]

CDirectGdiContext::SetBrushStyle() SetBrushPattern()

Parameters

DirectGdi::TBrushStyle aStyle

SetClippingRegion(const TRegion &)

void SetClippingRegion ( const TRegion & aRegion ) [pure virtual]

CDirectGdiContext::ResetClippingRegion() SetClippingRegion()

Parameters

const TRegion & aRegion

SetDrawMode(DirectGdi::TDrawMode)

void SetDrawMode ( DirectGdi::TDrawMode aMode ) [pure virtual]

CDirectGdiContext::SetDrawMode()

Parameters

DirectGdi::TDrawMode aMode

SetFont(TUint32)

void SetFont ( TUint32 aFontId ) [pure virtual]

CDirectGdiContext::SetFont()

Parameters

TUint32 aFontId The Font identifier.

SetOrigin(const TPoint &)

void SetOrigin ( const TPoint & aOrigin ) [pure virtual]

CDirectGdiContext::SetOrigin()

Parameters

const TPoint & aOrigin

SetPenColor(const TRgb &)

void SetPenColor ( const TRgb & aColor ) [pure virtual]

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

Parameters

const TRgb & aColor

SetPenSize(const TSize &)

void SetPenSize ( const TSize & aSize ) [pure virtual]

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

Parameters

const TSize & aSize

SetPenStyle(DirectGdi::TPenStyle)

void SetPenStyle ( DirectGdi::TPenStyle aStyle ) [pure virtual]

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

Parameters

DirectGdi::TPenStyle aStyle

SetTextShadowColor(const TRgb &)

void SetTextShadowColor ( 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.