Interface nsITouchBarHelperType

Back-to-frontend communication for the Touch Bar

Hierarchy

Properties

activeTitle activeUrl allItems document isUrlbarFocused

Methods

AddRef QueryInterface Release getTouchBarInput insertRestrictionInUrlbar toggleFocusUrlbar unfocusUrlbar

Properties

Readonly activeTitle

activeTitle: string

Return the active browser's page title.

Readonly activeUrl

activeUrl: string

Returns the active browser's URL.

allItems

allItems: nsIArray

Returns all available Touch Bar Inputs in an nsIArray of nsITouchBarInput objects.

Readonly document

document: Document

The context in which this nsITouchBarHelper exists. Required to create an imgLoader to load our SVG icons.

Readonly isUrlbarFocused

isUrlbarFocused: boolean

Return true if the Urlbar has focus.

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

getTouchBarInput

  • Returns the requested TouchBarInput. Exposed for testing.

    Parameters

    • aInputName: string

    Returns nsITouchBarInput

insertRestrictionInUrlbar

  • Inserts a search restriction string in the Urlbar. Exposed for testing.

    Parameters

    • aToken: string

    Returns void

toggleFocusUrlbar

  • Toggles Urlbar focus.

    Returns void

unfocusUrlbar

  • Unfocuses the Urlbar.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc