uriloader/exthandler/nsIContentDispatchChooser.idl

   1 /* ***** BEGIN LICENSE BLOCK *****
   2  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   3  *
   4  * The contents of this file are subject to the Mozilla Public License Version
   5  * 1.1 (the "License"); you may not use this file except in compliance with
   6  * the License. You may obtain a copy of the License at
   7  * http://www.mozilla.org/MPL/
   8  *
   9  * Software distributed under the License is distributed on an "AS IS" basis,
  10  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11  * for the specific language governing rights and limitations under the
  12  * License.
  13  *
  14  * The Original Code is mozilla.org code.
  15  *
  16  * The Initial Developer of the Original Code is
  17  * Mozilla Corporation.
  18  * Portions created by the Initial Developer are Copyright (C) 2007
  19  * the Initial Developer. All Rights Reserved.
  20  *
  21  * Contributor(s):
  22  *   Shawn Wilsher <me@shawnwilsher.com> (Original Author)
  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 nsIHandlerInfo;
  41 interface nsIHelperAppLauncher;
  42 interface nsIURI;
  43 interface nsIInterfaceRequestor;
  44
  45 /**
  46  * This is used to ask a user what they would like to do with a given piece of
  47  * content.
  48  */
  49 [scriptable, uuid(456ca3b2-02be-4f97-89a2-08c08d3ad88f)]
  50 interface nsIContentDispatchChooser : nsISupports {
  51  /**
  52   * This request is passed to the helper app dialog because Gecko can not
  53   * handle content of this type.
  54   */
  55   const unsigned long REASON_CANNOT_HANDLE = 0;
  56
  57  /**
  58   * Asks the user what to do with the content.
  59   *
  60   * @param aHander
  61   *        The interface describing the details of how this content should or
  62   *        can be handled.
  63   * @param aWindowContext
  64   *        The parent window context to show this chooser.  This can be null,
  65   *        and some implementations may not care about it.  Generally, you'll
  66   *        want to pass an nsIDOMWindow in so the chooser can be properly
  67   *        parented when opened.
  68   * @param aURI
  69   *        The URI of the resource that we are asking about.
  70   * @param aReason
  71   *        The reason why we are asking (see above).
  72   */
  73   void ask(in nsIHandlerInfo aHandler,
  74            in nsIInterfaceRequestor aWindowContext,
  75            in nsIURI aURI,
  76            in unsigned long aReason);
  77 };
  78