Source code

Revision control

Other Tools

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