|
sl@0
|
1 |
// Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).
|
|
sl@0
|
2 |
// All rights reserved.
|
|
sl@0
|
3 |
// This component and the accompanying materials are made available
|
|
sl@0
|
4 |
// under the terms of "Eclipse Public License v1.0"
|
|
sl@0
|
5 |
// which accompanies this distribution, and is available
|
|
sl@0
|
6 |
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
sl@0
|
7 |
//
|
|
sl@0
|
8 |
// Initial Contributors:
|
|
sl@0
|
9 |
// Nokia Corporation - initial contribution.
|
|
sl@0
|
10 |
//
|
|
sl@0
|
11 |
// Contributors:
|
|
sl@0
|
12 |
//
|
|
sl@0
|
13 |
// Description:
|
|
sl@0
|
14 |
// Interface for Render Stage Abstract Graphics Context
|
|
sl@0
|
15 |
//
|
|
sl@0
|
16 |
//
|
|
sl@0
|
17 |
|
|
sl@0
|
18 |
/**
|
|
sl@0
|
19 |
@publishedPartner
|
|
sl@0
|
20 |
@prototype
|
|
sl@0
|
21 |
*/
|
|
sl@0
|
22 |
|
|
sl@0
|
23 |
#ifndef __WSGRAPHICSCONTEXT_H__
|
|
sl@0
|
24 |
#define __WSGRAPHICSCONTEXT_H__
|
|
sl@0
|
25 |
|
|
sl@0
|
26 |
#include <w32std.h>
|
|
sl@0
|
27 |
#include <graphics/wsgraphicdrawerinterface.h>
|
|
sl@0
|
28 |
|
|
sl@0
|
29 |
/** Render Stage abstract graphics context.
|
|
sl@0
|
30 |
|
|
sl@0
|
31 |
This interface is provided by Render Stages. It abstracts the graphics context
|
|
sl@0
|
32 |
of the pixel target. The intention is to allow Render Stages to intercept
|
|
sl@0
|
33 |
draw operations so that they can be batched (to reduce flickering), modified
|
|
sl@0
|
34 |
(to provide transition effects), or re-directed (to alternate back-end
|
|
sl@0
|
35 |
architectures).
|
|
sl@0
|
36 |
|
|
sl@0
|
37 |
@publishedPartner
|
|
sl@0
|
38 |
@prototype
|
|
sl@0
|
39 |
*/
|
|
sl@0
|
40 |
class MWsGraphicsContext : public MWsObjectProvider
|
|
sl@0
|
41 |
{
|
|
sl@0
|
42 |
public:
|
|
sl@0
|
43 |
DECLARE_WS_TYPE_ID(KMWsGraphicsContext)
|
|
sl@0
|
44 |
/** Text alignment.
|
|
sl@0
|
45 |
@publishedPartner
|
|
sl@0
|
46 |
@prototype
|
|
sl@0
|
47 |
*/
|
|
sl@0
|
48 |
enum TTextAlign
|
|
sl@0
|
49 |
{
|
|
sl@0
|
50 |
/** Text is left-aligned. */
|
|
sl@0
|
51 |
ELeft,
|
|
sl@0
|
52 |
/** Text is centred. */
|
|
sl@0
|
53 |
ECenter,
|
|
sl@0
|
54 |
/** Text is right-aligned. */
|
|
sl@0
|
55 |
ERight
|
|
sl@0
|
56 |
};
|
|
sl@0
|
57 |
|
|
sl@0
|
58 |
/**
|
|
sl@0
|
59 |
Brush styles.
|
|
sl@0
|
60 |
@publishedPartner
|
|
sl@0
|
61 |
@prototype
|
|
sl@0
|
62 |
*/
|
|
sl@0
|
63 |
enum TBrushStyle
|
|
sl@0
|
64 |
{
|
|
sl@0
|
65 |
/** The brush fill has no effect (default). */
|
|
sl@0
|
66 |
ENullBrush,
|
|
sl@0
|
67 |
/** The brush fills with a solid single colour, determined by
|
|
sl@0
|
68 |
SetBrushColor() and the drawing mode. */
|
|
sl@0
|
69 |
ESolidBrush,
|
|
sl@0
|
70 |
/** The brush fills with a selected bitmap pattern, set by
|
|
sl@0
|
71 |
UseBrushPattern(). */
|
|
sl@0
|
72 |
EPatternedBrush,
|
|
sl@0
|
73 |
/** The brush fills with vertical hatching lines going from top to
|
|
sl@0
|
74 |
bottom. */
|
|
sl@0
|
75 |
EVerticalHatchBrush,
|
|
sl@0
|
76 |
/** The brush fills with diagonal hatching lines going from bottom
|
|
sl@0
|
77 |
left to top right. */
|
|
sl@0
|
78 |
EForwardDiagonalHatchBrush,
|
|
sl@0
|
79 |
/** The brush fills with horizontal hatching lines going from left
|
|
sl@0
|
80 |
to right. */
|
|
sl@0
|
81 |
EHorizontalHatchBrush,
|
|
sl@0
|
82 |
/** The brush fills with rearward diagonal hatching lines going from top
|
|
sl@0
|
83 |
left to bottom right. */
|
|
sl@0
|
84 |
ERearwardDiagonalHatchBrush,
|
|
sl@0
|
85 |
/** The brush fills with horizontal and vertical hatching lines going
|
|
sl@0
|
86 |
from left to right plus lines going from top to bottom giving the
|
|
sl@0
|
87 |
effect of a grid of small squares */
|
|
sl@0
|
88 |
ESquareCrossHatchBrush,
|
|
sl@0
|
89 |
/** The brush fills with forward diagonal and rearward diagonal hatching
|
|
sl@0
|
90 |
lines going from bottom left to top right plus lines going from top left
|
|
sl@0
|
91 |
to bottom right giving the effect of a grid of small diamonds. */
|
|
sl@0
|
92 |
EDiamondCrossHatchBrush
|
|
sl@0
|
93 |
};
|
|
sl@0
|
94 |
|
|
sl@0
|
95 |
/**
|
|
sl@0
|
96 |
Drawing modes. The drawing modes define the way that the pen and brush colors are
|
|
sl@0
|
97 |
drawn, EDrawModePEN means do alpha blending if appropriate, EDrawModeWriteAlpha means
|
|
sl@0
|
98 |
don't do alpha blending.
|
|
sl@0
|
99 |
|
|
sl@0
|
100 |
@see SetDrawMode()
|
|
sl@0
|
101 |
@publishedPartner
|
|
sl@0
|
102 |
@prototype
|
|
sl@0
|
103 |
*/
|
|
sl@0
|
104 |
enum TDrawMode
|
|
sl@0
|
105 |
{
|
|
sl@0
|
106 |
/** Uses both pen and brush colour as they are. */
|
|
sl@0
|
107 |
EDrawModePEN=32,
|
|
sl@0
|
108 |
/** Writes alpha information in the source directly into the destination, rather than blending. */
|
|
sl@0
|
109 |
EDrawModeWriteAlpha=64
|
|
sl@0
|
110 |
};
|
|
sl@0
|
111 |
|
|
sl@0
|
112 |
/**
|
|
sl@0
|
113 |
Pen styles. The screen pattern unit in each definition below describes the
|
|
sl@0
|
114 |
pattern drawn by the line 1 represents a pixel drawn, 0 represents a
|
|
sl@0
|
115 |
pixel that is not affected.
|
|
sl@0
|
116 |
@publishedPartner
|
|
sl@0
|
117 |
@prototype
|
|
sl@0
|
118 |
*/
|
|
sl@0
|
119 |
enum TPenStyle
|
|
sl@0
|
120 |
{
|
|
sl@0
|
121 |
/** The pen does not draw. Screen pattern unit = 00... */
|
|
sl@0
|
122 |
ENullPen,
|
|
sl@0
|
123 |
/** A solid line (default). Screen pattern unit = 11... */
|
|
sl@0
|
124 |
ESolidPen,
|
|
sl@0
|
125 |
/** A dotted line. Screen pattern unit = 1000... */
|
|
sl@0
|
126 |
EDottedPen,
|
|
sl@0
|
127 |
/** A dashed line. Screen pattern unit = 111000... */
|
|
sl@0
|
128 |
EDashedPen,
|
|
sl@0
|
129 |
/** A line of alternating dashes and dots. Screen pattern unit =
|
|
sl@0
|
130 |
1111001100... */
|
|
sl@0
|
131 |
EDotDashPen,
|
|
sl@0
|
132 |
/** A line of alternating single dashes and pairs of dots. Screen
|
|
sl@0
|
133 |
pattern unit = 11110011001100... */
|
|
sl@0
|
134 |
EDotDotDashPen
|
|
sl@0
|
135 |
};
|
|
sl@0
|
136 |
|
|
sl@0
|
137 |
/**
|
|
sl@0
|
138 |
Rules used to fill self-intersecting polygons.
|
|
sl@0
|
139 |
|
|
sl@0
|
140 |
The filling of a polygon proceeds as follows: for a given point in the
|
|
sl@0
|
141 |
polygon, then:
|
|
sl@0
|
142 |
|
|
sl@0
|
143 |
if the rule is TFillRule::EAlternate (default) and it has an odd winding
|
|
sl@0
|
144 |
number, then fill the surrounding area.
|
|
sl@0
|
145 |
|
|
sl@0
|
146 |
if the rule is TFillRule::EWinding and it has a winding number greater than
|
|
sl@0
|
147 |
zero, then fill the surrounding area.
|
|
sl@0
|
148 |
@publishedPartner
|
|
sl@0
|
149 |
@prototype
|
|
sl@0
|
150 |
*/
|
|
sl@0
|
151 |
enum TFillRule
|
|
sl@0
|
152 |
{
|
|
sl@0
|
153 |
/** Only fill areas with odd winding numbers. */
|
|
sl@0
|
154 |
EAlternate,
|
|
sl@0
|
155 |
/** Fill areas with winding numbers greater than zero. */
|
|
sl@0
|
156 |
EWinding
|
|
sl@0
|
157 |
};
|
|
sl@0
|
158 |
|
|
sl@0
|
159 |
/**
|
|
sl@0
|
160 |
Font underline flags.
|
|
sl@0
|
161 |
@publishedPartner
|
|
sl@0
|
162 |
@prototype
|
|
sl@0
|
163 |
*/
|
|
sl@0
|
164 |
enum TFontUnderline
|
|
sl@0
|
165 |
{
|
|
sl@0
|
166 |
/** Font is not underlined. */
|
|
sl@0
|
167 |
EUnderlineOff,
|
|
sl@0
|
168 |
/** Font is underlined. */
|
|
sl@0
|
169 |
EUnderlineOn
|
|
sl@0
|
170 |
};
|
|
sl@0
|
171 |
|
|
sl@0
|
172 |
/**
|
|
sl@0
|
173 |
Font strike-through flags.
|
|
sl@0
|
174 |
@publishedPartner
|
|
sl@0
|
175 |
@prototype
|
|
sl@0
|
176 |
*/
|
|
sl@0
|
177 |
enum TFontStrikethrough
|
|
sl@0
|
178 |
{
|
|
sl@0
|
179 |
/** Font is not struck-through. */
|
|
sl@0
|
180 |
EStrikethroughOff,
|
|
sl@0
|
181 |
/** Font is struck-through. */
|
|
sl@0
|
182 |
EStrikethroughOn
|
|
sl@0
|
183 |
};
|
|
sl@0
|
184 |
|
|
sl@0
|
185 |
/**
|
|
sl@0
|
186 |
Parameters used in drawing text within supplied context.
|
|
sl@0
|
187 |
It is used by MWsGraphicsContext::DrawText() and MWsGraphicsContext::DrawTextVertical() family of API's
|
|
sl@0
|
188 |
to draw text from iStart to iEnd withing the supplied text descriptor.
|
|
sl@0
|
189 |
|
|
sl@0
|
190 |
@publishedPartner
|
|
sl@0
|
191 |
@prototype
|
|
sl@0
|
192 |
*/
|
|
sl@0
|
193 |
class TTextParameters
|
|
sl@0
|
194 |
{
|
|
sl@0
|
195 |
public:
|
|
sl@0
|
196 |
TTextParameters():
|
|
sl@0
|
197 |
iStart(0),
|
|
sl@0
|
198 |
iEnd(KMaxTInt),
|
|
sl@0
|
199 |
iFlags(0)
|
|
sl@0
|
200 |
{
|
|
sl@0
|
201 |
}
|
|
sl@0
|
202 |
TInt iStart;
|
|
sl@0
|
203 |
TInt iEnd;
|
|
sl@0
|
204 |
TUint16 iFlags;
|
|
sl@0
|
205 |
/* Reserved for future use */
|
|
sl@0
|
206 |
TAny* iReserved1;
|
|
sl@0
|
207 |
TAny* iReserved2;
|
|
sl@0
|
208 |
TAny* iReserved3;
|
|
sl@0
|
209 |
TAny* iReserved4;
|
|
sl@0
|
210 |
};
|
|
sl@0
|
211 |
|
|
sl@0
|
212 |
public:
|
|
sl@0
|
213 |
// The following are equivalent to CFbsBitGc functionality which maps
|
|
sl@0
|
214 |
// to client’s CWindowGc requests
|
|
sl@0
|
215 |
virtual void BitBlt(const TPoint& aDestPos, const CFbsBitmap& aSourceBitmap) = 0;
|
|
sl@0
|
216 |
virtual void BitBlt(const TPoint& aDestPos, const CFbsBitmap& aSourceBitmap, const TRect& aSourceRect) = 0;
|
|
sl@0
|
217 |
virtual void BitBltMasked(const TPoint& aDestPos, const CFbsBitmap& aSourceBitmap, const TRect& aSourceRect, const CFbsBitmap& aMaskBitmap, TBool aInvertMask) = 0;
|
|
sl@0
|
218 |
virtual void BitBltMasked(const TPoint& aDestPos, const CFbsBitmap& aSourceBitmap, const TRect& aSourceRect, const CFbsBitmap& aMaskBitmap, const TPoint& aMaskPos) = 0;
|
|
sl@0
|
219 |
virtual void ResetClippingRegion() = 0;
|
|
sl@0
|
220 |
virtual void Clear() = 0;
|
|
sl@0
|
221 |
virtual void Clear(const TRect& aRect) = 0;
|
|
sl@0
|
222 |
virtual void ResetBrushPattern() = 0;
|
|
sl@0
|
223 |
virtual void ResetFont() = 0;
|
|
sl@0
|
224 |
virtual void DrawArc(const TRect& aRect, const TPoint& aStart, const TPoint& aEnd) = 0;
|
|
sl@0
|
225 |
virtual void DrawPie(const TRect& aRect, const TPoint& aStart, const TPoint& aEnd) = 0;
|
|
sl@0
|
226 |
virtual void DrawBitmap(const TRect& aDestRect, const CFbsBitmap& aSourceBitmap) = 0;
|
|
sl@0
|
227 |
virtual void DrawBitmap(const TRect& aDestRect, const CFbsBitmap& aSourceBitmap, const TRect& aSourceRect) = 0;
|
|
sl@0
|
228 |
virtual void DrawBitmapMasked(const TRect& aDestRect, const CFbsBitmap& aSourceBitmap,const TRect& aSourceRect, const CFbsBitmap& aMaskBitmap, TBool aInvertMask) = 0;
|
|
sl@0
|
229 |
virtual void DrawRoundRect(const TRect& aRect, const TSize& aEllipse) = 0;
|
|
sl@0
|
230 |
virtual void DrawPolyLine(const TArray<TPoint>& aPointList) = 0;
|
|
sl@0
|
231 |
virtual void DrawPolyLineNoEndPoint(const TArray<TPoint>& aPointList) = 0;
|
|
sl@0
|
232 |
virtual void DrawPolygon(const TArray<TPoint>& aPointList, TFillRule aFillRule=EAlternate) = 0;
|
|
sl@0
|
233 |
virtual void DrawEllipse(const TRect& aRect) = 0;
|
|
sl@0
|
234 |
virtual void DrawLine(const TPoint& aStart, const TPoint& aEnd) = 0;
|
|
sl@0
|
235 |
virtual void DrawLineTo(const TPoint& aPoint) = 0;
|
|
sl@0
|
236 |
virtual void DrawLineBy(const TPoint& aVector) = 0;
|
|
sl@0
|
237 |
virtual void DrawRect(const TRect& aRect) = 0;
|
|
sl@0
|
238 |
virtual void DrawText(const TDesC& aText,const TTextParameters* aParam) = 0;
|
|
sl@0
|
239 |
virtual void DrawText(const TDesC& aText,const TTextParameters* aParam,const TPoint& aPosition) = 0;
|
|
sl@0
|
240 |
virtual void DrawText(const TDesC& aText,const TTextParameters* aParam,const TRect& aClipRect) = 0;
|
|
sl@0
|
241 |
virtual void DrawText(const TDesC& aText,const TTextParameters* aParam,const TRect& aClipFillRect,TInt aBaselineOffset,TTextAlign aHrz=ELeft,TInt aMargin=0) = 0;
|
|
sl@0
|
242 |
virtual void DrawTextVertical(const TDesC& aText,const TTextParameters* aParam,TBool aUp) = 0;
|
|
sl@0
|
243 |
virtual void DrawTextVertical(const TDesC& aText,const TTextParameters* aParam,const TPoint& aPosition,TBool aUp) = 0;
|
|
sl@0
|
244 |
virtual void DrawTextVertical(const TDesC& aText,const TTextParameters* aParam,const TRect& aClipRect,TBool aUp) = 0;
|
|
sl@0
|
245 |
virtual void DrawTextVertical(const TDesC& aText,const TTextParameters* aParam,const TRect& aClipRect,TInt aBaselineOffset,TBool aUp,TTextAlign aVert=ELeft,TInt aMargin=0) = 0;
|
|
sl@0
|
246 |
virtual void DrawTextVertical(const TDesC& aText,const TTextParameters* aParam,const TRect& aClipRect,TInt aBaselineOffset,TInt aTextWidth,TBool aUp,TTextAlign aVert=ELeft,TInt aMargin=0) = 0;
|
|
sl@0
|
247 |
virtual void MoveTo(const TPoint& aPoint) = 0;
|
|
sl@0
|
248 |
virtual void MoveBy(const TPoint& aVector) = 0;
|
|
sl@0
|
249 |
virtual void Plot(const TPoint& aPoint) = 0;
|
|
sl@0
|
250 |
virtual void Reset() = 0;
|
|
sl@0
|
251 |
virtual void SetBrushColor(const TRgb& aColor) = 0;
|
|
sl@0
|
252 |
virtual void SetBrushOrigin(const TPoint& aOrigin) = 0;
|
|
sl@0
|
253 |
virtual void SetBrushStyle(TBrushStyle aBrushStyle) = 0;
|
|
sl@0
|
254 |
virtual void SetClippingRegion(const TRegion& aRegion) = 0;
|
|
sl@0
|
255 |
virtual void SetDrawMode(TDrawMode aDrawMode) = 0;
|
|
sl@0
|
256 |
virtual void SetOrigin(const TPoint& aPoint = TPoint(0, 0)) = 0;
|
|
sl@0
|
257 |
virtual void SetPenColor(const TRgb& aColor) = 0;
|
|
sl@0
|
258 |
virtual void SetPenStyle(TPenStyle aPenStyle) = 0;
|
|
sl@0
|
259 |
virtual void SetPenSize(const TSize& aSize) = 0;
|
|
sl@0
|
260 |
virtual void SetTextShadowColor(const TRgb& aColor) = 0;
|
|
sl@0
|
261 |
virtual void SetCharJustification(TInt aExcessWidth, TInt aNumChars) = 0;
|
|
sl@0
|
262 |
virtual void SetWordJustification(TInt aExcessWidth, TInt aNumGaps) = 0;
|
|
sl@0
|
263 |
virtual void SetUnderlineStyle(TFontUnderline aUnderlineStyle) = 0;
|
|
sl@0
|
264 |
virtual void SetStrikethroughStyle(TFontStrikethrough aStrikethroughStyle) = 0;
|
|
sl@0
|
265 |
virtual void SetBrushPattern(const CFbsBitmap& aBitmap) = 0;
|
|
sl@0
|
266 |
virtual void SetBrushPattern(TInt aFbsBitmapHandle) = 0;
|
|
sl@0
|
267 |
virtual void SetFont(const CFont* aFont) = 0;
|
|
sl@0
|
268 |
|
|
sl@0
|
269 |
// CFbsBitGc functionality used by Wserv for its internal operations
|
|
sl@0
|
270 |
virtual void CopyRect(const TPoint& aOffset, const TRect& aRect) = 0;
|
|
sl@0
|
271 |
virtual void UpdateJustification(const TDesC& aText,const TTextParameters* aParam) = 0;
|
|
sl@0
|
272 |
virtual void UpdateJustificationVertical(const TDesC& aText,const TTextParameters* aParam,TBool aUp) = 0;
|
|
sl@0
|
273 |
virtual void SetFontNoDuplicate(const CFont* aFont) = 0;
|
|
sl@0
|
274 |
virtual TBool HasBrushPattern() const = 0;
|
|
sl@0
|
275 |
virtual TBool HasFont() const = 0;
|
|
sl@0
|
276 |
virtual TRgb BrushColor() const = 0;
|
|
sl@0
|
277 |
virtual TRgb PenColor() const = 0;
|
|
sl@0
|
278 |
virtual TRgb TextShadowColor() const = 0;
|
|
sl@0
|
279 |
|
|
sl@0
|
280 |
// Return current error status of MWsGraphicsContext
|
|
sl@0
|
281 |
virtual TInt GetError() = 0;
|
|
sl@0
|
282 |
|
|
sl@0
|
283 |
/** The origin of the GC relative to the screen's origin
|
|
sl@0
|
284 |
@return the origin */
|
|
sl@0
|
285 |
virtual TPoint Origin() const = 0;
|
|
sl@0
|
286 |
/** The clipping region currently being used
|
|
sl@0
|
287 |
@return the clipping region */
|
|
sl@0
|
288 |
virtual const TRegion& ClippingRegion() = 0;
|
|
sl@0
|
289 |
/** Saves the state of the GC to an internal buffer. Several GC states can be saved in a FILO.
|
|
sl@0
|
290 |
Do not restore a GC (using Pop()) that wasn't properly saved!
|
|
sl@0
|
291 |
@return KErrNone if successful, else one of the system-wide error codes. */
|
|
sl@0
|
292 |
virtual TInt Push() = 0;
|
|
sl@0
|
293 |
/** Restores the last GC state that was saved. */
|
|
sl@0
|
294 |
virtual void Pop() = 0;
|
|
sl@0
|
295 |
};
|
|
sl@0
|
296 |
|
|
sl@0
|
297 |
#endif //__WSGRAPHICSCONTEXT_H__
|