1 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2 /* ***** BEGIN LICENSE BLOCK *****
3 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
4 *
5 * The contents of this file are subject to the Mozilla Public License Version
6 * 1.1 (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 * http://www.mozilla.org/MPL/
9 *
10 * Software distributed under the License is distributed on an "AS IS" basis,
11 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
12 * for the specific language governing rights and limitations under the
13 * License.
14 *
15 * The Original Code is mozilla.org code.
16 *
17 * The Initial Developer of the Original Code is
18 * Vladimir Vukicevic <vladimir@pobox.com>
19 * Portions created by the Initial Developer are Copyright (C) 2005
20 * the Initial Developer. All Rights Reserved.
21 *
22 * Contributor(s):
23 *
24 * Alternatively, the contents of this file may be used under the terms of
25 * either of the GNU General Public License Version 2 or later (the "GPL"),
26 * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
27 * in which case the provisions of the GPL or the LGPL are applicable instead
28 * of those above. If you wish to allow use of your version of this file only
29 * under the terms of either the GPL or the LGPL, and not to allow others to
30 * use your version of this file under the terms of the MPL, indicate your
31 * decision by deleting the provisions above and replace them with the notice
32 * and other provisions required by the GPL or the LGPL. If you do not delete
33 * the provisions above, a recipient may use your version of this file under
34 * the terms of any one of the MPL, the GPL or the LGPL.
35 *
36 * ***** END LICENSE BLOCK ***** */
37
38 #include "nsIDOMHTMLElement.idl"
39
40 /**
41 * The nsIDOMHTMLCanvasElement interface is the interface to a HTML
42 * <canvas> element.
43 *
44 * For more information on this interface, please see
45 * http://www.whatwg.org/specs/web-apps/current-work/#graphics
46 *
47 * @status UNDER_DEVELOPMENT
48 */
49
50 [scriptable, uuid(0583A2EA-AB19-40e1-8BE4-5E9B2F275560)]
51 interface nsIDOMHTMLCanvasElement : nsIDOMHTMLElement
52 {
53 attribute long width;
54 attribute long height;
55
56 nsISupports getContext(in DOMString contextId);
57
58 // This version will query the JS context for its arguments; C++
59 // callers should use toDataURLAs.
60 //
61 // Valid calls are:
62 // toDataURL(); -- defaults to image/png
63 // toDataURL(type); -- uses given type
64 // toDataURL(type, params); -- only available to trusted callers
65 DOMString toDataURL();
66
67 // This version lets you specify different image types and pass parameters
68 // to the encoder. For example toDataURLAs("image/png", "transparency=none")
69 // gives you a PNG with the alpha channel discarded. See the encoder for
70 // the options string that it supports. Separate multiple options with
71 // semicolons.
72 [noscript] DOMString toDataURLAs(in DOMString mimeType, in DOMString encoderOptions);
73 };