mandoline/tab/public/interfaces/frame_tree.mojom

   1 // Copyright 2015 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 module mandoline;
   6
   7 // This files defines the interfaces and structures used for frames.
   8 //
   9 // When a client in the frame tree is connected to by way of the ViewManager a
  10 // FrameTreeClient is obtained (from the ServiceProvider interface request
  11 // passed in ViewManager::OnEmbed()). The FrameTreeClient is told the frame
  12 // tree (by way of OnConnection()), which allows the client to use other
  13 // frames in the tree (assuming the client has the appropriate permissions).
  14 //
  15 // frame_ids are the same as views ids. This means that when a client creates
  16 // a new view to be part of the frame tree it immediately knows the id to use
  17 // for FrameTreeServer calls.
  18 // TODO(sky): there are likely timing issues here, figure out how to resolve
  19 // that.
  20
  21 // Provides information about a frame.
  22 struct FrameData {
  23   // 0 if the frame has no parent (its the root).
  24   uint32 parent_id;
  25   uint32 frame_id;
  26 };
  27
  28 struct MessageEvent {
  29   // TODO(sky): add details.
  30 };
  31
  32 interface FrameTreeServer {
  33   // TODO(sky): make these real.
  34   PostMessageEventToFrame(uint32 frame_id, MessageEvent event);
  35   NavigateFrame(uint32 frame_id);
  36   ReloadFrame(uint32 frame_id);
  37
  38   // Notifies the server that a load has started or stopped in this frame.
  39   // When loading is started, progress is reset to 0, but when loading is
  40   // stopped progress may not have reached 1.0.
  41   LoadingStarted();
  42   LoadingStopped();
  43
  44   // Called when the progress for this frame changes. Will only be called while
  45   // a load is in progress.
  46   ProgressChanged(double progress);
  47 };
  48
  49 interface FrameTreeClient {
  50   // Called once per client. |frame_data| gives the contents of the tree.
  51   OnConnect(FrameTreeServer server, array<FrameData> frame_data);
  52
  53   // Called when a new frame is added to the tree. This is not called on the
  54   // originator of the change.
  55   OnFrameAdded(FrameData frame_data);
  56
  57   // Called when a frame is removed from the tree. This is not called on the
  58   // originator of the change.
  59   OnFrameRemoved(uint32 frame_id);
  60 };