dom/base/nsIObjectLoadingContent.idl

   1 /* -*- Mode: C++; 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 interface nsIChannel;
   9 interface nsIRequest;
  10 interface nsIFrame;
  11 interface nsIURI;
  12
  13 webidl BrowsingContext;
  14
  15 /**
  16  * This interface represents a content node that loads objects.
  17  *
  18  * Please make sure to update the MozObjectLoadingContent WebIDL
  19  * mixin to mirror this interface when changing it.
  20  */
  21
  22 [scriptable, builtinclass, uuid(2eb3195e-3eea-4083-bb1d-d2d70fa35ccb)]
  23 interface nsIObjectLoadingContent : nsISupports
  24 {
  25   /**
  26    * See notes in nsObjectLoadingContent.h
  27    */
  28   const unsigned long TYPE_LOADING     = 0;
  29   const unsigned long TYPE_DOCUMENT    = 1;
  30   const unsigned long TYPE_FALLBACK    = 2;
  31
  32   /**
  33    * The actual mime type (the one we got back from the network
  34    * request) for the element.
  35    */
  36   readonly attribute ACString actualType;
  37
  38   /**
  39    * Gets the type of the content that's currently loaded. See
  40    * the constants above for the list of possible values.
  41    */
  42   readonly attribute unsigned long displayedType;
  43
  44   /**
  45    * The URL of the data/src loaded in the object. This may be null (i.e.
  46    * an <embed> with no src).
  47    */
  48   readonly attribute nsIURI srcURI;
  49
  50   /**
  51    * Switch the tag into the TYPE_DOCUMENT state, and returns the
  52    * BrowsingContext which the load should complete in.
  53    */
  54   [noscript] BrowsingContext upgradeLoadToDocument(in nsIChannel channel);
  55 };