widget/nsITouchBarHelper.idl

   1 /* This Source Code Form is subject to the terms of the Mozilla Public
   2  * License, v. 2.0. If a copy of the MPL was not distributed with this
   3  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   4
   5 #include "nsIArray.idl"
   6 #include "nsISupports.idl"
   7 #include "nsITouchBarInput.idl"
   8
   9 webidl Document;
  10
  11 /**
  12  * Back-to-frontend communication for the Touch Bar
  13  */
  14 [scriptable, uuid(ea109912-3acc-48de-b679-c23b6a122da5)]
  15 interface nsITouchBarHelper : nsISupports
  16 {
  17   /**
  18    * Returns the active browser's URL.
  19    */
  20   readonly attribute AString activeUrl;
  21
  22   /**
  23    * Return the active browser's page title.
  24    */
  25   readonly attribute AString activeTitle;
  26
  27   /**
  28    * Return true if the Urlbar has focus.
  29    */
  30   readonly attribute boolean isUrlbarFocused;
  31
  32   /**
  33    * Returns all available Touch Bar Inputs in an nsIArray
  34    * of nsITouchBarInput objects.
  35    */
  36   attribute nsIArray allItems;
  37
  38   /**
  39    * The context in which this nsITouchBarHelper exists. Required to create
  40    * an imgLoader to load our SVG icons.
  41    */
  42   readonly attribute Document document;
  43
  44   /**
  45    * Returns the requested TouchBarInput.
  46    * Exposed for testing.
  47    */
  48   nsITouchBarInput getTouchBarInput(in string aInputName);
  49
  50   /**
  51    * Inserts a search restriction string in the Urlbar.
  52    * Exposed for testing.
  53    */
  54   void insertRestrictionInUrlbar(in string aToken);
  55 };