widget/nsIMacDockSupport.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 interface nsIStandaloneNativeMenu;
   8
   9 /**
  10  * Allow applications to interface with the Mac OS X Dock.
  11  *
  12  * Applications may indicate progress on their Dock icon. Only one such
  13  * progress indicator is available to the entire application.
  14  */
  15
  16 [scriptable, uuid(8BE66B0C-5F71-4B74-98CF-6C2551B999B1)]
  17 interface nsIMacDockSupport : nsISupports
  18 {
  19   /**
  20    * Menu to use for application-specific dock menu items.
  21    */
  22   attribute nsIStandaloneNativeMenu dockMenu;
  23
  24   /**
  25    * Activate the application. This should be used by an application to
  26    * activate itself when a dock menu is selected as selection of a dock menu
  27    * item does not automatically activate the application.
  28    *
  29    * @param aIgnoreOtherApplications If false, the application is activated
  30    *        only if no other application is currently active. If true, the
  31    *        application activates regardless.
  32    */
  33   void activateApplication(in boolean aIgnoreOtherApplications);
  34
  35   /**
  36    * Text used to badge the dock tile.
  37    */
  38   attribute AString badgeText;
  39 };