94 lines
5.2 KiB
Plaintext
94 lines
5.2 KiB
Plaintext
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
/* ***** BEGIN LICENSE BLOCK *****
|
|
* Version: NPL 1.1/GPL 2.0/LGPL 2.1
|
|
*
|
|
* The contents of this file are subject to the Netscape 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/NPL/
|
|
*
|
|
* 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):
|
|
*
|
|
* 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 NPL, 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 NPL, the GPL or the LGPL.
|
|
*
|
|
* ***** END LICENSE BLOCK ***** */
|
|
|
|
#include "nsIChannel.idl"
|
|
|
|
interface nsIDOMWindowInternal;
|
|
|
|
/*----------------------------- nsIStreamTransfer -----------------------------
|
|
| This file describes Mozilla's general-purpose "stream transfer" component. |
|
|
| This component is used to display a progress dialog while performing any of |
|
|
| a variety of different "stream transfers." |
|
|
| |
|
|
| Basically, this component transfers data from an input stream to an |
|
|
| output stream while displaying a progress dialog. The component also |
|
|
| offers some standard implementations of commonly-used input and output |
|
|
| stream handlers (such as prompting for a destination file, writing the |
|
|
| input stream to an output file, loading an input URL, etc.). |
|
|
| |
|
|
| Select the appropriate transfer function depending on your requirements. |
|
|
| |
|
|
| Note that all methods are "asynchronous" in that they return before the |
|
|
| stream transfer is completed. The result generally indicates only whether |
|
|
| or not the stream transfer was successfully initiated. |
|
|
-----------------------------------------------------------------------------*/
|
|
[scriptable, uuid(a6cf90f0-15b3-11d2-932e-00805f8add32)]
|
|
interface nsIStreamTransfer : nsISupports {
|
|
|
|
/*-------------------- SelectFileAndTransferLocation ----------------------
|
|
| Prompt the user for a destination file and then transfer the data, using|
|
|
| the argument channel as source, to that file, while showing a progress |
|
|
| dialog. |
|
|
--------------------------------------------------------------------------*/
|
|
[noscript] void SelectFileAndTransferLocation( in nsIChannel aChannel,
|
|
in nsIDOMWindowInternal parent );
|
|
|
|
/*------------------ SelectFileAndTransferLocationSpec --------------------
|
|
| Prompt the user for a destination file and then transfer the data, using|
|
|
| the argument URL as source, to that file, while showing a progress |
|
|
| dialog. The "don't validate" flag indicates whether or not to use the |
|
|
| VALIDATE_NEVER load flag to force loading from the cache. That would be |
|
|
| appropriate when saving a page being viewed, for example. A post data |
|
|
| input stream can be passed in and it will be attached to the http |
|
|
| channel as the "upload stream." An optional cacheKey can also be |
|
|
| passed in to force the stream out of the cache. |
|
|
-------------------------------------------------------------------------*/
|
|
void SelectFileAndTransferLocationSpec( in string aURL,
|
|
in nsIDOMWindowInternal parent,
|
|
in string contentType,
|
|
in string suggestedName,
|
|
in boolean doNotValidate,
|
|
in nsIInputStream postData,
|
|
in nsISupports cacheKey );
|
|
};
|
|
|
|
|
|
%{C++
|
|
#define NS_ISTREAMTRANSFER_CONTRACTID "@mozilla.org/appshell/component/xfer;1"
|
|
#define NS_ISTREAMTRANSFER_CLASSNAME "Mozilla Stream Transfer Component"
|
|
%}
|