f0c1b53fe8d2f282ddd0a32af0b8976bc54dffa9
[WebKit-https.git] / Source / WebCore / Modules / filesystem / FileWriter.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     Conditional=FILE_SYSTEM,
34     ActiveDOMObject,
35     CallWith=ScriptExecutionContext,
36     EventTarget,
37     JSNoStaticTables
38 ] interface FileWriter {
39     // ready states
40     const unsigned short INIT = 0;
41     const unsigned short WRITING = 1;
42     const unsigned short DONE = 2;
43     readonly attribute unsigned short readyState;
44
45     // async write/modify methods
46     void write(Blob data) raises (FileException);
47     void seek(long long position) raises (FileException);
48     void truncate(long long size) raises (FileException);
49
50     void abort() raises (FileException);
51
52     readonly attribute FileError error;
53     readonly attribute long long position;
54     readonly attribute long long length;
55
56              attribute EventListener onwritestart;
57              attribute EventListener onprogress;
58              attribute EventListener onwrite;
59              attribute EventListener onabort;
60              attribute EventListener onerror;
61              attribute EventListener onwriteend;
62
63     // EventTarget interface
64     void addEventListener(DOMString type,
65                           EventListener listener,
66                           optional boolean useCapture);
67     void removeEventListener(DOMString type,
68                              EventListener listener,
69                              optional boolean useCapture);
70     boolean dispatchEvent(Event evt)
71         raises(EventException);
72 };