dom/webidl/HTMLImageElement.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/#htmlimageelement
   8  * http://www.whatwg.org/specs/web-apps/current-work/#other-elements,-attributes-and-apis
   9  * © Copyright 2004-2011 Apple Computer, Inc., Mozilla Foundation, and
  10  * Opera Software ASA. You are granted a license to use, reproduce
  11  * and create derivative works of this document.
  12  */
  13
  14 interface imgINotificationObserver;
  15 interface imgIRequest;
  16 interface URI;
  17 interface nsIStreamListener;
  18
  19 [LegacyFactoryFunction=Image(optional unsigned long width, optional unsigned long height),
  20  Exposed=Window]
  21 interface HTMLImageElement : HTMLElement {
  22   [HTMLConstructor] constructor();
  23
  24            [CEReactions, SetterThrows]
  25            attribute DOMString alt;
  26            [CEReactions, SetterNeedsSubjectPrincipal=NonSystem, SetterThrows]
  27            attribute DOMString src;
  28            [CEReactions, SetterNeedsSubjectPrincipal=NonSystem, SetterThrows]
  29            attribute DOMString srcset;
  30            [CEReactions, SetterThrows]
  31            attribute DOMString? crossOrigin;
  32            [CEReactions, SetterThrows]
  33            attribute DOMString useMap;
  34            [CEReactions, SetterThrows]
  35            attribute DOMString referrerPolicy;
  36            [CEReactions, SetterThrows]
  37            attribute boolean isMap;
  38            [CEReactions, SetterThrows]
  39            attribute unsigned long width;
  40            [CEReactions, SetterThrows]
  41            attribute unsigned long height;
  42            [CEReactions, SetterThrows]
  43            attribute DOMString decoding;
  44            [CEReactions, SetterThrows, Pref="dom.image-lazy-loading.enabled"]
  45            attribute DOMString loading;
  46   readonly attribute unsigned long naturalWidth;
  47   readonly attribute unsigned long naturalHeight;
  48   readonly attribute boolean complete;
  49            [NewObject]
  50            Promise<undefined> decode();
  51            [NewObject, ChromeOnly]
  52            Promise<sequence<ImageText>> recognizeCurrentImageText();
  53 };
  54
  55 // http://www.whatwg.org/specs/web-apps/current-work/#other-elements,-attributes-and-apis
  56 partial interface HTMLImageElement {
  57            [CEReactions, SetterThrows]
  58            attribute DOMString name;
  59            [CEReactions, SetterThrows]
  60            attribute DOMString align;
  61            [CEReactions, SetterThrows]
  62            attribute unsigned long hspace;
  63            [CEReactions, SetterThrows]
  64            attribute unsigned long vspace;
  65            [CEReactions, SetterThrows]
  66            attribute DOMString longDesc;
  67
  68   [CEReactions, SetterThrows] attribute [LegacyNullToEmptyString] DOMString border;
  69 };
  70
  71 // [Update me: not in whatwg spec yet]
  72 // http://picture.responsiveimages.org/#the-img-element
  73 partial interface HTMLImageElement {
  74            [CEReactions, SetterThrows]
  75            attribute DOMString sizes;
  76   readonly attribute DOMString currentSrc;
  77 };
  78
  79 // Mozilla extensions.
  80 partial interface HTMLImageElement {
  81            [CEReactions, SetterThrows]
  82            attribute DOMString lowsrc;
  83
  84   // These attributes are offsets from the closest view (to mimic
  85   // NS4's "offset-from-layer" behavior).
  86   readonly attribute long x;
  87   readonly attribute long y;
  88 };
  89
  90 interface mixin MozImageLoadingContent {
  91   // Mirrored chrome-only nsIImageLoadingContent methods.  Please make sure
  92   // to update this list if nsIImageLoadingContent changes.
  93   [ChromeOnly]
  94   const long UNKNOWN_REQUEST = -1;
  95   [ChromeOnly]
  96   const long CURRENT_REQUEST = 0;
  97   [ChromeOnly]
  98   const long PENDING_REQUEST = 1;
  99
 100   [ChromeOnly]
 101   attribute boolean loadingEnabled;
 102   /**
 103    * Same as addNativeObserver but intended for scripted observers or observers
 104    * from another or without a document.
 105    */
 106   [ChromeOnly]
 107   undefined addObserver(imgINotificationObserver aObserver);
 108   /**
 109    * Same as removeNativeObserver but intended for scripted observers or
 110    * observers from another or without a document.
 111    */
 112   [ChromeOnly]
 113   undefined removeObserver(imgINotificationObserver aObserver);
 114   [ChromeOnly,Throws]
 115   imgIRequest? getRequest(long aRequestType);
 116   [ChromeOnly,Throws]
 117   long getRequestType(imgIRequest aRequest);
 118   [ChromeOnly]
 119   readonly attribute URI? currentURI;
 120   // Gets the final URI of the current request, if available.
 121   // Otherwise, returns null.
 122   [ChromeOnly]
 123   readonly attribute URI? currentRequestFinalURI;
 124   /**
 125    * forceReload forces reloading of the image pointed to by currentURI
 126    *
 127    * @param aNotify request should notify
 128    * @throws NS_ERROR_NOT_AVAILABLE if there is no current URI to reload
 129    */
 130   [ChromeOnly,Throws]
 131   undefined forceReload(optional boolean aNotify = true);
 132 };
 133
 134 HTMLImageElement includes MozImageLoadingContent;