1/*
2 * Copyright (C) 2007 Apple Inc.  All rights reserved.
3 * Copyright (C) 2009 Google Inc.  All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * 1.  Redistributions of source code must retain the above copyright
10 *     notice, this list of conditions and the following disclaimer.
11 * 2.  Redistributions in binary form must reproduce the above copyright
12 *     notice, this list of conditions and the following disclaimer in the
13 *     documentation and/or other materials provided with the distribution.
14 * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
15 *     its contributors may be used to endorse or promote products derived
16 *     from this software without specific prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
19 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
22 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 */
29
30// This is based off of Mozilla's Selection interface
31// https://developer.mozilla.org/En/DOM/Selection
32[
33    GenerateIsReachable=ImplFrame,
34    InterfaceName=Selection
35] interface DOMSelection {
36    readonly attribute Node anchorNode;
37    readonly attribute long anchorOffset;
38    readonly attribute Node focusNode;
39    readonly attribute long focusOffset;
40
41    readonly attribute boolean isCollapsed;
42    readonly attribute long rangeCount;
43
44    [RaisesException] void collapse([Default=Undefined] optional Node node,
45                  [Default=Undefined] optional long index);
46    [RaisesException] void collapseToEnd();
47    [RaisesException] void collapseToStart();
48
49    void deleteFromDocument();
50    boolean containsNode([Default=Undefined] optional Node node,
51                         [Default=Undefined] optional boolean allowPartial);
52    [RaisesException] void selectAllChildren([Default=Undefined] optional Node node);
53
54    [RaisesException] void extend([Default=Undefined] optional Node node,
55                [Default=Undefined] optional long offset);
56
57    [RaisesException] Range getRangeAt([Default=Undefined] optional long index);
58    void removeAllRanges();
59    void addRange([Default=Undefined] optional Range range);
60
61#if defined(LANGUAGE_JAVASCRIPT) && LANGUAGE_JAVASCRIPT
62    [NotEnumerable] DOMString toString();
63#endif
64
65    // WebKit extensions
66    readonly attribute Node baseNode;
67    readonly attribute long baseOffset;
68    readonly attribute Node extentNode;
69    readonly attribute long extentOffset;
70
71    // WebKit's "type" accessor returns "None", "Range" and "Caret"
72    // IE's type accessor returns "none", "text" and "control"
73    readonly attribute DOMString type;
74
75    void modify([Default=Undefined] optional DOMString alter,
76                [Default=Undefined] optional DOMString direction,
77                [Default=Undefined] optional DOMString granularity);
78    [RaisesException] void setBaseAndExtent([Default=Undefined] optional Node baseNode,
79                          [Default=Undefined] optional long baseOffset,
80                          [Default=Undefined] optional Node extentNode,
81                          [Default=Undefined] optional long extentOffset);
82    [RaisesException] void setPosition([Default=Undefined] optional Node node,
83                     [Default=Undefined] optional long offset);
84
85    // IE extentions
86    // http://msdn.microsoft.com/en-us/library/ms535869(VS.85).aspx
87    void empty();
88};
89
90