uriloader/base/nsIContentHandler.idl

   1 /* -*- Mode: C++; tab-width: 2; 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) 1999
  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 of the GNU General Public License Version 2 or later (the "GPL"),
  26  * or 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 interface nsIRequest;
  40 interface nsIInterfaceRequestor;
  41
  42 [scriptable, uuid(49439df2-b3d2-441c-bf62-866bdaf56fd2)]
  43 interface nsIContentHandler : nsISupports
  44 {
  45   /**
  46    * Tells the content handler to take over handling the content. If this
  47    * function succeeds, the URI Loader will leave this request alone, ignoring
  48    * progress notifications. Failure of this method will cause the request to be
  49    * cancelled, unless the error code is NS_ERROR_WONT_HANDLE_CONTENT (see
  50    * below).
  51    *
  52    * @param aWindowContext
  53    *        Window context, used to get things like the current nsIDOMWindow
  54    *        for this request. May be null.
  55    * @param aContentType
  56    *        The content type of aRequest
  57    * @param aRequest
  58    *        A request whose content type is already known.
  59    *
  60    * @throw NS_ERROR_WONT_HANDLE_CONTENT Indicates that this handler does not
  61    *        want to handle this content. A different way for handling this
  62    *        content should be tried.
  63    */
  64   void handleContent(in string aContentType,
  65                      in nsIInterfaceRequestor aWindowContext,
  66                      in nsIRequest aRequest);
  67 };
  68
  69
  70 %{C++
  71
  72 #define NS_ERROR_WONT_HANDLE_CONTENT   NS_ERROR_GENERATE_FAILURE(NS_ERROR_MODULE_URILOADER, 1)
  73
  74 %}