Add the "JS" prefix to JSC specific IDL attributes
[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 module events {
29
30     interface [
31         JSNoStaticTables,
32         ConstructorTemplate=Event
33     ] MessageEvent : Event {
34         readonly attribute [InitializedByEventConstructor] DOMString origin;
35         readonly attribute [InitializedByEventConstructor] DOMString lastEventId;
36         readonly attribute [InitializedByEventConstructor] DOMWindow source;
37 #if defined(LANGUAGE_JAVASCRIPT) && LANGUAGE_JAVASCRIPT
38         readonly attribute [InitializedByEventConstructor, CachedAttribute, CustomGetter] DOMObject data;
39         readonly attribute [InitializedByEventConstructor, CustomGetter] Array ports;
40
41         [Custom] void initMessageEvent(in [Optional=CallWithDefaultValue] DOMString typeArg, 
42                                        in [Optional=CallWithDefaultValue] boolean canBubbleArg, 
43                                        in [Optional=CallWithDefaultValue] boolean cancelableArg, 
44                                        in [Optional=CallWithDefaultValue] DOMObject dataArg, 
45                                        in [Optional=CallWithDefaultValue] DOMString originArg, 
46                                        in [Optional=CallWithDefaultValue] DOMString lastEventIdArg, 
47                                        in [Optional=CallWithDefaultValue] DOMWindow sourceArg, 
48                                        in [Optional=CallWithDefaultValue] Array messagePorts);
49
50         [Custom] void webkitInitMessageEvent(in [Optional=CallWithDefaultValue] DOMString typeArg,
51                                              in [Optional=CallWithDefaultValue] boolean canBubbleArg,
52                                              in [Optional=CallWithDefaultValue] boolean cancelableArg,
53                                              in [Optional=CallWithDefaultValue] DOMObject dataArg,
54                                              in [Optional=CallWithDefaultValue] DOMString originArg,
55                                              in [Optional=CallWithDefaultValue] DOMString lastEventIdArg,
56                                              in [Optional=CallWithDefaultValue] DOMWindow sourceArg,
57                                              in [Optional=CallWithDefaultValue] Array transferables);
58 #else
59         // Code generator for ObjC bindings does not support custom bindings, thus there is no good way to
60         // return a variant value. As workaround, expose the data attribute as SerializedScriptValue.
61         readonly attribute SerializedScriptValue data;
62
63         // There's no good way to expose an array via the ObjC bindings, so for now just expose a single port.
64         readonly attribute MessagePort messagePort;
65
66         void initMessageEvent(in [Optional=CallWithDefaultValue] DOMString typeArg, 
67                               in [Optional=CallWithDefaultValue] boolean canBubbleArg, 
68                               in [Optional=CallWithDefaultValue] boolean cancelableArg, 
69                               in [Optional=CallWithDefaultValue] SerializedScriptValue dataArg, 
70                               in [Optional=CallWithDefaultValue] DOMString originArg, 
71                               in [Optional=CallWithDefaultValue] DOMString lastEventIdArg, 
72                               in [Optional=CallWithDefaultValue] DOMWindow sourceArg, 
73                               in [Optional=CallWithDefaultValue] MessagePort messagePort);
74 #endif
75
76     };
77
78 }