mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-11-05 08:35:26 +00:00
83 lines
3.4 KiB
Plaintext
83 lines
3.4 KiB
Plaintext
/* ***** BEGIN LICENSE BLOCK *****
|
|
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
|
|
*
|
|
* The contents of this file are subject to the Mozilla Public License Version
|
|
* 1.1 (the "License"); you may not use this file except in compliance with
|
|
* the License. You may obtain a copy of the License at
|
|
* http://www.mozilla.org/MPL/
|
|
*
|
|
* Software distributed under the License is distributed on an "AS IS" basis,
|
|
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
|
|
* for the specific language governing rights and limitations under the
|
|
* License.
|
|
*
|
|
* The Original Code is the Mozilla XPInstall.
|
|
*
|
|
* The Initial Developer of the Original Code is
|
|
* Netscape Communications Corporation.
|
|
* Portions created by the Initial Developer are Copyright (C) 2002
|
|
* the Initial Developer. All Rights Reserved.
|
|
*
|
|
* Contributor(s):
|
|
* Daniel Veditz <dveditz@netscape.com>
|
|
*
|
|
* Alternatively, the contents of this file may be used under the terms of
|
|
* either the GNU General Public License Version 2 or later (the "GPL"), or
|
|
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
|
|
* in which case the provisions of the GPL or the LGPL are applicable instead
|
|
* of those above. If you wish to allow use of your version of this file only
|
|
* under the terms of either the GPL or the LGPL, and not to allow others to
|
|
* use your version of this file under the terms of the MPL, indicate your
|
|
* decision by deleting the provisions above and replace them with the notice
|
|
* and other provisions required by the GPL or the LGPL. If you do not delete
|
|
* the provisions above, a recipient may use your version of this file under
|
|
* the terms of any one of the MPL, the GPL or the LGPL.
|
|
*
|
|
* ***** END LICENSE BLOCK ***** */
|
|
|
|
#include "nsISupports.idl"
|
|
|
|
/**
|
|
* Interface to display XPInstall download and install status.
|
|
*
|
|
* @status UNDER_REVIEW
|
|
*/
|
|
[scriptable, uuid(ce8f744e-d5a5-41b3-911f-0fee3008b64e)]
|
|
interface nsIXPIProgressDialog : nsISupports
|
|
{
|
|
/**
|
|
* state values for onStateChange
|
|
*/
|
|
const short DOWNLOAD_START = 0;
|
|
const short DOWNLOAD_DONE = 1;
|
|
const short INSTALL_START = 2;
|
|
const short INSTALL_DONE = 3;
|
|
const short DIALOG_CLOSE = 4;
|
|
|
|
/**
|
|
* 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
|
|
*
|
|
* @param index the package this message is about of those passed into
|
|
* openProgressDialog. ignored when state==DIALOG_CLOSE
|
|
* @param state the kind of message
|
|
* @param value final result when state==INSTALL_DONE, otherwise ignored
|
|
*/
|
|
void onStateChange( in unsigned long index, in short state, in long value );
|
|
|
|
/**
|
|
* download progress
|
|
*
|
|
* @param index the package to which this refers
|
|
* @param value number of bytes downloaded
|
|
* @param maxValue the total size
|
|
*/
|
|
void onProgress( in unsigned long index, in unsigned long long value, in unsigned long long maxValue );
|
|
};
|