mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-12-28 11:28:38 +00:00
108 lines
4.4 KiB
Plaintext
108 lines
4.4 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>
|
|
*
|
|
* Alternatively, the contents of this file may be used under the terms of
|
|
* either of 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 "nsIWebProgressListener2.idl"
|
|
|
|
interface nsIURI;
|
|
interface nsICancelable;
|
|
interface nsIMIMEInfo;
|
|
interface nsILocalFile;
|
|
|
|
[scriptable, uuid(3a982955-dc44-422e-8734-8462bf8d2121)]
|
|
interface nsITransfer : nsIWebProgressListener2 {
|
|
|
|
/**
|
|
* Initializes the transfer with certain properties. This function must
|
|
* be called prior to accessing any properties on this interface.
|
|
*
|
|
* @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 (ie, when the first
|
|
* response from the server was received)
|
|
* XXX presumably wbp and exthandler do this differently
|
|
*
|
|
* @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.
|
|
* Implementations are expected to hold a strong
|
|
* reference to this object until the download is
|
|
* finished, at which point they should release the
|
|
* reference.
|
|
*/
|
|
void init(in nsIURI aSource,
|
|
in nsIURI aTarget,
|
|
in AString aDisplayName,
|
|
in nsIMIMEInfo aMIMEInfo,
|
|
in PRTime startTime,
|
|
in nsILocalFile aTempFile,
|
|
in nsICancelable aCancelable);
|
|
};
|
|
|
|
%{C++
|
|
/**
|
|
* A component with this contract ID will be created each time a download is
|
|
* started, and nsITransfer::Init will be called on it and an observer will be set.
|
|
*
|
|
* Notifications of the download progress will happen via
|
|
* nsIWebProgressListener/nsIWebProgressListener2.
|
|
*
|
|
* INTERFACES THAT MUST BE IMPLEMENTED:
|
|
* nsITransfer
|
|
* nsIWebProgressListener
|
|
* nsIWebProgressListener2
|
|
*
|
|
* XXX move this to nsEmbedCID.h once the interfaces (and the contract ID) are
|
|
* frozen.
|
|
*/
|
|
#define NS_TRANSFER_CONTRACTID "@mozilla.org/transfer;1"
|
|
%}
|