Interface nsIJumpListShortcutType

A generic application shortcut with command line support.

Hierarchy

Properties

app faviconPageUri iconIndex type

Methods

AddRef QueryInterface Release equals

Properties

app

app: nsILocalHandlerApp

Set or get the handler app for this shortcut item.

The handler app may also be used along with iconIndex to generate an icon for the jump list item.

Throw

NS_ERROR_FILE_NOT_FOUND if the handler app can not be found on the system.

See

faviconPageUri

faviconPageUri

faviconPageUri: nsIURI

Set or get the URI of a page whose favicon may be used as the icon.

When a jump list build occurs, the favicon to be used for the item is obtained using the following steps:

  • First, attempt to use the asynchronously retrieved and scaled favicon associated with the faviconPageUri.
  • If faviconPageUri is null, or if retrieving the favicon fails, fall back to using the handler executable and iconIndex.

iconIndex

iconIndex: number

Set or get the icon displayed with the jump list item.

Indicates the resource index of the icon contained within the handler executable which may be used as the jump list icon.

See

faviconPageUri

Readonly type

type: number

Retrieves the jump list item type.

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

equals

  • Compare this item to another.

    Compares the type and other properties specific to this item's type.

    separator: type link: type, uri, title shortcut: type, handler app

    Parameters

    • item: nsIJumpListItem

    Returns boolean

Settings

Member Visibility

Theme

Generated using TypeDoc