WARNING: Most of this content (with the exception of the Mozilla 1.9 XPCOM reference) is very old, and can be expected to be out of date and possibly obsolete. For better XUL documentation, please visit the XUL hub at the Mozilla Developer Center.

nsIXPIProgressDialog

IID:ce8f744e-d5a5-41b3-911f-0fee3008b64e
Inherits From:nsISupports
Status:UNDER_REVIEW

Interface to display XPInstall download and install status.

Constants

State values for onStateChange
PRInt16 DOWNLOAD_START = 0
PRInt16 DOWNLOAD_DONE = 1
PRInt16 INSTALL_START = 2
PRInt16 INSTALL_DONE = 3
PRInt16 DIALOG_CLOSE = 4

Methods

void onProgress ( PRUint32 index , PRUint64 value , PRUint64 maxValue ) void onStateChange ( PRUint32 index , PRInt16 state , PRInt32 value )

void onProgress ( PRUint32 index , PRUint64 value , PRUint64 maxValue )

Download progress

Arguments:
index: the package to which this refers
value: number of bytes downloaded
maxValue: the total size

void onStateChange ( PRUint32 index , PRInt16 state , PRInt32 value )

Basic info to control the install progress dialog. The dialog can go away any time after it has received the DIALOG_CLOSE state message but needs to accept messages until that time even if it is not visible.

Normally for each install package the dialog will receive the download and install messages in START/DONE pairs, but in the case of a download error the dialog will be sent only the DOWNLOAD_START followed by an INSTALL_DONE message with the value nsInstall::DOWNLOAD_ERROR

Arguments:
index: the package this message is about of those passed into openProgressDialog. ignored when state==DIALOG_CLOSE
state: the kind of message
value: final result when state==INSTALL_DONE, otherwise ignored

References

This interface is passed as an argument to the following methods:

nsIXPInstallManager.initManagerFromChrome, nsIXPInstallManager.initManagerWithHashes

Reference documentation is generated from Mozilla's source.