Interface nsIGtkTaskbarProgressType

Allow the TaskbarProgress instance to set a new target window.

Hierarchy

Methods

AddRef QueryInterface Release setPrimaryWindow setProgressState

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

setPrimaryWindow

  • Sets the window that is considered primary for purposes of setting the XApp progress property.

    Parameters

    • aWindow: mozIDOMWindowProxy

    Returns void

setProgressState

  • Sets the taskbar progress state and value for this window. The currentValue and maxValue parameters are optional and should be supplied when |state| is one of STATE_NORMAL, STATE_ERROR or STATE_PAUSED.

    Throws

    NS_ERROR_INVALID_ARG if state is STATE_NO_PROGRESS or STATE_INDETERMINATE, and either currentValue or maxValue is not 0.

    Throws

    NS_ERROR_ILLEGAL_VALUE if currentValue is greater than maxValue.

    Parameters

    • state: nsTaskbarProgressState
    • currentValue: number
    • maxValue: number

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc