initial import
[vuplus_webkit] / Source / WebCore / html / canvas / CanvasRenderingContext2D.idl
1 /*
2  * Copyright (C) 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 module html {
27
28     interface [
29         LegacyDefaultOptionalArguments,
30         InterfaceUUID=98fb48ae-7216-489c-862b-8e1217fc4443,
31         ImplementationUUID=ab4f0781-152f-450e-9546-5b3987491a54
32     ] CanvasRenderingContext2D : CanvasRenderingContext {
33
34         // Web Applications 1.0 draft
35
36         void save();
37         void restore();
38
39         void scale(in float sx, in float sy);
40         void rotate(in float angle);
41         void translate(in float tx, in float ty);
42         void transform(in float m11, in float m12, in float m21, in float m22, in float dx, in float dy);
43         void setTransform(in float m11, in float m12, in float m21, in float m22, in float dx, in float dy);
44
45         attribute float globalAlpha;
46         attribute [ConvertNullToNullString] DOMString globalCompositeOperation;
47
48         CanvasGradient createLinearGradient(in float x0, in float y0, in float x1, in float y1)
49             raises (DOMException);
50         CanvasGradient createRadialGradient(in float x0, in float y0, in float r0, in float x1, in float y1, in float r1)
51             raises (DOMException);
52
53         attribute float lineWidth;
54         attribute [ConvertNullToNullString] DOMString lineCap;
55         attribute [ConvertNullToNullString] DOMString lineJoin;
56         attribute float miterLimit;
57
58         attribute float shadowOffsetX;
59         attribute float shadowOffsetY;
60         attribute float shadowBlur;
61         attribute [ConvertNullToNullString] DOMString shadowColor;
62
63         void clearRect(in float x, in float y, in float width, in float height);
64         void fillRect(in float x, in float y, in float width, in float height);
65
66         void beginPath();
67         void closePath();
68         void moveTo(in float x, in float y);
69         void lineTo(in float x, in float y);
70         void quadraticCurveTo(in float cpx, in float cpy, in float x, in float y);
71         void bezierCurveTo(in float cp1x, in float cp1y, in float cp2x, in float cp2y, in float x, in float y);
72         void arcTo(in float x1, in float y1, in float x2, in float y2, in float radius)
73             raises (DOMException);
74         void rect(in float x, in float y, in float width, in float height);
75         void arc(in float x, in float y, in float radius, in float startAngle, in float endAngle, in boolean anticlockwise)
76             raises (DOMException);
77         void fill();
78         void stroke();
79         void clip();
80         boolean isPointInPath(in float x, in float y);
81
82         // text
83         attribute DOMString font;
84         attribute DOMString textAlign;
85         attribute DOMString textBaseline;
86
87         TextMetrics measureText(in DOMString text);
88
89         // other
90
91         void setAlpha(in float alpha);
92         void setCompositeOperation(in DOMString compositeOperation);
93
94 #if !defined(LANGUAGE_CPP) || !LANGUAGE_CPP
95         void setLineWidth(in float width);
96         void setLineCap(in DOMString cap);
97         void setLineJoin(in DOMString join);
98         void setMiterLimit(in float limit);
99 #endif
100
101         void clearShadow();
102
103         [RequiresAllArguments=Raise] void fillText(in DOMString text, in float x, in float y, in [Optional] float maxWidth);
104         [RequiresAllArguments=Raise] void strokeText(in DOMString text, in float x, in float y, in [Optional] float maxWidth);
105
106         void setStrokeColor(in DOMString color, in [Optional] float alpha);
107         void setStrokeColor(in float grayLevel, in [Optional] float alpha);
108         void setStrokeColor(in float r, in float g, in float b, in float a);
109         void setStrokeColor(in float c, in float m, in float y, in float k, in float a);
110
111         void setFillColor(in DOMString color, in [Optional] float alpha);
112         void setFillColor(in float grayLevel, in [Optional] float alpha);
113         void setFillColor(in float r, in float g, in float b, in float a);
114         void setFillColor(in float c, in float m, in float y, in float k, in float a);
115
116         void strokeRect(in float x, in float y, in float width, in float height, in [Optional] float lineWidth);
117
118         [RequiresAllArguments=Raise] void drawImage(in HTMLImageElement image, in float x, in float y)
119             raises (DOMException);
120         [RequiresAllArguments=Raise] void drawImage(in HTMLImageElement image, in float x, in float y, in float width, in float height)
121             raises (DOMException);
122         [RequiresAllArguments=Raise] void drawImage(in HTMLImageElement image, in float sx, in float sy, in float sw, in float sh, in float dx, in float dy, in float dw, in float dh)
123             raises (DOMException);
124         [RequiresAllArguments=Raise] void drawImage(in HTMLCanvasElement canvas, in float x, in float y)
125             raises (DOMException);
126         [RequiresAllArguments=Raise] void drawImage(in HTMLCanvasElement canvas, in float x, in float y, in float width, in float height)
127             raises (DOMException);
128         [RequiresAllArguments=Raise] void drawImage(in HTMLCanvasElement canvas, in float sx, in float sy, in float sw, in float sh, in float dx, in float dy, in float dw, in float dh)
129             raises (DOMException);
130 #if defined(ENABLE_VIDEO) && ENABLE_VIDEO
131         [RequiresAllArguments=Raise] void drawImage(in HTMLVideoElement video, in float x, in float y)
132             raises (DOMException);
133         [RequiresAllArguments=Raise] void drawImage(in HTMLVideoElement video, in float x, in float y, in float width, in float height)
134             raises (DOMException);
135         [RequiresAllArguments=Raise] void drawImage(in HTMLVideoElement video, in float sx, in float sy, in float sw, in float sh, in float dx, in float dy, in float dw, in float dh)
136             raises (DOMException);
137 #endif
138
139         [RequiresAllArguments=Raise] void drawImageFromRect(in HTMLImageElement image,
140                                                             in [Optional] float sx, in [Optional] float sy, in [Optional] float sw, in [Optional] float sh,
141                                                             in [Optional] float dx, in [Optional] float dy, in [Optional] float dw, in [Optional] float dh,
142                                                             in [Optional] DOMString compositeOperation);
143
144         void setShadow(in float width, in float height, in float blur, in [Optional] DOMString color, in [Optional] float alpha);
145         void setShadow(in float width, in float height, in float blur, in float grayLevel, in [Optional] float alpha);
146         void setShadow(in float width, in float height, in float blur, in float r, in float g, in float b, in float a);
147         void setShadow(in float width, in float height, in float blur, in float c, in float m, in float y, in float k, in float a);
148
149 #if defined(V8_BINDING) && V8_BINDING
150         CanvasPattern createPattern(in HTMLCanvasElement canvas, in [ConvertNullToNullString] DOMString repetitionType)
151             raises (DOMException);
152         CanvasPattern createPattern(in HTMLImageElement image, in [ConvertNullToNullString] DOMString repetitionType)
153             raises (DOMException);
154         void putImageData(in ImageData imagedata, in float dx, in float dy, in [Optional] float dirtyX, in float dirtyY, in float dirtyWidth, in float dirtyHeight)
155             raises(DOMException);
156         ImageData createImageData(in ImageData imagedata)
157             raises (DOMException);
158         ImageData createImageData(in float sw, in float sh)
159             raises (DOMException);
160 #else
161         // FIXME: Remove 'else' once JSC supports overloads too.
162         [Custom] void createPattern(/* 2 */);
163         [Custom] void putImageData(/* in ImageData imagedata, in float dx, in float dy [, in float dirtyX, in float dirtyY, in float dirtyWidth, in float dirtyHeight] */);
164         [Custom] ImageData createImageData(/* 3 */);
165 #endif // defined(V8_BINDING)
166
167         attribute [Custom] custom strokeStyle;
168         attribute [Custom] custom fillStyle;
169
170         // pixel manipulation
171         ImageData getImageData(in float sx, in float sy, in float sw, in float sh)
172             raises(DOMException);
173     };
174
175 }
176