widget/nsISystemStatusBar.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 "nsISupports.idl"
   6
   7 webidl Element;
   8
   9 /**
  10  * Allow applications to interface with the Mac OS X system status bar.
  11  */
  12
  13 [scriptable, uuid(24493180-ee81-4b7c-8b17-9e69480b7b8a)]
  14 interface nsISystemStatusBar : nsISupports
  15 {
  16   /**
  17    * Add an item to the system status bar. Each item can only be present once,
  18    * subsequent addItem calls with the same element will be ignored.
  19    * The system status bar holds a strong reference to the added XUL menu
  20    * element and the item will stay in the status bar until it is removed via
  21    * a call to removeItem, or until the process shuts down.
  22    * @param aDOMMenuElement A XUL menu element that contains a XUL menupopup
  23    *                        with regular menu content. The menu's icon is put
  24    *                        into the system status bar; clicking it will open
  25    *                        a menu with the contents of the menupopup.
  26    *                        The menu label is not shown.
  27    */
  28   void addItem(in Element aMenuElement);
  29
  30   /**
  31    * Remove a previously-added item from the menu bar. Calling this with an
  32    * element that has not been added before will be silently ignored.
  33    * @param aDOMMenuElement The XUL menu element that you called addItem with.
  34    */
  35   void removeItem(in Element aMenuElement);
  36 };