summaryrefslogtreecommitdiff
path: root/Source/WebCore/dom/MessageEvent.idl
blob: c8356ed60c112b35cff300eb3a40f252efcaacf8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
/*
 * Copyright (C) 2007 Henry Mason <hmason@mac.com>
 * Copyright (C) 2011 Google Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
 *
 */

module events {

    interface [
        JSNoStaticTables,
        ConstructorTemplate=Event
    ] MessageEvent : Event {
        readonly attribute [InitializedByEventConstructor] DOMString origin;
        readonly attribute [InitializedByEventConstructor] DOMString lastEventId;
        readonly attribute [InitializedByEventConstructor] DOMWindow source;
#if defined(LANGUAGE_JAVASCRIPT) && LANGUAGE_JAVASCRIPT
        readonly attribute [InitializedByEventConstructor, CachedAttribute, CustomGetter] DOMObject data;
        readonly attribute [InitializedByEventConstructor, CustomGetter] Array ports;

        [Custom] void initMessageEvent(in [Optional=DefaultIsUndefined] DOMString typeArg, 
                                       in [Optional=DefaultIsUndefined] boolean canBubbleArg, 
                                       in [Optional=DefaultIsUndefined] boolean cancelableArg, 
                                       in [Optional=DefaultIsUndefined] DOMObject dataArg, 
                                       in [Optional=DefaultIsUndefined] DOMString originArg, 
                                       in [Optional=DefaultIsUndefined] DOMString lastEventIdArg, 
                                       in [Optional=DefaultIsUndefined] DOMWindow sourceArg, 
                                       in [Optional=DefaultIsUndefined] Array messagePorts);

        [Custom] void webkitInitMessageEvent(in [Optional=DefaultIsUndefined] DOMString typeArg,
                                             in [Optional=DefaultIsUndefined] boolean canBubbleArg,
                                             in [Optional=DefaultIsUndefined] boolean cancelableArg,
                                             in [Optional=DefaultIsUndefined] DOMObject dataArg,
                                             in [Optional=DefaultIsUndefined] DOMString originArg,
                                             in [Optional=DefaultIsUndefined] DOMString lastEventIdArg,
                                             in [Optional=DefaultIsUndefined] DOMWindow sourceArg,
                                             in [Optional=DefaultIsUndefined] Array transferables);
#else
        // Code generator for ObjC bindings does not support custom bindings, thus there is no good way to
        // return a variant value. As workaround, expose the data attribute as SerializedScriptValue.
        readonly attribute SerializedScriptValue data;

        // There's no good way to expose an array via the ObjC bindings, so for now just expose a single port.
        readonly attribute MessagePort messagePort;

        void initMessageEvent(in [Optional=DefaultIsUndefined] DOMString typeArg, 
                              in [Optional=DefaultIsUndefined] boolean canBubbleArg, 
                              in [Optional=DefaultIsUndefined] boolean cancelableArg, 
                              in [Optional=DefaultIsUndefined] SerializedScriptValue dataArg, 
                              in [Optional=DefaultIsUndefined] DOMString originArg, 
                              in [Optional=DefaultIsUndefined] DOMString lastEventIdArg, 
                              in [Optional=DefaultIsUndefined] DOMWindow sourceArg, 
                              in [Optional=DefaultIsUndefined] MessagePort messagePort);
#endif

    };

}