docshell/base/nsIWebNavigationInfo.idl

   1 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #include "nsISupports.idl"
   7
   8 /**
   9  * The nsIWebNavigationInfo interface exposes a way to get information
  10  * on the capabilities of Gecko webnavigation objects.
  11  */
  12 [scriptable, uuid(62a93afb-93a1-465c-84c8-0432264229de)]
  13 interface nsIWebNavigationInfo : nsISupports
  14 {
  15   /**
  16    * Returned by isTypeSupported to indicate lack of support for a type.
  17    * @note this is guaranteed not to change, so that boolean tests can be done
  18    * on the return value if isTypeSupported to detect whether a type is
  19    * supported at all.
  20    */
  21   const unsigned long UNSUPPORTED = 0;
  22
  23   /**
  24    * Returned by isTypeSupported to indicate that a type is supported as an
  25    * image.
  26    */
  27   const unsigned long IMAGE = 1;
  28
  29   /**
  30    * Returned by isTypeSupported to indicate that a type is a special NPAPI
  31    * plugin that render as a transparent region (we do not support NPAPI
  32    * plugins).
  33    */
  34   const unsigned long FALLBACK = 2;
  35
  36   /**
  37    * @note Other return types may be added here in the future as they become
  38    * relevant.
  39    */
  40
  41   /**
  42    * Returned by isTypeSupported to indicate that a type is supported via some
  43    * other means.
  44    */
  45   const unsigned long OTHER = 1 << 15;
  46
  47   /**
  48    * Query whether aType is supported.
  49    * @param aType the MIME type in question.
  50    * @return an enum value indicating whether and how aType is supported.
  51    * @note This method may rescan plugins to ensure that they're properly
  52    *       registered for the types they support.
  53    */
  54   unsigned long isTypeSupported(in ACString aType);
  55 };