summaryrefslogtreecommitdiffstats
path: root/dom/webidl/Range.webidl
diff options
context:
space:
mode:
Diffstat (limited to 'dom/webidl/Range.webidl')
-rw-r--r--dom/webidl/Range.webidl96
1 files changed, 96 insertions, 0 deletions
diff --git a/dom/webidl/Range.webidl b/dom/webidl/Range.webidl
new file mode 100644
index 0000000000..9d06ec09c7
--- /dev/null
+++ b/dom/webidl/Range.webidl
@@ -0,0 +1,96 @@
+/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this file,
+ * You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * The origin of this IDL file is
+ * http://dom.spec.whatwg.org/#range
+ * http://domparsing.spec.whatwg.org/#dom-range-createcontextualfragment
+ * http://dvcs.w3.org/hg/csswg/raw-file/tip/cssom-view/Overview.html#extensions-to-the-range-interface
+ *
+ * Copyright © 2012 W3C® (MIT, ERCIM, Keio), All Rights Reserved. W3C
+ * liability, trademark and document use rules apply.
+ */
+
+// Use ProbablyShortLivingWrapper so that the Range object could be deleted
+// as soon as possible, and thus slow down DOM operations less.
+[Exposed=Window, ProbablyShortLivingWrapper]
+interface Range : AbstractRange {
+ [Throws]
+ constructor();
+
+ [Throws]
+ readonly attribute Node commonAncestorContainer;
+
+ [Throws, BinaryName="setStartJS"]
+ undefined setStart(Node refNode, unsigned long offset);
+ [Throws, BinaryName="setEndJS"]
+ undefined setEnd(Node refNode, unsigned long offset);
+ [Throws, BinaryName="setStartBeforeJS"]
+ undefined setStartBefore(Node refNode);
+ [Throws, BinaryName="setStartAfterJS"]
+ undefined setStartAfter(Node refNode);
+ [Throws, BinaryName="setEndBeforeJS"]
+ undefined setEndBefore(Node refNode);
+ [Throws, BinaryName="setEndAfterJS"]
+ undefined setEndAfter(Node refNode);
+ [BinaryName="collapseJS"]
+ undefined collapse(optional boolean toStart = false);
+ [Throws, BinaryName="selectNodeJS"]
+ undefined selectNode(Node refNode);
+ [Throws, BinaryName="selectNodeContentsJS"]
+ undefined selectNodeContents(Node refNode);
+
+ const unsigned short START_TO_START = 0;
+ const unsigned short START_TO_END = 1;
+ const unsigned short END_TO_END = 2;
+ const unsigned short END_TO_START = 3;
+ [Throws]
+ short compareBoundaryPoints(unsigned short how, Range sourceRange);
+ [CEReactions, Throws]
+ undefined deleteContents();
+ [CEReactions, Throws]
+ DocumentFragment extractContents();
+ [CEReactions, Throws]
+ DocumentFragment cloneContents();
+ [CEReactions, Throws]
+ undefined insertNode(Node node);
+ [CEReactions, Throws]
+ undefined surroundContents(Node newParent);
+
+ Range cloneRange();
+ undefined detach();
+
+ [Throws]
+ boolean isPointInRange(Node node, unsigned long offset);
+ [Throws]
+ short comparePoint(Node node, unsigned long offset);
+
+ [Throws]
+ boolean intersectsNode(Node node);
+
+ [Throws, BinaryName="ToString"]
+ stringifier;
+};
+
+// http://domparsing.spec.whatwg.org/#dom-range-createcontextualfragment
+partial interface Range {
+ [CEReactions, Throws, UseCounter]
+ DocumentFragment createContextualFragment(DOMString fragment);
+};
+
+// http://dvcs.w3.org/hg/csswg/raw-file/tip/cssom-view/Overview.html#extensions-to-the-range-interface
+partial interface Range {
+ DOMRectList? getClientRects();
+ DOMRect getBoundingClientRect();
+};
+
+dictionary ClientRectsAndTexts {
+ required DOMRectList rectList;
+ required sequence<DOMString> textList;
+};
+
+partial interface Range {
+ [ChromeOnly, Throws]
+ ClientRectsAndTexts getClientRectsAndTexts();
+};