Interface nsITaskbarTabPreviewType

nsITaskbarTabPreview

This interface controls tab preview-specific behavior. Creating an nsITaskbarTabPreview for a window will hide that window's nsITaskbarWindowPreview in the taskbar - the native API performs this unconditionally. When there are no more tab previews for a window, the nsITaskbarWindowPreview will automatically become visible again.

An application may have as many tab previews per window as memory allows.

Hierarchy

Properties

active controller icon title tooltip visible

Methods

AddRef EnsureRegistration GetHWND QueryInterface Release invalidate move

Properties

active

active: boolean

Gets/sets whether or not the preview is marked active (selected) in the taskbar.

controller

controller: nsITaskbarPreviewController

The controller for this preview. A controller is required to provide the behavior and appearance of the taskbar previews. It is responsible for determining the size and contents of the preview, which buttons are displayed and how the application responds to user actions on the preview.

Neither preview makes full use of the controller. See the documentation for nsITaskbarWindowPreview and nsITaskbarTabPreview for details on which controller methods are used.

The controller is not allowed to be null.

See

nsITaskbarPreviewController

icon

icon: imgIContainer

The icon displayed next to the title in the preview

Default: null

title

title: string

The title displayed above the thumbnail

Default: an empty string

tooltip

tooltip: string

The tooltip displayed above the preview when the user hovers over it

Default: an empty string

visible

visible: boolean

Whether or not the preview is visible.

Changing this option is expensive for tab previews since toggling this option will destroy/create the proxy window and its registration with the taskbar. If any step of that fails, an exception will be thrown.

For window previews, this operation is very cheap.

Default: false

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

EnsureRegistration

  • Used internally to ensure that the taskbar knows about this preview. If a preview is not registered, then the API call to set its sibling (via move) will silently fail.

    This method is only invoked when it is safe to make taskbar API calls.

    Returns void

GetHWND

  • Used internally to grab the handle to the proxy window.

    Returns nativeWindow

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

invalidate

  • Invalidates the taskbar's cached image of this preview, forcing a redraw if necessary

    Returns void

move

  • Rearranges the preview relative to another tab preview from the same window

    Parameters

    • aNext: nsITaskbarTabPreview

      The preview to the right of this one. A value of null indicates that the preview is the rightmost one.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc