Interface nsIMacFinderProgressType

Hierarchy

Methods

AddRef QueryInterface Release end init updateProgress

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

end

  • End displaying the progressbar on the file

    Returns void

init

  • Initialize and display a new Finder progressbar on the given file

    Parameters

    • path: string

      The path of the file

    • canceledCallback: nsIMacFinderProgressCanceledCallback

      Callback which is called when cancelation is requested

    Returns void

updateProgress

  • Update the current and total progess. If currentProgress and totalProgress are both 0, the progress is indetermined

    Parameters

    • currentProgress: number

      The current progress

    • totalProgress: number

      The total progress

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc