dom/webidl/HTMLObjectElement.webidl

   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 file,
   4  * You can obtain one at http://mozilla.org/MPL/2.0/.
   5  *
   6  * The origin of this IDL file is
   7  * http://www.whatwg.org/specs/web-apps/current-work/#the-object-element
   8  * http://www.whatwg.org/specs/web-apps/current-work/#HTMLObjectElement-partial
   9  *
  10  * © Copyright 2004-2011 Apple Computer, Inc., Mozilla Foundation, and
  11  * Opera Software ASA. You are granted a license to use, reproduce
  12  * and create derivative works of this document.
  13  */
  14
  15 // http://www.whatwg.org/specs/web-apps/current-work/#the-object-element
  16 [Exposed=Window]
  17 interface HTMLObjectElement : HTMLElement {
  18   [HTMLConstructor] constructor();
  19
  20   [CEReactions, Pure, SetterThrows]
  21            attribute DOMString data;
  22   [CEReactions, Pure, SetterThrows]
  23            attribute DOMString type;
  24   [CEReactions, Pure, SetterThrows]
  25            attribute DOMString name;
  26   [CEReactions, Pure, SetterThrows]
  27            attribute DOMString useMap;
  28   [Pure]
  29   readonly attribute HTMLFormElement? form;
  30   [CEReactions, Pure, SetterThrows]
  31            attribute DOMString width;
  32   [CEReactions, Pure, SetterThrows]
  33            attribute DOMString height;
  34   // Not pure: can trigger about:blank instantiation
  35   [NeedsSubjectPrincipal]
  36   readonly attribute Document? contentDocument;
  37   // Not pure: can trigger about:blank instantiation
  38   [NeedsSubjectPrincipal]
  39   readonly attribute WindowProxy? contentWindow;
  40
  41   readonly attribute boolean willValidate;
  42   readonly attribute ValidityState validity;
  43   [Throws]
  44   readonly attribute DOMString validationMessage;
  45   boolean checkValidity();
  46   boolean reportValidity();
  47   undefined setCustomValidity(DOMString error);
  48 };
  49
  50 // http://www.whatwg.org/specs/web-apps/current-work/#HTMLObjectElement-partial
  51 partial interface HTMLObjectElement {
  52   [CEReactions, Pure, SetterThrows]
  53            attribute DOMString align;
  54   [CEReactions, Pure, SetterThrows]
  55            attribute DOMString archive;
  56   [CEReactions, Pure, SetterThrows]
  57            attribute DOMString code;
  58   [CEReactions, Pure, SetterThrows]
  59            attribute boolean declare;
  60   [CEReactions, Pure, SetterThrows]
  61            attribute unsigned long hspace;
  62   [CEReactions, Pure, SetterThrows]
  63            attribute DOMString standby;
  64   [CEReactions, Pure, SetterThrows]
  65            attribute unsigned long vspace;
  66   [CEReactions, Pure, SetterThrows]
  67            attribute DOMString codeBase;
  68   [CEReactions, Pure, SetterThrows]
  69            attribute DOMString codeType;
  70
  71   [CEReactions, Pure, SetterThrows]
  72            attribute [LegacyNullToEmptyString] DOMString border;
  73 };
  74
  75 partial interface HTMLObjectElement {
  76   // GetSVGDocument
  77   [NeedsSubjectPrincipal]
  78   Document? getSVGDocument();
  79 };
  80
  81 interface mixin MozObjectLoadingContent {
  82   // Mirrored chrome-only scriptable nsIObjectLoadingContent methods.  Please
  83   // make sure to update this list if nsIObjectLoadingContent changes.  Also,
  84   // make sure everything on here is [ChromeOnly].
  85   [ChromeOnly]
  86   const unsigned long TYPE_LOADING     = 0;
  87   [ChromeOnly]
  88   const unsigned long TYPE_DOCUMENT    = 1;
  89   [ChromeOnly]
  90   const unsigned long TYPE_FALLBACK    = 2;
  91
  92   /**
  93    * The actual mime type (the one we got back from the network
  94    * request) for the element.
  95    */
  96   [ChromeOnly]
  97   readonly attribute DOMString actualType;
  98
  99   /**
 100    * Gets the type of the content that's currently loaded. See
 101    * the constants above for the list of possible values.
 102    */
 103   [ChromeOnly]
 104   readonly attribute unsigned long displayedType;
 105
 106   /**
 107    * The URL of the data/src loaded in the object. This may be null (i.e.
 108    * an <embed> with no src).
 109    */
 110   [ChromeOnly]
 111   readonly attribute URI? srcURI;
 112 };
 113
 114 HTMLObjectElement includes MozFrameLoaderOwner;
 115 HTMLObjectElement includes MozObjectLoadingContent;