Source/WebCore/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 module html {
  33     interface [
  34         Conditional=BLOB,
  35         ActiveDOMObject,
  36         Constructor,
  37         CallWith=ScriptExecutionContext,
  38         EventTarget,
  39         JSNoStaticTables
  40     ] FileReader {
  41         // ready states
  42         const unsigned short EMPTY = 0;
  43         const unsigned short LOADING = 1;
  44         const unsigned short DONE = 2;
  45         readonly attribute unsigned short readyState;
  46
  47         // async read methods
  48         void readAsArrayBuffer(in Blob blob)
  49             raises(DOMException);
  50         void readAsBinaryString(in Blob blob)
  51             raises(DOMException);
  52         void readAsText(in Blob blob, in [Optional] DOMString encoding)
  53             raises(DOMException);
  54         void readAsDataURL(in Blob blob)
  55             raises(DOMException);
  56
  57         void abort();
  58
  59         // file data
  60         readonly attribute [Custom] DOMObject result;
  61
  62         readonly attribute FileError error;
  63
  64         // EventTarget interface
  65         void addEventListener(in DOMString type,
  66                               in EventListener listener,
  67                               in [Optional] boolean useCapture);
  68         void removeEventListener(in DOMString type,
  69                                  in EventListener listener,
  70                                  in [Optional] boolean useCapture);
  71         boolean dispatchEvent(in Event evt)
  72             raises(EventException);
  73
  74         attribute EventListener onloadstart;
  75         attribute EventListener onprogress;
  76         attribute EventListener onload;
  77         attribute EventListener onabort;
  78         attribute EventListener onerror;
  79         attribute EventListener onloadend;
  80     };
  81 }