68 lines
3.5 KiB
Plaintext
68 lines
3.5 KiB
Plaintext
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
|
|
*
|
|
* 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 Netscape are
|
|
* Copyright (C) 1998 Netscape Communications Corporation. All
|
|
* Rights Reserved.
|
|
*
|
|
* Contributor(s):
|
|
*/
|
|
|
|
#include "nsIAppShellComponent.idl"
|
|
#include "domstubs.idl"
|
|
#include "nsIChannel.idl"
|
|
|
|
/*----------------------------- 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 : nsIAppShellComponent {
|
|
|
|
/*-------------------- 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 nsIDOMWindow 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. |
|
|
--------------------------------------------------------------------------*/
|
|
void SelectFileAndTransferLocationSpec( in string aURL, in nsIDOMWindow parent );
|
|
};
|
|
|
|
|
|
%{C++
|
|
#define NS_ISTREAMTRANSFER_PROGID NS_IAPPSHELLCOMPONENT_PROGID "/xfer"
|
|
#define NS_ISTREAMTRANSFER_CLASSNAME "Mozilla Stream Transfer Component"
|
|
%}
|