michael@0: /* This Source Code Form is subject to the terms of the Mozilla Public
michael@0:  * License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0:  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0: 
michael@0: #include "nsISupports.idl"
michael@0: 
michael@0: interface nsIStandaloneNativeMenu;
michael@0: 
michael@0: /**
michael@0:  * Allow applications to interface with the Mac OS X Dock.
michael@0:  *
michael@0:  * Applications may indicate progress on their Dock icon. Only one such
michael@0:  * progress indicator is available to the entire application.
michael@0:  */
michael@0: 
michael@0: [scriptable, uuid(8BE66B0C-5F71-4B74-98CF-6C2551B999B1)]
michael@0: interface nsIMacDockSupport : nsISupports
michael@0: {
michael@0:   /**
michael@0:    * Menu to use for application-specific dock menu items.
michael@0:    */
michael@0:   attribute nsIStandaloneNativeMenu dockMenu;
michael@0: 
michael@0:   /**
michael@0:    * Activate the application. This should be used by an application to
michael@0:    * activate itself when a dock menu is selected as selection of a dock menu
michael@0:    * item does not automatically activate the application.
michael@0:    *
michael@0:    * @param aIgnoreOtherApplications If false, the application is activated
michael@0:    *        only if no other application is currently active. If true, the
michael@0:    *        application activates regardless. 
michael@0:    */
michael@0:   void activateApplication(in boolean aIgnoreOtherApplications);
michael@0: 
michael@0:   /**
michael@0:    * Text used to badge the dock tile.
michael@0:    */
michael@0:   attribute AString badgeText;
michael@0: };