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 * Mozilla Foundation.
19 * Portions created by the Initial Developer are Copyright (C) 2007
20 * the Initial Developer. All Rights Reserved.
21 *
22 * Contributor(s):
23 * Robert Sayre <sayrer@gmail.com> (original author)
24 *
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 "domstubs.idl"
41
42 interface nsIDOMNodeList;
43
44 [scriptable, uuid(cea6f919-7fe6-4bdd-9db6-158d9283f8d3)]
45 interface nsIDOMNSElement : nsISupports
46 {
47 /*
48 * Retrieve elements matching all classes listed in a
49 * space-separated string.
50 *
51 * See <http://whatwg.org/specs/web-apps/current-work/>
52 */
53 nsIDOMNodeList getElementsByClassName(in DOMString classes);
54
55 /*
56 * Retrieve a list of rectangles, one for each CSS border-box associated with
57 * the element. The coordinates are in CSS pixels, and relative to
58 * the top-left of the document's viewport, unless the document
59 * has an SVG foreignobject ancestor, in which case the coordinates are
60 * relative to the top-left of the content box of the nearest SVG foreignobject
61 * ancestor. The coordinates are calculated as if every scrollable element
62 * is scrolled to its default position.
63 *
64 * Note: the boxes of overflowing children do not affect these rectangles.
65 * Note: some elements have empty CSS boxes. Those return empty rectangles,
66 * but the coordinates may still be meaningful.
67 * Note: some elements have no CSS boxes (including display:none elements,
68 * HTML AREA elements, and SVG elements that do not render). Those return
69 * an empty list.
70 */
71 nsIDOMClientRectList getClientRects();
72 /**
73 * Returns the union of all rectangles in the getClientRects() list. Empty
74 * rectangles are ignored, except that if all rectangles are empty,
75 * we return an empty rectangle positioned at the top-left of the first
76 * rectangle in getClientRects().
77 */
78 nsIDOMClientRect getBoundingClientRect();
79 };