widget/public/nsIMacDockSupport.idl
author Florian Quèze <florian@queze.net>
Mon, 05 Dec 2011 10:57:45 +0100
changeset 83083 f4eee92684cf8719ce5d19ef29b74f58619ed357
parent 38964 290ebc6801addd3f854711f91d610f88f508a2b3
permissions -rw-r--r--
Bug 697546 - Add a scriptable way to set a dock badge text. r=smichaud,josh

/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is Mac Dock Support
 *
 * The Initial Developer of the Original Code is
 * Thomas K. Dyas <tom.dyas@gmail.com>.
 * Portions created by the Initial Developer are Copyright (C) 2009
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#include "nsISupports.idl"

interface nsIStandaloneNativeMenu;

/**
 * Allow applications to interface with the Mac OS X Dock.
 */

[scriptable, uuid(8BE66B0C-5F71-4B74-98CF-6C2551B999B1)]
interface nsIMacDockSupport : nsISupports
{
  /**
   * Menu to use for application-specific dock menu items.
   */
  attribute nsIStandaloneNativeMenu dockMenu;

  /**
   * Activate the application. This should be used by an application to
   * activate itself when a dock menu is selected as selection of a dock menu
   * item does not automatically activate the application.
   *
   * @param aIgnoreOtherApplications If false, the application is activated
   *        only if no other application is currently active. If true, the
   *        application activates regardless. 
   */
  void activateApplication(in boolean aIgnoreOtherApplications);

  /**
   * Text used to badge the dock tile.
   */
  attribute AString badgeText;
};