• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1/*
2 * Copyright (C) 2006 Apple Computer, Inc.
3 * Copyright (C) 2006 Samuel Weinig <sam.weinig@gmail.com>
4 *
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Library General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
9 *
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13 * Library General Public License for more details.
14 *
15 * You should have received a copy of the GNU Library General Public License
16 * along with this library; see the file COPYING.LIB.  If not, write to
17 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18 * Boston, MA 02110-1301, USA.
19 */
20
21// Introduced in DOM Level 2:
22[
23    Constructor,
24    ConstructorCallWith=Document,
25] interface Range {
26
27    [RaisesException=Getter] readonly attribute Node startContainer;
28    [RaisesException=Getter] readonly attribute long startOffset;
29    [RaisesException=Getter] readonly attribute Node endContainer;
30    [RaisesException=Getter] readonly attribute long endOffset;
31    [RaisesException=Getter] readonly attribute boolean collapsed;
32    [RaisesException=Getter] readonly attribute Node commonAncestorContainer;
33
34    [RaisesException] void setStart(Node refNode, long offset);
35    [RaisesException] void setEnd(Node refNode, long offset);
36    [RaisesException] void setStartBefore(Node refNode);
37    [RaisesException] void setStartAfter(Node refNode);
38    [RaisesException] void setEndBefore(Node refNode);
39    [RaisesException] void setEndAfter(Node refNode);
40    [RaisesException] void collapse([Default=Undefined] optional boolean toStart);
41    [RaisesException] void selectNode(Node refNode);
42    [RaisesException] void selectNodeContents(Node refNode);
43
44    // CompareHow
45    const unsigned short START_TO_START = 0;
46    const unsigned short START_TO_END   = 1;
47    const unsigned short END_TO_END     = 2;
48    const unsigned short END_TO_START   = 3;
49
50    [RaisesException] short compareBoundaryPoints(CompareHow how, Range sourceRange);
51
52    [RaisesException, CustomElementCallbacks] void deleteContents();
53    [RaisesException, CustomElementCallbacks] DocumentFragment extractContents();
54    [RaisesException, CustomElementCallbacks] DocumentFragment cloneContents();
55    [RaisesException, CustomElementCallbacks] void insertNode(Node newNode);
56    [RaisesException, CustomElementCallbacks] void surroundContents(Node newParent);
57    [RaisesException] Range cloneRange();
58    [RaisesException] DOMString toString();
59
60    [RaisesException] void detach();
61
62    [RaisesException] boolean isPointInRange(Node refNode, long offset);
63    [RaisesException] short comparePoint(Node refNode, long offset);
64
65    [RaisesException] boolean intersectsNode(Node refNode);
66
67    // CSSOM View Module API extensions
68
69    ClientRectList getClientRects();
70    ClientRect getBoundingClientRect();
71
72    // DOM Parsing and Serialization
73
74    [RaisesException, CustomElementCallbacks] DocumentFragment createContextualFragment(DOMString html);
75
76    // WebKit extensions
77
78    // CompareResults
79    const unsigned short NODE_BEFORE           = 0;
80    const unsigned short NODE_AFTER            = 1;
81    const unsigned short NODE_BEFORE_AND_AFTER = 2;
82    const unsigned short NODE_INSIDE           = 3;
83
84    [RaisesException] short compareNode([Default=Undefined] optional Node refNode);
85
86    [RaisesException] void expand([Default=Undefined] optional DOMString unit);
87};
88