third_party/WebKit/Source/core/frame/FrameClient.h

   1 // Copyright 2014 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef FrameClient_h
   6 #define FrameClient_h
   7
   8 #include "core/CoreExport.h"
   9 #include "platform/heap/Handle.h"
  10
  11 namespace blink {
  12
  13 class Frame;
  14 class LocalFrame;
  15 class MessageEvent;
  16 class SecurityOrigin;
  17 enum class FrameDetachType;
  18
  19 class CORE_EXPORT FrameClient : public NoBaseWillBeGarbageCollectedFinalized<FrameClient> {
  20     WTF_MAKE_FAST_ALLOCATED_WILL_BE_REMOVED(FrameClient);
  21 public:
  22     virtual bool inShadowTree() const = 0;
  23
  24     // TODO(dcheng): Move this into FrameLoaderClient, since remote frames don't
  25     // need this.
  26     virtual void willBeDetached() = 0;
  27     virtual void detached(FrameDetachType) = 0;
  28
  29     virtual Frame* opener() const = 0;
  30     virtual void setOpener(Frame*) = 0;
  31
  32     virtual Frame* parent() const = 0;
  33     virtual Frame* top() const = 0;
  34     virtual Frame* previousSibling() const = 0;
  35     virtual Frame* nextSibling() const = 0;
  36     virtual Frame* firstChild() const = 0;
  37     virtual Frame* lastChild() const = 0;
  38
  39     virtual unsigned backForwardLength() = 0;
  40
  41     // Returns true if the embedder intercepted the postMessage call
  42     virtual bool willCheckAndDispatchMessageEvent(SecurityOrigin* /*target*/, MessageEvent*, LocalFrame* /*sourceFrame*/) const { return false; }
  43
  44     virtual ~FrameClient() { }
  45
  46     DEFINE_INLINE_VIRTUAL_TRACE() { }
  47 };
  48
  49 } // namespace blink
  50
  51 #endif // FrameClient_h