third_party/WebKit/public/web/WebDOMMessageEvent.h

   1 /*
   2  * Copyright (C) 2011 Google Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  *     * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *     * Redistributions in binary form must reproduce the above
  11  * copyright notice, this list of conditions and the following disclaimer
  12  * in the documentation and/or other materials provided with the
  13  * distribution.
  14  *     * Neither the name of Google Inc. nor the names of its
  15  * contributors may be used to endorse or promote products derived from
  16  * this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30 #ifndef WebDOMMessageEvent_h
  31 #define WebDOMMessageEvent_h
  32
  33 #include "../platform/WebMessagePortChannel.h"
  34 #include "WebDOMEvent.h"
  35 #include "WebSerializedScriptValue.h"
  36
  37 #if BLINK_IMPLEMENTATION
  38 #include "core/events/Event.h"
  39 #include "core/events/MessageEvent.h"
  40 #endif
  41
  42 namespace blink {
  43
  44 class WebFrame;
  45 class WebString;
  46
  47 // An interface for posting message events to the target frame. The message
  48 // events are used for communication between documents and described here:
  49 // http://www.w3.org/TR/2012/WD-webmessaging-20120313/#terminology
  50 class WebDOMMessageEvent : public WebDOMEvent {
  51 public:
  52     WebDOMMessageEvent() { }
  53     BLINK_EXPORT void initMessageEvent(const WebString& type, bool canBubble, bool cancelable, const WebSerializedScriptValue& messageData, const WebString& origin, const WebFrame* sourceFrame, const WebDocument& targetDocument, const WebString& lastEventId, const WebMessagePortChannelArray& channels = WebMessagePortChannelArray());
  54
  55     BLINK_EXPORT WebSerializedScriptValue data() const;
  56     BLINK_EXPORT WebString origin() const;
  57
  58     BLINK_EXPORT WebMessagePortChannelArray releaseChannels();
  59
  60 #if BLINK_IMPLEMENTATION
  61     explicit WebDOMMessageEvent(const PassRefPtrWillBeRawPtr<MessageEvent>& e) : WebDOMEvent(e) { }
  62 #endif
  63 };
  64
  65 } // namespace blink
  66
  67 #endif