uriloader/exthandler/nsIHelperAppLauncherDialog.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #include "nsISupports.idl"
  39
  40 interface nsIHelperAppLauncher;
  41 interface nsILocalFile;
  42
  43 /**
  44  * This interface is used to display a confirmation dialog before
  45  * launching a "helper app" to handle content not handled by
  46  * Mozilla.
  47  *
  48  * Usage:  Clients (of which there is one: the nsIExternalHelperAppService
  49  * implementation in mozilla/uriloader/exthandler) create an instance of
  50  * this interface (using the contract ID) and then call the show() method.
  51  *
  52  * The dialog is shown non-modally.  The implementation of the dialog
  53  * will access methods of the nsIHelperAppLauncher passed in to show()
  54  * in order to cause a "save to disk" or "open using" action.
  55  */
  56 [scriptable, uuid(f3704fdc-8ae6-4eba-a3c3-f02958ac0649)]
  57 interface nsIHelperAppLauncherDialog : nsISupports {
  58   /**
  59    * This request is passed to the helper app dialog because Gecko can not
  60    * handle content of this type.
  61    */
  62   const unsigned long REASON_CANTHANDLE = 0;
  63
  64   /**
  65    * The server requested external handling.
  66    */
  67   const unsigned long REASON_SERVERREQUEST = 1;
  68
  69   /**
  70    * Gecko detected that the type sent by the server (e.g. text/plain) does
  71    * not match the actual type.
  72    */
  73   const unsigned long REASON_TYPESNIFFED = 2;
  74
  75   /**
  76    * Show confirmation dialog for launching application (or "save to
  77    * disk") for content specified by aLauncher.
  78    *
  79    * @param aLauncher
  80    *        A nsIHelperAppLauncher to be invoked when a file is selected.
  81    * @param aWindowContext
  82    *        Window associated with action.
  83    * @param aReason
  84    *        One of the constants from above. It indicates why the dialog is
  85    *        shown. Implementors should treat unknown reasons like
  86    *        REASON_CANTHANDLE.
  87    */
  88   void show(in nsIHelperAppLauncher aLauncher,
  89             in nsISupports aWindowContext,
  90             in unsigned long aReason);
  91
  92   /**
  93    * Invoke a save-to-file dialog instead of the full fledged helper app dialog.
  94    * Returns the a nsILocalFile for the file name/location selected.
  95    *
  96    * @param aLauncher
  97    *        A nsIHelperAppLauncher to be invoked when a file is selected.
  98    * @param aWindowContext
  99    *        Window associated with action.
 100    * @param aDefaultFileName
 101    *        Default file name to provide (can be null)
 102    * @param aSuggestedFileExtension
 103    *        Sugested file extension
 104    * @param aForcePrompt
 105    *        Set to true to force prompting the user for thet file
 106    *        name/location, otherwise perferences may control if the user is
 107    *        prompted.
 108    */
 109   nsILocalFile promptForSaveToFile(in nsIHelperAppLauncher aLauncher,
 110                                    in nsISupports aWindowContext,
 111                                    in wstring aDefaultFileName,
 112                                    in wstring aSuggestedFileExtension,
 113                                    in boolean aForcePrompt);
 114 };
 115
 116
 117 %{C++
 118 #define NS_HELPERAPPLAUNCHERDLG_CONTRACTID    "@mozilla.org/helperapplauncherdialog;1"
 119 #define NS_IHELPERAPPLAUNCHERDLG_CLASSNAME "Mozilla Helper App Launcher Confirmation Dialog"
 120 %}