widget/nsITaskbarOverlayIconController.idl

   1 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  *
   3  * ***** BEGIN LICENSE BLOCK *****
   4  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   5  *
   6  * The contents of this file are subject to the Mozilla Public License Version
   7  * 1.1 (the "License"); you may not use this file except in compliance with
   8  * the License. You may obtain a copy of the License at
   9  * http://www.mozilla.org/MPL/
  10  *
  11  * Software distributed under the License is distributed on an "AS IS" basis,
  12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13  * for the specific language governing rights and limitations under the
  14  * License.
  15  *
  16  * The Original Code is mozilla.org code.
  17  *
  18  * The Initial Developer of the Original Code is
  19  * Tim Miller <mille449@gmail.com>.
  20  * Portions created by the Initial Developer are Copyright (C) 2011
  21  * the Initial Developer. All Rights Reserved.
  22  *
  23  * Contributor(s):
  24  *   Siddharth Agarwal <sid.bugzilla@gmail.com>
  25  *
  26  * Alternatively, the contents of this file may be used under the terms of
  27  * either the GNU General Public License Version 2 or later (the "GPL"), or
  28  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29  * in which case the provisions of the GPL or the LGPL are applicable instead
  30  * of those above. If you wish to allow use of your version of this file only
  31  * under the terms of either the GPL or the LGPL, and not to allow others to
  32  * use your version of this file under the terms of the MPL, indicate your
  33  * decision by deleting the provisions above and replace them with the notice
  34  * and other provisions required by the GPL or the LGPL. If you do not delete
  35  * the provisions above, a recipient may use your version of this file under
  36  * the terms of any one of the MPL, the GPL or the LGPL.
  37  *
  38  * ***** END LICENSE BLOCK ***** */
  39
  40 #include "nsISupports.idl"
  41
  42 interface imgIContainer;
  43
  44 /**
  45  * Starting in Windows 7, applications can display an overlay on the icon in
  46  * the taskbar. This class wraps around the native functionality to do this.
  47  */
  48 [scriptable, uuid(b1858889-a698-428a-a14b-b5d60cff6de2)]
  49 interface nsITaskbarOverlayIconController : nsISupports
  50 {
  51   /**
  52    * Sets the overlay icon and its corresponding alt text.
  53    *
  54    * @param statusIcon The handle to the overlay icon. The icon will be scaled
  55    *                   to the small icon size (16x16 at 96 dpi). Can be null, in
  56    *                   which case if the taskbar button represents a single window
  57    *                   the icon is removed.
  58    * @param statusDescription The alt text version of the information
  59    *                          conveyed by the overlay, for accessibility
  60    *                          purposes.
  61    *
  62    * @note The behavior for window groups is managed by Windows.
  63    * - If an overlay icon is set for any window in a window group and another
  64    *   overlay icon is already applied to the corresponding taskbar button, that
  65    *   existing overlay is replaced.
  66    * - If null is passed in to replace the overlay currently being displayed,
  67    *   and if a previous overlay set for a different window in the group is
  68    *   still available, then that previous overlay is displayed.
  69    */
  70   void setOverlayIcon(in imgIContainer statusIcon,
  71                       in AString statusDescription);
  72 };