widget/public/nsIMacDockSupport.idl

   1 /* ***** BEGIN LICENSE BLOCK *****
   2  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   3  *
   4  * The contents of this file are subject to the Mozilla Public License Version
   5  * 1.1 (the "License"); you may not use this file except in compliance with
   6  * the License. You may obtain a copy of the License at
   7  * http://www.mozilla.org/MPL/
   8  *
   9  * Software distributed under the License is distributed on an "AS IS" basis,
  10  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11  * for the specific language governing rights and limitations under the
  12  * License.
  13  *
  14  * The Original Code is Mac Dock Support
  15  *
  16  * The Initial Developer of the Original Code is
  17  * Thomas K. Dyas <tom.dyas@gmail.com>.
  18  * Portions created by the Initial Developer are Copyright (C) 2009
  19  * the Initial Developer. All Rights Reserved.
  20  *
  21  * Contributor(s):
  22  *
  23  * Alternatively, the contents of this file may be used under the terms of
  24  * either the GNU General Public License Version 2 or later (the "GPL"), or
  25  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  26  * in which case the provisions of the GPL or the LGPL are applicable instead
  27  * of those above. If you wish to allow use of your version of this file only
  28  * under the terms of either the GPL or the LGPL, and not to allow others to
  29  * use your version of this file under the terms of the MPL, indicate your
  30  * decision by deleting the provisions above and replace them with the notice
  31  * and other provisions required by the GPL or the LGPL. If you do not delete
  32  * the provisions above, a recipient may use your version of this file under
  33  * the terms of any one of the MPL, the GPL or the LGPL.
  34  *
  35  * ***** END LICENSE BLOCK ***** */
  36
  37 #include "nsISupports.idl"
  38
  39 interface nsIStandaloneNativeMenu;
  40
  41 /**
  42  * Allow applications to interface with the Mac OS X Dock.
  43  */
  44
  45 [scriptable, uuid(CBC8A835-0733-470B-A51D-B7EBBFA88689)]
  46 interface nsIMacDockSupport : nsISupports
  47 {
  48   /**
  49    * Menu to use for application-specific dock menu items.
  50    */
  51   attribute nsIStandaloneNativeMenu dockMenu;
  52
  53   /**
  54    * Activate the application. This should be used by an application to
  55    * activate itself when a dock menu is selected as selection of a dock menu
  56    * item does not automatically activate the application.
  57    *
  58    * @param aIgnoreOtherApplications If false, the application is activated
  59    *        only if no other application is currently active. If true, the
  60    *        application activates regardless.
  61    */
  62   void activateApplication(in boolean aIgnoreOtherApplications);
  63 };