Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsIXPIProgressDialog Interface Reference

Interface to display XPInstall download and install status. More...

import "nsIXPIProgressDialog.idl";

Inheritance diagram for nsIXPIProgressDialog:
Inheritance graph
[legend]
Collaboration diagram for nsIXPIProgressDialog:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void onStateChange (in unsigned long index, in short state, in long value)
 basic info to control the install progress dialog.
void onProgress (in unsigned long index, in unsigned long long value, in unsigned long long maxValue)
 download progress

Public Attributes

const short DOWNLOAD_START = 0
 state values for onStateChange
const short DOWNLOAD_DONE = 1
const short INSTALL_START = 2
const short INSTALL_DONE = 3
const short DIALOG_CLOSE = 4

Detailed Description

Interface to display XPInstall download and install status.

UNDER_REVIEW

Definition at line 46 of file nsIXPIProgressDialog.idl.


Member Function Documentation

void nsIXPIProgressDialog::onProgress ( in unsigned long  index,
in unsigned long long  value,
in unsigned long long  maxValue 
)

download progress

Parameters:
indexthe package to which this refers
valuenumber of bytes downloaded
maxValuethe total size
void nsIXPIProgressDialog::onStateChange ( in unsigned long  index,
in short  state,
in long  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

Parameters:
indexthe package this message is about of those passed into openProgressDialog. ignored when state==DIALOG_CLOSE
statethe kind of message
valuefinal result when state==INSTALL_DONE, otherwise ignored

Member Data Documentation

Definition at line 55 of file nsIXPIProgressDialog.idl.

Definition at line 52 of file nsIXPIProgressDialog.idl.

state values for onStateChange

Definition at line 51 of file nsIXPIProgressDialog.idl.

Definition at line 54 of file nsIXPIProgressDialog.idl.

Definition at line 53 of file nsIXPIProgressDialog.idl.


The documentation for this interface was generated from the following file: