widget/nsITaskbarOverlayIconController.idl@b8a032363ba2 (annotated)
widget/nsITaskbarOverlayIconController.idl
Thu, 22 Jan 2015 13:21:57 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Thu, 22 Jan 2015 13:21:57 +0100
- branch
- TOR_BUG_9701
- changeset 15
- b8a032363ba2
- permissions
- -rw-r--r--
Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6
| michael@0 | 1 | /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- |
| michael@0 | 2 | * |
| michael@0 | 3 | * This Source Code Form is subject to the terms of the Mozilla Public |
| michael@0 | 4 | * License, v. 2.0. If a copy of the MPL was not distributed with this |
| michael@0 | 5 | * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ |
| michael@0 | 6 | |
| michael@0 | 7 | #include "nsISupports.idl" |
| michael@0 | 8 | |
| michael@0 | 9 | interface imgIContainer; |
| michael@0 | 10 | |
| michael@0 | 11 | /** |
| michael@0 | 12 | * Starting in Windows 7, applications can display an overlay on the icon in |
| michael@0 | 13 | * the taskbar. This class wraps around the native functionality to do this. |
| michael@0 | 14 | */ |
| michael@0 | 15 | [scriptable, uuid(b1858889-a698-428a-a14b-b5d60cff6de2)] |
| michael@0 | 16 | interface nsITaskbarOverlayIconController : nsISupports |
| michael@0 | 17 | { |
| michael@0 | 18 | /** |
| michael@0 | 19 | * Sets the overlay icon and its corresponding alt text. |
| michael@0 | 20 | * |
| michael@0 | 21 | * @param statusIcon The handle to the overlay icon. The icon will be scaled |
| michael@0 | 22 | * to the small icon size (16x16 at 96 dpi). Can be null, in |
| michael@0 | 23 | * which case if the taskbar button represents a single window |
| michael@0 | 24 | * the icon is removed. |
| michael@0 | 25 | * @param statusDescription The alt text version of the information |
| michael@0 | 26 | * conveyed by the overlay, for accessibility |
| michael@0 | 27 | * purposes. |
| michael@0 | 28 | * |
| michael@0 | 29 | * @note The behavior for window groups is managed by Windows. |
| michael@0 | 30 | * - If an overlay icon is set for any window in a window group and another |
| michael@0 | 31 | * overlay icon is already applied to the corresponding taskbar button, that |
| michael@0 | 32 | * existing overlay is replaced. |
| michael@0 | 33 | * - If null is passed in to replace the overlay currently being displayed, |
| michael@0 | 34 | * and if a previous overlay set for a different window in the group is |
| michael@0 | 35 | * still available, then that previous overlay is displayed. |
| michael@0 | 36 | */ |
| michael@0 | 37 | void setOverlayIcon(in imgIContainer statusIcon, |
| michael@0 | 38 | in AString statusDescription); |
| michael@0 | 39 | }; |
