docshell/base/nsIWebNavigationInfo.idl

   1 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   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  * Boris Zbarsky <bzbarsky@mit.edu>.
  19  * Portions created by the Initial Developer are Copyright (C) 2005
  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 nsIWebNavigation;
  41
  42 /**
  43  * The nsIWebNavigationInfo interface exposes a way to get information
  44  * on the capabilities of Gecko webnavigation objects.
  45  *
  46  * @status UNDER_REVIEW
  47  */
  48 [scriptable, uuid(62a93afb-93a1-465c-84c8-0432264229de)]
  49 interface nsIWebNavigationInfo : nsISupports
  50 {
  51   /**
  52    * Returned by isTypeSupported to indicate lack of support for a type.
  53    * @note this is guaranteed not to change, so that boolean tests can be done
  54    * on the return value if isTypeSupported to detect whether a type is
  55    * supported at all.
  56    */
  57   const unsigned long UNSUPPORTED = 0;
  58
  59   /**
  60    * Returned by isTypeSupported to indicate that a type is supported as an
  61    * image.
  62    */
  63   const unsigned long IMAGE = 1;
  64
  65   /**
  66    * Returned by isTypeSupported to indicate that a type is supported via an
  67    * NPAPI ("Netscape 4 API") plug-in.  This is not the value returned for
  68    * "XPCOM plug-ins".
  69    */
  70   const unsigned long PLUGIN = 2;
  71
  72   /**
  73    * @note Other return types may be added here in the future as they become
  74    * relevant.
  75    */
  76
  77   /**
  78    * Returned by isTypeSupported to indicate that a type is supported via some
  79    * other means.
  80    */
  81   const unsigned long OTHER = 1 << 15;
  82
  83   /**
  84    * Query whether aType is supported.
  85    * @param aType the MIME type in question.
  86    * @param aWebNav the nsIWebNavigation object for which the request
  87    *        is being made.  This is allowed to be null.  If it is non-null,
  88    *        the return value of this method may depend on the exact state of
  89    *        aWebNav and the values set through nsIWebBrowserSetup; otherwise
  90    *        the method will assume that the caller is interested in information
  91    *        about nsIWebNavigation objects in their default state.
  92    * @return an enum value indicating whether and how aType is supported.
  93    * @note This method may rescan plugins to ensure that they're properly
  94    *       registered for the types they support.
  95    */
  96   unsigned long isTypeSupported(in ACString aType, in nsIWebNavigation aWebNav);
  97 };