ac22050e0bee9f2491471a0842d43f0803d84142
[WebKit-https.git] / Source / WebCore / page / DOMSelection.idl
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 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(optional Node? node = null, optional long index = 0);
45     [RaisesException] void collapseToEnd();
46     [RaisesException] void collapseToStart();
47
48     void deleteFromDocument();
49     boolean containsNode(optional Node? node = null, optional boolean allowPartial = false);
50     [RaisesException] void selectAllChildren(optional Node? node = null);
51
52     [RaisesException] void extend(Node node, optional long offset = 0);
53
54     [RaisesException] Range getRangeAt(optional long index = 0);
55     void removeAllRanges();
56     void addRange(optional Range? range = null);
57
58 #if defined(LANGUAGE_JAVASCRIPT) && LANGUAGE_JAVASCRIPT
59     [NotEnumerable] DOMString toString();
60 #endif
61
62     // WebKit extensions
63     readonly attribute Node baseNode;
64     readonly attribute long baseOffset;
65     readonly attribute Node extentNode;
66     readonly attribute long extentOffset;
67
68     // WebKit's "type" accessor returns "None", "Range" and "Caret"
69     // IE's type accessor returns "none", "text" and "control"
70     readonly attribute DOMString type;
71
72     // FIXME: Using "undefined" as default parameter value is wrong.
73     void modify(optional DOMString alter = "undefined", optional DOMString direction = "undefined", optional DOMString granularity = "undefined");
74     [RaisesException] void setBaseAndExtent(optional Node? baseNode = null, optional long baseOffset = 0, optional Node? extentNode = null, optional long extentOffset = 0);
75     [RaisesException] void setPosition(optional Node? node = null, optional long offset = 0);
76
77     // IE extension
78     // http://msdn.microsoft.com/en-us/library/ms535869(VS.85).aspx
79     void empty();
80 };
81