/gecko_sdk/idl/nsIDOMHTMLDocument.idl

 1/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
 2/* ***** BEGIN LICENSE BLOCK *****
 3 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 4 *
 5 * The contents of this file are subject to the Mozilla Public License Version
 6 * 1.1 (the "License"); you may not use this file except in compliance with
 7 * the License. You may obtain a copy of the License at
 8 * http://www.mozilla.org/MPL/
 9 *
10 * Software distributed under the License is distributed on an "AS IS" basis,
11 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
12 * for the specific language governing rights and limitations under the
13 * License.
14 *
15 * The Original Code is mozilla.org code.
16 *
17 * The Initial Developer of the Original Code is
18 * Netscape Communications Corporation.
19 * Portions created by the Initial Developer are Copyright (C) 2000
20 * the Initial Developer. All Rights Reserved.
21 *
22 * Contributor(s):
23 *   Vidur Apparao <vidur@netscape.com> (original author)
24 *   Johnny Stenback <jst@netscape.com>
25 *
26 * Alternatively, the contents of this file may be used under the terms of
27 * either of the GNU General Public License Version 2 or later (the "GPL"),
28 * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
29 * in which case the provisions of the GPL or the LGPL are applicable instead
30 * of those above. If you wish to allow use of your version of this file only
31 * under the terms of either the GPL or the LGPL, and not to allow others to
32 * use your version of this file under the terms of the MPL, indicate your
33 * decision by deleting the provisions above and replace them with the notice
34 * and other provisions required by the GPL or the LGPL. If you do not delete
35 * the provisions above, a recipient may use your version of this file under
36 * the terms of any one of the MPL, the GPL or the LGPL.
37 *
38 * ***** END LICENSE BLOCK ***** */
39
40#include "nsIDOMDocument.idl"
41
42/**
43 * The nsIDOMHTMLDocument interface is the interface to a [X]HTML
44 * document object.
45 *
46 * For more information on this interface please see
47 * http://www.w3.org/TR/DOM-Level-2-HTML/
48 *
49 * @status FROZEN
50 */
51
52[scriptable, uuid(a6cf9084-15b3-11d2-932e-00805f8add32)]
53interface nsIDOMHTMLDocument : nsIDOMDocument
54{
55           attribute DOMString            title;
56  readonly attribute DOMString            referrer;
57  // domain is readonly per spec, but it's settable in
58  // nsIDOMNSHTMLDocument
59  [noscript] readonly attribute DOMString domain;
60  readonly attribute DOMString            URL;
61           attribute nsIDOMHTMLElement    body;
62  readonly attribute nsIDOMHTMLCollection images;
63  readonly attribute nsIDOMHTMLCollection applets;
64  readonly attribute nsIDOMHTMLCollection links;
65  readonly attribute nsIDOMHTMLCollection forms;
66  readonly attribute nsIDOMHTMLCollection anchors;
67           attribute DOMString            cookie;
68                                             // raises(DOMException) on setting
69
70  // open() is noscript here since the DOM Level 0 version of open()
71  // returned nsIDOMDocument, and not void. The script version of
72  // open() is defined in nsIDOMNSHTMLDocument.
73  [noscript] void           open();
74  void                      close();
75
76  // The methods write() and writeln() must be callable from JS with
77  // no arguments for backwards compatibility, thus they are marked
78  // [noscript] here. The JS versions of these methods are defined in
79  // nsIDOMNSHTMLDocument.
80  [noscript] void           write(in DOMString text);
81  [noscript] void           writeln(in DOMString text);
82
83  nsIDOMNodeList            getElementsByName(in DOMString elementName);
84};