widget/nsIMacDockSupport.idl

changeset 0
6474c204b198
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/widget/nsIMacDockSupport.idl	Wed Dec 31 06:09:35 2014 +0100
     1.3 @@ -0,0 +1,39 @@
     1.4 +/* This Source Code Form is subject to the terms of the Mozilla Public
     1.5 + * License, v. 2.0. If a copy of the MPL was not distributed with this
     1.6 + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
     1.7 +
     1.8 +#include "nsISupports.idl"
     1.9 +
    1.10 +interface nsIStandaloneNativeMenu;
    1.11 +
    1.12 +/**
    1.13 + * Allow applications to interface with the Mac OS X Dock.
    1.14 + *
    1.15 + * Applications may indicate progress on their Dock icon. Only one such
    1.16 + * progress indicator is available to the entire application.
    1.17 + */
    1.18 +
    1.19 +[scriptable, uuid(8BE66B0C-5F71-4B74-98CF-6C2551B999B1)]
    1.20 +interface nsIMacDockSupport : nsISupports
    1.21 +{
    1.22 +  /**
    1.23 +   * Menu to use for application-specific dock menu items.
    1.24 +   */
    1.25 +  attribute nsIStandaloneNativeMenu dockMenu;
    1.26 +
    1.27 +  /**
    1.28 +   * Activate the application. This should be used by an application to
    1.29 +   * activate itself when a dock menu is selected as selection of a dock menu
    1.30 +   * item does not automatically activate the application.
    1.31 +   *
    1.32 +   * @param aIgnoreOtherApplications If false, the application is activated
    1.33 +   *        only if no other application is currently active. If true, the
    1.34 +   *        application activates regardless. 
    1.35 +   */
    1.36 +  void activateApplication(in boolean aIgnoreOtherApplications);
    1.37 +
    1.38 +  /**
    1.39 +   * Text used to badge the dock tile.
    1.40 +   */
    1.41 +  attribute AString badgeText;
    1.42 +};

mercurial