third_party/WebKit/Source/core/html/HTMLCanvasElement.idl

   1 /*
   2  * Copyright (C) 2006, 2008, 2009 Apple Inc. All rights reserved.
   3  * Copyright (C) 2010 Torch Mobile (Beijing) Co. Ltd. All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
  15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
  18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  */
  26
  27 // https://html.spec.whatwg.org/#the-canvas-element
  28
  29 interface HTMLCanvasElement : HTMLElement
  30 {
  31     // FIXME: width and height should be unsigned long.
  32     attribute long width;
  33     attribute long height;
  34
  35     // Note: this differs deliberately from the specified Web IDL for this function:
  36     //     RenderingContext? getContext(DOMString contextId, any... arguments);
  37     // in order to eliminate the custom binding. It is functionally equivalent.
  38     //
  39     // The PermissiveDictionaryConversion extended attribute is needed to allow the
  40     // autogenerated code to match the behavior of the custom binding. Web IDL
  41     // requires throwing TypeError if the incoming argument is not an object type
  42     // (and is not undefined or null). The binding must ignore this.
  43     //
  44     // Also note: the only reason this must return type "any" is to allow the
  45     // InspectorInstrumentation wrappers to be called for canvases. If that could be
  46     // handled differently the return type could be changed to "RenderingContext?"
  47     // and the [CallWith=ScriptState] extended attribute removed.
  48     //
  49     [CallWith=ScriptState] any getContext(DOMString contextId, [PermissiveDictionaryConversion] optional CanvasContextCreationAttributes attributes);
  50
  51     // Note: The arguments argument is variadic in the spec, but not here as
  52     // only one extra argument is actually used.
  53     // FIXME: type should not have a default value.
  54     [RaisesException] DOMString toDataURL(optional DOMString type = null, optional any arguments);
  55
  56     [RaisesException, RuntimeEnabled=ExperimentalCanvasFeatures] void toBlob(FileCallback? _callback, optional DOMString type = null, optional any arguments);
  57 };