1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/widget/nsITaskbarOverlayIconController.idl Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,39 @@
1.4 +/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
1.5 + *
1.6 + * This Source Code Form is subject to the terms of the Mozilla Public
1.7 + * License, v. 2.0. If a copy of the MPL was not distributed with this
1.8 + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
1.9 +
1.10 +#include "nsISupports.idl"
1.11 +
1.12 +interface imgIContainer;
1.13 +
1.14 +/**
1.15 + * Starting in Windows 7, applications can display an overlay on the icon in
1.16 + * the taskbar. This class wraps around the native functionality to do this.
1.17 + */
1.18 +[scriptable, uuid(b1858889-a698-428a-a14b-b5d60cff6de2)]
1.19 +interface nsITaskbarOverlayIconController : nsISupports
1.20 +{
1.21 + /**
1.22 + * Sets the overlay icon and its corresponding alt text.
1.23 + *
1.24 + * @param statusIcon The handle to the overlay icon. The icon will be scaled
1.25 + * to the small icon size (16x16 at 96 dpi). Can be null, in
1.26 + * which case if the taskbar button represents a single window
1.27 + * the icon is removed.
1.28 + * @param statusDescription The alt text version of the information
1.29 + * conveyed by the overlay, for accessibility
1.30 + * purposes.
1.31 + *
1.32 + * @note The behavior for window groups is managed by Windows.
1.33 + * - If an overlay icon is set for any window in a window group and another
1.34 + * overlay icon is already applied to the corresponding taskbar button, that
1.35 + * existing overlay is replaced.
1.36 + * - If null is passed in to replace the overlay currently being displayed,
1.37 + * and if a previous overlay set for a different window in the group is
1.38 + * still available, then that previous overlay is displayed.
1.39 + */
1.40 + void setOverlayIcon(in imgIContainer statusIcon,
1.41 + in AString statusDescription);
1.42 +};
