| /* ***** 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 |
| * Shawn Wilsher <me@shawnwilsher.com>. |
| * Portions created by the Initial Developer are Copyright (C) 2007 |
| * 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 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 "nsISupports.idl" |
| interface nsIInterfaceRequestor; |
| |
| [scriptable, uuid(ca7663d5-69e3-4c4a-b754-f462bd36b05f)] |
| interface nsIDownloadManagerUI : nsISupports { |
| /** |
| * The reason that should be passed when the user requests to show the |
| * download manager's UI. |
| */ |
| const short REASON_USER_INTERACTED = 0; |
| |
| /** |
| * The reason that should be passed to the show method when we are displaying |
| * the UI because a new download is being added to it. |
| */ |
| const short REASON_NEW_DOWNLOAD = 1; |
| |
| /** |
| * Shows the Download Manager's UI to the user. |
| * |
| * @param [optional] aWindowContext |
| * The parent window context to show the UI. |
| * @param [optional] aID |
| * The id of the download to be preselected upon opening. |
| * @param [optional] aReason |
| * The reason to show the download manager's UI. This defaults to |
| * REASON_USER_INTERACTED, and should be one of the previously listed |
| * constants. |
| */ |
| void show([optional] in nsIInterfaceRequestor aWindowContext, |
| [optional] in unsigned long aID, |
| [optional] in short aReason); |
| |
| /** |
| * Indicates if the UI is visible or not. |
| */ |
| readonly attribute boolean visible; |
| |
| /** |
| * Brings attention to the UI if it is already visible |
| * |
| * @throws NS_ERROR_UNEXPECTED if the UI is not visible. |
| */ |
| void getAttention(); |
| }; |
| |