epoc32/include/metafile.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
// All rights reserved.
williamr@2
     3
// This component and the accompanying materials are made available
williamr@2
     4
// under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
williamr@2
     5
// which accompanies this distribution, and is available
williamr@2
     6
// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     7
//
williamr@2
     8
// Initial Contributors:
williamr@2
     9
// Nokia Corporation - initial contribution.
williamr@2
    10
//
williamr@2
    11
// Contributors:
williamr@2
    12
//
williamr@2
    13
// Description:
williamr@2
    14
//
williamr@2
    15
williamr@2
    16
#ifndef METAFILE_H
williamr@2
    17
#define METAFILE_H
williamr@2
    18
williamr@2
    19
#include <e32std.h>
williamr@2
    20
#include <gdi.h>
williamr@2
    21
#include <s32file.h>
williamr@2
    22
williamr@2
    23
const TInt KWinPrintMetafileUidVal(268435687);
williamr@2
    24
williamr@2
    25
/**
williamr@2
    26
 * @internalTechnology
williamr@2
    27
 * Internal to Symbian
williamr@2
    28
 */
williamr@2
    29
class CMetafileDevice :	public CGraphicsDevice
williamr@2
    30
	{
williamr@2
    31
protected:
williamr@2
    32
	IMPORT_C CMetafileDevice(CGraphicsDevice* aDevice);
williamr@2
    33
public:
williamr@2
    34
	IMPORT_C static CMetafileDevice* NewL(CGraphicsDevice* aDevice);
williamr@2
    35
	IMPORT_C ~CMetafileDevice();
williamr@2
    36
	IMPORT_C TInt HorizontalTwipsToPixels(TInt aTwips) const;
williamr@2
    37
	IMPORT_C TInt VerticalTwipsToPixels(TInt aTwips) const;
williamr@2
    38
	IMPORT_C TInt HorizontalPixelsToTwips(TInt aPixels) const;
williamr@2
    39
	IMPORT_C TInt VerticalPixelsToTwips(TInt aPixels) const;
williamr@2
    40
	IMPORT_C TInt GetNearestFontInTwips(CFont*& aFont, const TFontSpec& aFontSpec);
williamr@2
    41
	IMPORT_C TInt GetNearestFontToDesignHeightInTwips(CFont*& aFont,const TFontSpec& aFontSpec);
williamr@2
    42
	IMPORT_C TInt GetNearestFontToMaxHeightInTwips(CFont*& aFont,const TFontSpec& aFontSpec, TInt aMaxHeight);
williamr@2
    43
	IMPORT_C void ReleaseFont(CFont* aFont);
williamr@2
    44
	IMPORT_C TDisplayMode DisplayMode() const;
williamr@2
    45
	IMPORT_C TSize SizeInPixels() const;
williamr@2
    46
	IMPORT_C TSize SizeInTwips() const;
williamr@2
    47
	IMPORT_C TInt CreateContext(CGraphicsContext*& aGC);
williamr@2
    48
	IMPORT_C TInt NumTypefaces() const;
williamr@2
    49
	IMPORT_C void TypefaceSupport(TTypefaceSupport& aTypefaceSupport, TInt aTypefaceIndex) const;
williamr@2
    50
	IMPORT_C TInt FontHeightInTwips(TInt aTypefaceIndex, TInt aHeightIndex) const;
williamr@2
    51
	IMPORT_C void PaletteAttributes(TBool& aModifiable, TInt& aNumEntries) const;
williamr@2
    52
	IMPORT_C void SetPalette(CPalette* aPalette);
williamr@2
    53
	IMPORT_C TInt GetPalette(CPalette*& aPalette) const;
williamr@2
    54
	IMPORT_C void UseGcL(TInt aGcIndex);
williamr@2
    55
	IMPORT_C void StartOutputStreamL(RWriteStream& aStream);  // Returns error code
williamr@2
    56
	IMPORT_C void EndOfStreamL(); 
williamr@2
    57
	IMPORT_C RWriteStream& WriteStream();
williamr@2
    58
private:
williamr@2
    59
	TInt iGcCount;
williamr@2
    60
	TInt iGcIndex;
williamr@2
    61
	CGraphicsDevice* iRealDevice;
williamr@2
    62
	RWriteStream* iWriteStream;
williamr@2
    63
	};
williamr@2
    64
williamr@2
    65
/**
williamr@2
    66
 * @internalTechnology
williamr@2
    67
 * Internal to Symbian
williamr@2
    68
 */
williamr@2
    69
class CMetafileGc : public CGraphicsContext
williamr@2
    70
	{
williamr@2
    71
	friend class CMetafileDevice;
williamr@2
    72
protected:
williamr@2
    73
	IMPORT_C CMetafileGc(CMetafileDevice* aMetafileDevice, TInt anIndex);
williamr@2
    74
public:
williamr@2
    75
	IMPORT_C ~CMetafileGc();
williamr@2
    76
	IMPORT_C CGraphicsDevice* Device() const;
williamr@2
    77
	IMPORT_C void SetOrigin(const TPoint& aPos = TPoint(0, 0));
williamr@2
    78
	IMPORT_C void SetDrawMode(TDrawMode aDrawingMode);
williamr@2
    79
	IMPORT_C void SetClippingRect(const TRect& aRect);
williamr@2
    80
	IMPORT_C void CancelClippingRect();
williamr@2
    81
	IMPORT_C void Reset();
williamr@2
    82
	IMPORT_C void UseFont(const CFont* aFont);
williamr@2
    83
	IMPORT_C void DiscardFont();
williamr@2
    84
	IMPORT_C void SetUnderlineStyle(TFontUnderline aUnderlineStyle);
williamr@2
    85
	IMPORT_C void SetStrikethroughStyle(TFontStrikethrough aStrikethroughStyle);
williamr@2
    86
	IMPORT_C void SetWordJustification(TInt aExcessWidth, TInt aNumGaps);
williamr@2
    87
	IMPORT_C void SetCharJustification(TInt aExcessWidth, TInt aNumChars);
williamr@2
    88
	IMPORT_C void SetPenColor(const TRgb& aColor);
williamr@2
    89
	IMPORT_C void SetPenStyle(TPenStyle aPenStyle);
williamr@2
    90
	IMPORT_C void SetPenSize(const TSize& aSize);
williamr@2
    91
	IMPORT_C void SetBrushColor(const TRgb& aColor);
williamr@2
    92
	IMPORT_C void SetBrushStyle(TBrushStyle aBrushStyle);
williamr@2
    93
	IMPORT_C void SetBrushOrigin(const TPoint& aOrigin);
williamr@2
    94
	IMPORT_C void UseBrushPattern(const CFbsBitmap* aBitmap);
williamr@2
    95
	IMPORT_C void DiscardBrushPattern();
williamr@2
    96
	IMPORT_C void MoveTo(const TPoint& aPoint);
williamr@2
    97
	IMPORT_C void MoveBy(const TPoint& aVector);
williamr@2
    98
	IMPORT_C void Plot(const TPoint& aPoint);
williamr@2
    99
	IMPORT_C void DrawArc(const TRect& aRect, const TPoint& aStart, const TPoint& aEnd);
williamr@2
   100
	IMPORT_C void DrawLine(const TPoint& aPoint1, const TPoint& aPoint2);
williamr@2
   101
	IMPORT_C void DrawLineTo(const TPoint& aPoint);
williamr@2
   102
	IMPORT_C void DrawLineBy(const TPoint& aVector);
williamr@2
   103
	IMPORT_C void DrawPolyLine(const CArrayFix<TPoint>* aPointList);
williamr@2
   104
	IMPORT_C void DrawPolyLine(const TPoint* aPointList, TInt aNumPoints);
williamr@2
   105
	IMPORT_C void DrawPie(const TRect& aRect, const TPoint& aStart, const TPoint& aEnd);
williamr@2
   106
	IMPORT_C void DrawEllipse(const TRect& aRect);
williamr@2
   107
	IMPORT_C void DrawRect(const TRect& aRect);
williamr@2
   108
	IMPORT_C void DrawRoundRect(const TRect& aRect, const TSize& aCornerSize);
williamr@2
   109
	IMPORT_C TInt DrawPolygon(const CArrayFix<TPoint>* aPointList, TFillRule aFillRule = EAlternate);
williamr@2
   110
	IMPORT_C TInt DrawPolygon(const TPoint* aPointList, TInt aNumPoints, TFillRule aFillRule = EAlternate);
williamr@2
   111
	IMPORT_C void DrawBitmap(const TPoint& aTopLeft, const CFbsBitmap* aSource);
williamr@2
   112
	IMPORT_C void DrawBitmap(const TRect& aDestRect, const CFbsBitmap* aSource);
williamr@2
   113
	IMPORT_C void DrawBitmap(const TRect& aDestRect, const CFbsBitmap* aSource, const TRect& aSourceRect);
williamr@2
   114
	IMPORT_C void DrawBitmapMasked(const TRect& aDestRect,const CFbsBitmap* aBitmap,const TRect& aSourceRect,const CFbsBitmap* aMaskBitmap,TBool aInvertMask);
williamr@2
   115
	IMPORT_C void DrawBitmapMasked(const TRect& aDestRect,const CWsBitmap* aBitmap,const TRect& aSourceRect,const CWsBitmap* aMaskBitmap,TBool aInvertMask);
williamr@2
   116
	IMPORT_C void DrawText(const TDesC& aString, const TPoint& aPosition);
williamr@2
   117
	IMPORT_C void DrawText(const TDesC& aString, const TRect& aBox, TInt aBaselineOffset, TTextAlign aHoriz = ELeft, TInt aLeftMrg = 0);
williamr@2
   118
							
williamr@2
   119
	IMPORT_C void MapColors(const TRect& aRect,const TRgb* aColors,TInt aNumPairs,TBool aMapForwards);
williamr@2
   120
	IMPORT_C TInt SetClippingRegion(const TRegion &aRegion);
williamr@2
   121
	IMPORT_C void CancelClippingRegion();
williamr@2
   122
	IMPORT_C void DrawTextVertical(const TDesC& aText,const TPoint& aPos,TBool aUp);
williamr@2
   123
	IMPORT_C void DrawTextVertical(const TDesC& aText,const TRect& aBox,TInt aBaselineOffset,TBool aUp,TTextAlign aVert=ELeft,TInt aMargin=0);								
williamr@2
   124
	IMPORT_C TInt AlphaBlendBitmaps(const TPoint& aDestPt, const CFbsBitmap* aSrcBmp, const TRect& aSrcRect, const CFbsBitmap* aAlphaBmp, const TPoint& aAlphaPt);
williamr@2
   125
	IMPORT_C TInt AlphaBlendBitmaps(const TPoint& aDestPt, const CWsBitmap* aSrcBmp,  const TRect& aSrcRect, const CWsBitmap*  aAlphaBmp, const TPoint& aAlphaPt);
williamr@2
   126
	
williamr@2
   127
private:
williamr@2
   128
	void ExternalizeBitmapL(const CFbsBitmap* aSource);
williamr@2
   129
private:
williamr@2
   130
	CMetafileDevice* iDevice;
williamr@2
   131
	TInt iIndex;
williamr@2
   132
	};
williamr@2
   133
williamr@2
   134
/**
williamr@2
   135
 * @internalTechnology
williamr@2
   136
 * Internal to Symbian
williamr@2
   137
 */
williamr@2
   138
class CMetafilePlayback : public CBase
williamr@2
   139
	{
williamr@2
   140
protected:
williamr@2
   141
	IMPORT_C CMetafilePlayback(CGraphicsDevice* aDevice);
williamr@2
   142
public:
williamr@2
   143
	IMPORT_C static CMetafilePlayback* NewL(CGraphicsDevice* aDevice);
williamr@2
   144
	IMPORT_C ~CMetafilePlayback();
williamr@2
   145
	IMPORT_C void DrawL(RReadStream& aReadStream);
williamr@2
   146
protected:
williamr@2
   147
	CGraphicsDevice* iDevice;
williamr@2
   148
	};
williamr@2
   149
williamr@2
   150
#endif