pjs/xpfe/components/download-manager/public/nsIDownloadManager.idl

/* -*- 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):
 *   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 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 ***** */

// Keeps track of ongoing downloads, in the form of nsIDownloadItems. 

#include "nsISupports.idl"
#include "nsIWebProgressListener.idl"

interface nsIDOMWindow;
interface nsIDownloadItem;

[scriptable, uuid(9be66cc0-1dd1-11b2-8617-e3a3ed26e3b0)]
interface nsIDownloadManager : nsISupports {

  /**
  * createDownload
  * Creates a download item that can be managed.  Set the proper attributes
  * on the nsIDownloadItem returned by this method, and then call addDownload to
  * add it to the manager.
  */
 
  nsIDownloadItem createDownload();

  /**
  * addDownload
  * Adds a download to be managed by the download manager.
  */
  
  void addDownload(in nsIDownloadItem item);

  /**
  * getDownload
  * Used to retrieve a download managed by the download manager.
  */

  nsIDownloadItem getDownload(in string key);

  /**
  * cancelDownload
  * If a persist is set on the download item, download manager will call
  * nsIWebBrowserPersist::CancelSave.  Else, if an observer is set on the item
  * (it should be), it will be notified with the "oncancel" topic.  Callers
  * that don't provide a persist object promise to listen for this topic and cancel
  * the download.
  */

  void cancelDownload(in string key);

  /**
  * removeDownload
  * Remove a download that is not currently in progress.  Whereas cancelDownload simply
  * cancels the transfer but retains information about it, removeDownload removes all
  * knowledge of it.
  */

  void removeDownload(in string key);

  /**
  * open
  * Opens the Download Manager front end.
  */

  void open(in nsIDOMWindow aParent);

  /**
  * openProgressDialogFor
  * Opens an individual progress dialog displaying progress for the download.
  */

  void openProgressDialogFor(in string key, in nsIDOMWindow aParent);

  /**
  * onClose
  * Called when the download manager front end is closed.  Useful for
  * third party managers to let us know when they've closed.
  */
  void onClose();

};


%{C++
#define NS_DOWNLOADMANAGER_CONTRACTID "@mozilla.org/download-manager;1"
#define NS_DOWNLOADMANAGER_CLASSNAME "Mozilla Download Manager"
// {EDB0490E-1DD1-11B2-83B8-DBF8D85906A6}
#define NS_DOWNLOADMANAGER_CID \
    { 0xedb0490e, 0x1dd1, 0x11b2, { 0x83, 0xb8, 0xdb, 0xf8, 0xd8, 0x59, 0x06, 0xa6 } }
%}