Interface nsITaskbarOverlayIconControllerType

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.

Hierarchy

Methods

AddRef QueryInterface Release setOverlayIcon

Methods

AddRef

  • Increases the reference count for this interface. The associated instance will not be deleted unless the reference count is returned to zero.

    Returns

    The resulting reference count.

    Returns number

QueryInterface

  • Parameters

    • aIID: object
    • Optional aInstancePtr: object

    Returns any

  • A run time mechanism for interface discovery.

    Returns

    NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.

    aInstancePtr must not be null.

    Parameters

    • aIID: object

      [in] A requested interface IID

    • aInstancePtr: object

      [out] A pointer to an interface pointer to receive the result.

    Returns void

Release

  • Decreases the reference count for this interface. Generally, if the reference count returns to zero, the associated instance is deleted.

    Returns

    The resulting reference count.

    Returns number

setOverlayIcon

  • Sets the overlay icon and its corresponding alt text.

    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.

    Parameters

    • statusIcon: imgIContainer

      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.

    • statusDescription: string

      The alt text version of the information conveyed by the overlay, for accessibility purposes.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc