dom/webidl/DOMParser.webidl
author Peter Van der Beken <peterv@propagandism.org>
Mon, 30 Sep 2013 18:32:22 +0200
changeset 151998 1b2970c8d6dd62bfca17c47d250e09cd05eafba0
parent 151871 da094d24f933c60c1fc5547b4cbf8eb1f51da0eb
child 414918 2bf23b953d5bbb0f3b7dc440906a50955fc429f8
permissions -rw-r--r--
Bug 922159 - Rename Creator WebIDL extended attribute to NewObject. r=bz.

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this file,
 * You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * The origin of this IDL file is
 * http://domparsing.spec.whatwg.org/#the-domparser-interface
 */

interface Principal;
interface URI;
interface InputStream;

enum SupportedType {
  "text/html",
  "text/xml",
  "application/xml",
  "application/xhtml+xml",
  "image/svg+xml"
};

// the latter is Mozilla-specific
[Constructor,
 Constructor(Principal? prin, optional URI? documentURI = null,
             optional URI? baseURI = null)]
interface DOMParser {
  [NewObject, Throws]
  Document parseFromString(DOMString str, SupportedType type);

  // Mozilla-specific stuff
  // Throws if the passed-in length is greater than the actual sequence length
  [NewObject, Throws, ChromeOnly]
  Document parseFromBuffer(sequence<octet> buf, unsigned long bufLen,
                           SupportedType type);
  // Throws if the passed-in length is greater than the actual typed array length
  [NewObject, Throws, ChromeOnly]
  Document parseFromBuffer(Uint8Array buf, unsigned long bufLen,
                           SupportedType type);
  [NewObject, Throws, ChromeOnly]
  Document parseFromStream(InputStream stream, DOMString? charset,
                           long contentLength, SupportedType type);
  [Throws, ChromeOnly]
  void init(optional Principal? principal = null,
            optional URI? documentURI = null,
            optional URI? baseURI = null);
};