dom/browser-element/nsIBrowserElementAPI.idl

   1 /* -*- Mode: IDL; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this file,
   5  * You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #include "nsISupports.idl"
   8
   9 webidl FrameLoader;
  10
  11 %{C++
  12 #define BROWSER_ELEMENT_API_CONTRACTID "@mozilla.org/dom/browser-element-api;1"
  13 #define BROWSER_ELEMENT_API_CID                                 \
  14     { 0x651db7e3, 0x1734, 0x4536,                               \
  15       { 0xb1, 0x5a, 0x5b, 0x3a, 0xe6, 0x44, 0x13, 0x4c } }
  16 %}
  17
  18 /**
  19  * Interface to the BrowserElementParent implementation. All methods
  20  * but setFrameLoader throw when the remote process is dead.
  21  */
  22 [scriptable, uuid(57758c10-6036-11e5-a837-0800200c9a66)]
  23 interface nsIBrowserElementAPI : nsISupports
  24 {
  25   /**
  26    * Notify frame scripts that support the API to destroy.
  27    */
  28   void destroyFrameScripts();
  29
  30   void setFrameLoader(in FrameLoader frameLoader);
  31
  32   void sendMouseEvent(in AString type,
  33                       in uint32_t x,
  34                       in uint32_t y,
  35                       in uint32_t button,
  36                       in uint32_t clickCount,
  37                       in uint32_t mifiers);
  38   void goBack();
  39   void goForward();
  40   void reload(in boolean hardReload);
  41   void stop();
  42   Promise getCanGoBack();
  43   Promise getCanGoForward();
  44 };