Remove the misspelling drawing code from Font and FontData. Implement it
[WebKit-https.git] / WebCore / platform / GraphicsContext.h
1 /*
2  * Copyright (C) 2003, 2006 Apple Computer, Inc.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #ifndef GraphicsContext_h
27 #define GraphicsContext_h
28
29 #include "FloatRect.h"
30 #include "Image.h"
31 #include "IntRect.h"
32 #include "Pen.h"
33 #include "TextDirection.h"
34 #include <wtf/Noncopyable.h>
35 #include <unicode/umachine.h>
36
37 #if __APPLE__
38 typedef struct CGContext PlatformGraphicsContext;
39 #elif WIN32
40 typedef struct HDC__* HDC;
41 typedef struct _cairo PlatformGraphicsContext;
42 #else
43 typedef void PlatformGraphicsContext;
44 #endif
45
46 static const int cMisspellingLineThickness = 3;
47 static const int cMisspellingLinePatternWidth = 4;
48 static const int cMisspellingLinePatternGapWidth = 1;
49
50 class DeprecatedString;
51
52 namespace WebCore {
53
54     class Font;
55     class GraphicsContextPrivate;
56     class GraphicsContextPlatformPrivate;
57     class IntPoint;
58     class IntPointArray;
59     class Path;
60     class TextRun;
61
62 #if SVG_SUPPORT
63     class KRenderingDeviceContext;
64 #endif
65
66     class GraphicsContext : Noncopyable {
67     public:
68         GraphicsContext(PlatformGraphicsContext*);
69         ~GraphicsContext();
70        
71         PlatformGraphicsContext* platformContext() const;
72
73         const Font& font() const;
74         void setFont(const Font&);
75         
76         const Pen& pen() const;
77         void setPen(const Pen&);
78         void setPen(Pen::PenStyle);
79         void setPen(RGBA32);
80         
81         Color fillColor() const;
82         void setFillColor(const Color&);
83
84         void save();
85         void restore();
86         
87         void drawRect(const IntRect&);
88         void drawLine(const IntPoint&, const IntPoint&);
89         void drawEllipse(const IntRect&);
90         void drawArc(int, int, int, int, int, int);
91         void drawConvexPolygon(const IntPointArray&);
92
93         void fillRect(const IntRect&, const Color&);
94         void fillRect(const FloatRect&, const Color&);
95         void clearRect(const FloatRect&);
96         void strokeRect(const FloatRect&, float lineWidth);
97
98         void drawImage(Image*, const IntPoint&, CompositeOperator = CompositeSourceOver);
99         void drawImage(Image*, const IntRect&, CompositeOperator = CompositeSourceOver);
100         void drawImage(Image*, const IntPoint& destPoint, const IntRect& srcRect, CompositeOperator = CompositeSourceOver);
101         void drawImage(Image*, const IntRect& destRect, const IntRect& srcRect, CompositeOperator = CompositeSourceOver);
102         void drawImage(Image*, const FloatRect& destRect, const FloatRect& srcRect = FloatRect(0, 0, -1, -1),
103             CompositeOperator = CompositeSourceOver);
104         void drawTiledImage(Image*, const IntRect& destRect, const IntPoint& srcPoint, const IntSize& tileSize);
105         void drawTiledImage(Image*, const IntRect& destRect, const IntRect& srcRect, 
106             Image::TileRule hRule = Image::StretchTile, Image::TileRule vRule = Image::StretchTile);
107
108         void addClip(const IntRect&);
109         void addRoundedRectClip(const IntRect&, const IntSize& topLeft, const IntSize& topRight, const IntSize& bottomLeft, const IntSize& bottomRight);
110
111         // Functions to work around bugs in focus ring clipping on Mac.
112         void setFocusRingClip(const IntRect&);
113         void clearFocusRingClip();
114
115         void drawText(const TextRun&, const IntPoint&, int tabWidth = 0, int xpos = 0, int toAdd = 0,
116                       TextDirection = LTR, bool visuallyOrdered = false);
117         void drawHighlightForText(const TextRun&, const IntPoint&, int h, 
118                                   int tabWidth, int xpos, int toAdd, TextDirection, bool visuallyOrdered, const Color& backgroundColor);
119                                   
120         
121         void drawLineForText(const IntPoint&, int yOffset, int width, bool printing);
122         void drawLineForMisspelling(const IntPoint&, int width);
123
124         Color selectedTextBackgroundColor() const;
125         void setUsesInactiveTextBackgroundColor(bool);
126         bool usesInactiveTextBackgroundColor() const;
127         
128         bool paintingDisabled() const;
129         void setPaintingDisabled(bool);
130         
131         bool updatingControlTints() const;
132         void setUpdatingControlTints(bool);
133
134         void beginTransparencyLayer(float opacity);
135         void endTransparencyLayer();
136
137         void setShadow(const IntSize&, int blur, const Color&);
138         void clearShadow();
139
140         void initFocusRing(int width, int offset);
141         void addFocusRingRect(const IntRect&);
142         void drawFocusRing(const Color&);
143         void clearFocusRing();
144
145         void setLineWidth(float);
146         void setLineCap(LineCap);
147         void setLineJoin(LineJoin);
148         void setMiterLimit(float);
149
150         void setAlpha(float);
151
152         void setCompositeOperation(CompositeOperator);
153
154         void clip(const Path&);
155
156         void scale(const FloatSize&);
157         void rotate(float angleInRadians);
158         void translate(const FloatSize&);
159
160 #if SVG_SUPPORT
161         KRenderingDeviceContext* createRenderingDeviceContext();
162 #endif
163
164 #if WIN32
165         GraphicsContext(HDC); // FIXME: To be removed.
166 #endif
167
168     private:
169         void savePlatformState();
170         void restorePlatformState();
171
172         int focusRingWidth() const;
173         int focusRingOffset() const;
174         const Vector<IntRect>& focusRingRects() const;
175
176         static GraphicsContextPrivate* createGraphicsContextPrivate();
177         static void destroyGraphicsContextPrivate(GraphicsContextPrivate*);
178
179         GraphicsContextPrivate* m_common;
180         GraphicsContextPlatformPrivate* m_data;
181     };
182
183 }
184
185 #endif