Interface nsIWinTaskbarType

nsIWinTaskbar

This interface represents a service which exposes the APIs provided by the Windows taskbar to applications.

Starting in Windows 7, applications gain some control over their appearance in the taskbar. By default, there is one taskbar preview per top level window (excluding popups). This preview is represented by an nsITaskbarWindowPreview object.

An application can register its own "tab" previews. Such previews will hide the corresponding nsITaskbarWindowPreview automatically (though this is not reflected in the visible attribute of the nsITaskbarWindowPreview). These tab previews do not have to correspond to tabs in the application - they can vary in size, shape and location. They do not even need to be actual GUI elements on the window. Unlike window previews, tab previews require most of the functionality of the nsITaskbarPreviewController to be implemented.

Applications can also show progress on their taskbar icon. This does not interact with the taskbar previews except if the nsITaskbarWindowPreview is made invisible in which case the progress is naturally not shown on that window.

When taskbar icons are combined as is the default in Windows 7, the progress for those windows is also combined as defined here: http://msdn.microsoft.com/en-us/library/dd391697%28VS.85%29.aspx

Applications may also define custom taskbar jump lists on application shortcuts. See nsIJumpListBuilder for more information.

Hierarchy

Properties

available defaultGroupId defaultPrivateGroupId

Methods

AddRef QueryInterface Release createJumpListBuilder createTaskbarTabPreview getOverlayIconController getTaskbarProgress getTaskbarWindowPreview prepareFullScreen setGroupIdForWindow

Properties

Readonly available

available: boolean

Returns true if the operating system supports Win7+ taskbar features. This property acts as a replacement for in-place os version checking.

Readonly defaultGroupId

defaultGroupId: string

Returns the default application user model identity the application registers with the system. This id is used by the taskbar in grouping windows and in associating pinned shortcuts with running instances and jump lists.

Readonly defaultPrivateGroupId

defaultPrivateGroupId: string

Same as above, but a different value so that Private Browsing windows can be separated in the Taskbar.

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

createJumpListBuilder

  • Taskbar and start menu jump list management

    Retrieve a taskbar jump list builder

    Fails if a jump list build operation has already been initiated, developers should make use of a single instance of nsIJumpListBuilder for building lists within an application.

    Throw

    NS_ERROR_ALREADY_INITIALIZED if an nsIJumpListBuilder instance is currently building a list.

    Parameters

    • aPrivateBrowsing: boolean

    Returns nsIJumpListBuilder

createTaskbarTabPreview

  • Taskbar window and tab preview management

    Creates a taskbar preview. The docshell should be a toplevel docshell and is used to find the toplevel window. See the documentation for nsITaskbarTabPreview for more information.

    Parameters

    • shell: nsIDocShell
    • controller: nsITaskbarPreviewController

    Returns nsITaskbarTabPreview

getOverlayIconController

  • Taskbar icon overlay

    Gets the taskbar icon overlay controller for a window. The docshell is used to find the toplevel window. See the documentation in nsITaskbarOverlayIconController for more details.

    Parameters

    • shell: nsIDocShell

    Returns nsITaskbarOverlayIconController

getTaskbarProgress

  • Taskbar icon progress indicator

    Gets the taskbar progress for a window. The docshell is used to find the toplevel window. See the documentation for nsITaskbarProgress for more information.

    Parameters

    • shell: nsIDocShell

    Returns nsITaskbarProgress

getTaskbarWindowPreview

  • Gets the taskbar preview for a window. The docshell is used to find the toplevel window. See the documentation for nsITaskbarTabPreview for more information.

    Note: to implement custom drawing or buttons, a controller is required.

    Parameters

    • shell: nsIDocShell

    Returns nsITaskbarWindowPreview

prepareFullScreen

  • Notify the taskbar that a window identified by its HWND is about to enter full screen mode.

    A Windows autohide taskbar will not behave correctly in all cases if it is not notified when full screen operations start and end.

    Throw

    NS_ERROR_INVALID_ARG if the window is not a valid top level window

    Throw

    NS_ERROR_UNEXPECTED for general failures.

    Throw

    NS_ERROR_NOT_AVAILABLE if the taskbar cannot be obtained.

    Parameters

    • aHWND: voidPtr
    • aFullScreen: boolean

    Returns void

setGroupIdForWindow

  • Application window taskbar group settings

    Set the grouping id for a window.

    The runtime sets a default, global grouping id for all windows on startup. setGroupIdForWindow allows individual windows to be grouped independently on the taskbar. Ids should be unique to the app and window to insure conflicts with other pinned applications do no arise.

    The default group id is based on application.ini vendor, application, and version values, with a format of 'vendor.app.version'. The default can be retrieved via defaultGroupId.

    Note, when a window changes taskbar window stacks, it is placed at the bottom of the new stack.

    Throw

    NS_ERROR_INVALID_ARG if the window is not a valid top level window associated with a widget.

    Throw

    NS_ERROR_FAILURE if the property on the window could not be set.

    Throw

    NS_ERROR_UNEXPECTED for general failures.

    Parameters

    • aParent: mozIDOMWindow
    • aIdentifier: string

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc