src/third_party/WebKit/Source/core/fileapi/FileReader.idl

   1 /*
   2  * Copyright (C) 2010 Google Inc.  All rights reserved.
   3  * Copyright (C) 2011 Apple Inc. 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 are
   7  * met:
   8  *
   9  *     * Redistributions of source code must retain the above copyright
  10  * notice, this list of conditions and the following disclaimer.
  11  *     * Redistributions in binary form must reproduce the above
  12  * copyright notice, this list of conditions and the following disclaimer
  13  * in the documentation and/or other materials provided with the
  14  * distribution.
  15  *     * Neither the name of Google Inc. nor the names of its
  16  * contributors may be used to endorse or promote products derived from
  17  * this software without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  22  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  23  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  29  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30  */
  31
  32 [
  33     WillBeGarbageCollected,
  34     ActiveDOMObject,
  35     Constructor,
  36     ConstructorCallWith=ExecutionContext,
  37     Exposed=Window&Worker
  38 ] interface FileReader : EventTarget {
  39     // ready states
  40     const unsigned short EMPTY = 0;
  41     const unsigned short LOADING = 1;
  42     const unsigned short DONE = 2;
  43     readonly attribute unsigned short readyState;
  44
  45     // async read methods
  46     [RaisesException] void readAsArrayBuffer(Blob blob);
  47     [RaisesException] void readAsBinaryString(Blob blob);
  48     [RaisesException] void readAsText(Blob blob, optional DOMString encoding);
  49     [RaisesException] void readAsDataURL(Blob blob);
  50
  51     void abort();
  52
  53     // file data
  54     [Custom=Getter] readonly attribute object result;
  55
  56     readonly attribute FileError error;
  57
  58     attribute EventHandler onloadstart;
  59     attribute EventHandler onprogress;
  60     attribute EventHandler onload;
  61     attribute EventHandler onabort;
  62     attribute EventHandler onerror;
  63     attribute EventHandler onloadend;
  64 };