mirror of
https://github.com/rn10950/RetroZilla.git
synced 2024-11-12 19:00:11 +01:00
215 lines
7.3 KiB
Plaintext
215 lines
7.3 KiB
Plaintext
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
/* ***** 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 mozilla.org code.
|
|
*
|
|
* The Initial Developer of the Original Code is
|
|
* Netscape Communications Corporation.
|
|
* Portions created by the Initial Developer are Copyright (C) 1998
|
|
* the Initial Developer. All Rights Reserved.
|
|
*
|
|
* Contributor(s):
|
|
* Blake Ross <blaker@netscape.com>
|
|
* Ben Goodger <ben@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 ***** */
|
|
|
|
// Keeps track of ongoing downloads, in the form of nsIDownload's.
|
|
|
|
#include "nsISupports.idl"
|
|
|
|
interface nsIDOMWindow;
|
|
interface nsIURI;
|
|
interface nsILocalFile;
|
|
interface nsIDownload;
|
|
interface nsICancelable;
|
|
interface nsIMIMEInfo;
|
|
interface nsIRDFDataSource;
|
|
interface nsIDownloadProgressListener;
|
|
interface nsISupportsArray;
|
|
|
|
[scriptable, uuid(1f280341-30f4-4009-bb0d-a78f2936d1fb)]
|
|
interface nsIDownloadManager : nsISupports {
|
|
// Download States
|
|
const short DOWNLOAD_NOTSTARTED = -1;
|
|
const short DOWNLOAD_DOWNLOADING = 0;
|
|
const short DOWNLOAD_FINISHED = 1;
|
|
const short DOWNLOAD_FAILED = 2;
|
|
const short DOWNLOAD_CANCELED = 3;
|
|
const short DOWNLOAD_PAUSED = 4;
|
|
|
|
const short DOWNLOAD_TYPE_DOWNLOAD = 0;
|
|
|
|
// Methods called by clients to carry out various managing functions
|
|
|
|
/**
|
|
* Creates an nsIDownload and adds it to be managed by the download manager.
|
|
*
|
|
* @param aSource The source URI of the transfer. Must not be null.
|
|
*
|
|
* @param aTarget The target URI of the transfer. Must not be null.
|
|
*
|
|
* @param aDisplayName The user-readable description of the transfer.
|
|
* Can be empty.
|
|
*
|
|
* @param aMIMEInfo The MIME info associated with the target,
|
|
* including MIME type and helper app when appropriate.
|
|
* This parameter is optional.
|
|
*
|
|
* @param startTime Time when the download started
|
|
*
|
|
* @param aTempFile The location of a temporary file; i.e. a file in which
|
|
* the received data will be stored, but which is not
|
|
* equal to the target file. (will be moved to the real
|
|
* target by the caller, when the download is finished)
|
|
* May be null.
|
|
*
|
|
* @param aCancelable An object that can be used to abort the download.
|
|
* Must not be null.
|
|
*
|
|
* @return The newly created download item with the passed-in properties.
|
|
*/
|
|
nsIDownload addDownload(in short aDownloadType,
|
|
in nsIURI aSource,
|
|
in nsIURI aTarget,
|
|
in AString aDisplayName,
|
|
in AString aIconURL,
|
|
in nsIMIMEInfo aMIMEInfo,
|
|
in PRTime aStartTime,
|
|
in nsILocalFile aTempFile,
|
|
in nsICancelable aCancelable);
|
|
|
|
/**
|
|
* Retrieves an in-progress download managed by the download manager.
|
|
*
|
|
* @param aPersistentDescriptor The unique identifier used to describe a
|
|
* a download, and an attribute of nsILocalFile.
|
|
* On Windows and Linux, this is just the path
|
|
* of the target, but on Mac this is guaranteed
|
|
* to be unique.
|
|
*
|
|
* @return The download with the specified persistent descriptor.
|
|
*/
|
|
nsIDownload getDownload(in wstring aPersistentDescriptor);
|
|
|
|
/**
|
|
* Cancels the download with the specified persistent descriptor if it's
|
|
* currently in progress. This calls cancel(NS_BINDING_ABORTED) on the
|
|
* nsICancelable provided for the download.
|
|
*
|
|
* @param aPersistentDescriptor The persistent descriptor of the download to
|
|
* be cancelled.
|
|
*/
|
|
void cancelDownload(in wstring aPersistentDescriptor);
|
|
|
|
/**
|
|
* Removes the download with the specified persistent descriptor if it's not
|
|
* currently in progress. Whereas cancelDownload simply cancels the transfer
|
|
* but retains information about it, removeDownload removes all knowledge of it.
|
|
*
|
|
* @param aPersistentDescriptor The persistent descriptor of the download to
|
|
* be removed.
|
|
*/
|
|
void removeDownload(in wstring aPersistentDescriptor);
|
|
|
|
/**
|
|
* Pause the specified download.
|
|
*/
|
|
void pauseDownload(in wstring aPersistentDescriptor);
|
|
|
|
/**
|
|
* Resume the specified download.
|
|
*/
|
|
void resumeDownload(in wstring aPersistentDescriptor);
|
|
|
|
// Front end and Front end update methods.
|
|
|
|
/**
|
|
* Opens the Download Manager front end.
|
|
*
|
|
* @param aParent The parent, or opener, of the front end (optional).
|
|
* @param aDownload A download to pass to the manager widnow. Useful if,
|
|
* for example, you want the window to select a certain
|
|
* download (optional).
|
|
*/
|
|
|
|
void open(in nsIDOMWindow aParent, in wstring aPersistentDescriptor);
|
|
|
|
/**
|
|
* The Download Manager's progress listener.
|
|
*/
|
|
attribute nsIDownloadProgressListener listener;
|
|
|
|
/**
|
|
* Indicate that a batch update (e.g. mass removal) is about to start.
|
|
*/
|
|
|
|
void startBatchUpdate();
|
|
|
|
/**
|
|
* Indicate that a batch update is ending.
|
|
*/
|
|
|
|
void endBatchUpdate();
|
|
|
|
// Downloads list book-keeping
|
|
|
|
/**
|
|
* Whether or not there are downloads that can be cleaned up (removed)
|
|
* i.e. downloads that have completed, have failed or have been canceled.
|
|
*/
|
|
readonly attribute boolean canCleanUp;
|
|
|
|
/**
|
|
* Removes completed, failed, and canceled downloads from the list.
|
|
*/
|
|
void cleanUp();
|
|
|
|
/**
|
|
* The number of files currently being downloaded.
|
|
*/
|
|
readonly attribute long activeDownloadCount;
|
|
|
|
/**
|
|
* An enumeration of active downloads.
|
|
*/
|
|
readonly attribute nsISupportsArray activeDownloads;
|
|
|
|
/**
|
|
* Update the download datasource.
|
|
*/
|
|
void saveState();
|
|
|
|
/**
|
|
* Flush the download datasource to disk.
|
|
*/
|
|
void flush();
|
|
|
|
readonly attribute nsIRDFDataSource datasource;
|
|
};
|
|
|
|
|