Back to index

lightning-sunbird  0.9+nobinonly
nsIHelperAppLauncherDialog.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either the GNU General Public License Version 2 or later (the "GPL"), or
00026  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #include "nsISupports.idl"
00039 
00040 interface nsIHelperAppLauncher;
00041 interface nsILocalFile;
00042 
00056 [scriptable, uuid(64355793-988d-40a5-ba8e-fcde78cac631)]
00057 interface nsIHelperAppLauncherDialog : nsISupports {
00062   const unsigned long REASON_CANTHANDLE = 0;
00063 
00067   const unsigned long REASON_SERVERREQUEST = 1;
00068 
00073   const unsigned long REASON_TYPESNIFFED = 2;
00074 
00075   // Show confirmation dialog for launching application (or "save to
00076   // disk") for content specified by aLauncher.
00077   // aReason is one of the constants from above. It indicates why the dialog is
00078   // shown.
00079   // Implementors should treat unknown reasons like REASON_CANTHANDLE.
00080   void show(in nsIHelperAppLauncher aLauncher,
00081             in nsISupports aContext,
00082             in unsigned long aReason);
00083        
00084        // invoke a save to file dialog instead of the full fledged helper app dialog.
00085        // aDefaultFileName --> default file name to provide (can be null)
00086        // aSuggestedFileExtension --> sugested file extension
00087        // aFileLocation --> return value for the file location
00088   nsILocalFile promptForSaveToFile(in nsIHelperAppLauncher aLauncher, 
00089                                    in nsISupports aWindowContext, 
00090                                    in wstring aDefaultFile, 
00091                                    in wstring aSuggestedFileExtension);
00092 };
00093 
00094 
00095 %{C++
00096 #define NS_IHELPERAPPLAUNCHERDLG_CONTRACTID    "@mozilla.org/helperapplauncherdialog;1"
00097 #define NS_IHELPERAPPLAUNCHERDLG_CLASSNAME "Mozilla Helper App Launcher Confirmation Dialog"
00098 %}