initial import
[vuplus_webkit] / Source / WebCore / dom / MessageEvent.idl
1 /*
2  * Copyright (C) 2007 Henry Mason <hmason@mac.com>
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  *
25  */
26
27 module events {
28
29     interface [
30         NoStaticTables
31     ] MessageEvent : Event {
32         readonly attribute DOMString origin;
33         readonly attribute DOMString lastEventId;
34         readonly attribute DOMWindow source;
35 #if defined(LANGUAGE_JAVASCRIPT) && LANGUAGE_JAVASCRIPT
36         readonly attribute [CachedAttribute, CustomGetter] any data;
37         readonly attribute [CustomGetter] Array ports;
38
39         [Custom] void initMessageEvent(in [Optional=CallWithDefaultValue] DOMString typeArg, 
40                                        in [Optional=CallWithDefaultValue] boolean canBubbleArg, 
41                                        in [Optional=CallWithDefaultValue] boolean cancelableArg, 
42                                        in [Optional=CallWithDefaultValue] SerializedScriptValue dataArg, 
43                                        in [Optional=CallWithDefaultValue] DOMString originArg, 
44                                        in [Optional=CallWithDefaultValue] DOMString lastEventIdArg, 
45                                        in [Optional=CallWithDefaultValue] DOMWindow sourceArg, 
46                                        in [Optional=CallWithDefaultValue] Array messagePorts);
47 #else
48         // Code generator for ObjC bindings does not support custom bindings, thus there is no good way to
49         // return a variant value. As workaround, expose the data attribute as SerializedScriptValue.
50         readonly attribute SerializedScriptValue data;
51
52         // There's no good way to expose an array via the ObjC bindings, so for now just expose a single port.
53         readonly attribute MessagePort messagePort;
54
55         void initMessageEvent(in [Optional=CallWithDefaultValue] DOMString typeArg, 
56                               in [Optional=CallWithDefaultValue] boolean canBubbleArg, 
57                               in [Optional=CallWithDefaultValue] boolean cancelableArg, 
58                               in [Optional=CallWithDefaultValue] SerializedScriptValue dataArg, 
59                               in [Optional=CallWithDefaultValue] DOMString originArg, 
60                               in [Optional=CallWithDefaultValue] DOMString lastEventIdArg, 
61                               in [Optional=CallWithDefaultValue] DOMWindow sourceArg, 
62                               in [Optional=CallWithDefaultValue] MessagePort messagePort);
63 #endif
64
65     };
66
67 }