diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 19:33:14 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 19:33:14 +0000 |
commit | 36d22d82aa202bb199967e9512281e9a53db42c9 (patch) | |
tree | 105e8c98ddea1c1e4784a60a5a6410fa416be2de /widget/nsITaskbarOverlayIconController.idl | |
parent | Initial commit. (diff) | |
download | firefox-esr-36d22d82aa202bb199967e9512281e9a53db42c9.tar.xz firefox-esr-36d22d82aa202bb199967e9512281e9a53db42c9.zip |
Adding upstream version 115.7.0esr.upstream/115.7.0esrupstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r-- | widget/nsITaskbarOverlayIconController.idl | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/widget/nsITaskbarOverlayIconController.idl b/widget/nsITaskbarOverlayIconController.idl new file mode 100644 index 0000000000..f11cf16ed0 --- /dev/null +++ b/widget/nsITaskbarOverlayIconController.idl @@ -0,0 +1,39 @@ +/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ + +#include "nsISupports.idl" + +interface imgIContainer; + +/** + * Starting in Windows 7, applications can display an overlay on the icon in + * the taskbar. This class wraps around the native functionality to do this. + */ +[scriptable, uuid(b1858889-a698-428a-a14b-b5d60cff6de2)] +interface nsITaskbarOverlayIconController : nsISupports +{ + /** + * Sets the overlay icon and its corresponding alt text. + * + * @param statusIcon The handle to the overlay icon. The icon will be scaled + * to the small icon size (16x16 at 96 dpi). Can be null, in + * which case if the taskbar button represents a single window + * the icon is removed. + * @param statusDescription The alt text version of the information + * conveyed by the overlay, for accessibility + * purposes. + * + * @note The behavior for window groups is managed by Windows. + * - If an overlay icon is set for any window in a window group and another + * overlay icon is already applied to the corresponding taskbar button, that + * existing overlay is replaced. + * - If null is passed in to replace the overlay currently being displayed, + * and if a previous overlay set for a different window in the group is + * still available, then that previous overlay is displayed. + */ + void setOverlayIcon(in imgIContainer statusIcon, + in AString statusDescription); +}; |