[WebKit IDL] move extended attributes to left of interface, exception...
[WebKit-https.git] / Source / WebCore / dom / MessageEvent.idl
1 /*
2  * Copyright (C) 2007 Henry Mason <hmason@mac.com>
3  * Copyright (C) 2011 Google 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
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
28 [
29     JSNoStaticTables,
30     ConstructorTemplate=Event
31 ] interface MessageEvent : Event {
32     [InitializedByEventConstructor] readonly attribute DOMString origin;
33     [InitializedByEventConstructor] readonly attribute DOMString lastEventId;
34     [InitializedByEventConstructor] readonly attribute DOMWindow source;
35 #if defined(LANGUAGE_JAVASCRIPT) && LANGUAGE_JAVASCRIPT
36     [InitializedByEventConstructor, CachedAttribute, CustomGetter] readonly attribute DOMObject data;
37     [InitializedByEventConstructor, CustomGetter] readonly attribute Array ports;
38
39     [Custom] void initMessageEvent(in [Optional=DefaultIsUndefined] DOMString typeArg, 
40                                    in [Optional=DefaultIsUndefined] boolean canBubbleArg, 
41                                    in [Optional=DefaultIsUndefined] boolean cancelableArg, 
42                                    in [Optional=DefaultIsUndefined] DOMObject dataArg, 
43                                    in [Optional=DefaultIsUndefined] DOMString originArg, 
44                                    in [Optional=DefaultIsUndefined] DOMString lastEventIdArg, 
45                                    in [Optional=DefaultIsUndefined] DOMWindow sourceArg, 
46                                    in [Optional=DefaultIsUndefined] Array messagePorts);
47
48     [Custom] void webkitInitMessageEvent(in [Optional=DefaultIsUndefined] DOMString typeArg,
49                                          in [Optional=DefaultIsUndefined] boolean canBubbleArg,
50                                          in [Optional=DefaultIsUndefined] boolean cancelableArg,
51                                          in [Optional=DefaultIsUndefined] DOMObject dataArg,
52                                          in [Optional=DefaultIsUndefined] DOMString originArg,
53                                          in [Optional=DefaultIsUndefined] DOMString lastEventIdArg,
54                                          in [Optional=DefaultIsUndefined] DOMWindow sourceArg,
55                                          in [Optional=DefaultIsUndefined] Array transferables);
56 #else
57     // Code generator for ObjC bindings does not support custom bindings, thus there is no good way to
58     // return a variant value. As workaround, expose the data attribute as SerializedScriptValue.
59     readonly attribute SerializedScriptValue data;
60
61     // There's no good way to expose an array via the ObjC bindings, so for now just expose a single port.
62     readonly attribute MessagePort messagePort;
63
64     void initMessageEvent(in [Optional=DefaultIsUndefined] DOMString typeArg, 
65                           in [Optional=DefaultIsUndefined] boolean canBubbleArg, 
66                           in [Optional=DefaultIsUndefined] boolean cancelableArg, 
67                           in [Optional=DefaultIsUndefined] SerializedScriptValue dataArg, 
68                           in [Optional=DefaultIsUndefined] DOMString originArg, 
69                           in [Optional=DefaultIsUndefined] DOMString lastEventIdArg, 
70                           in [Optional=DefaultIsUndefined] DOMWindow sourceArg, 
71                           in [Optional=DefaultIsUndefined] MessagePort messagePort);
72 #endif
73
74 };
75