From 5f8de423f190bbb79a62f804151bc24824fa32d8 Mon Sep 17 00:00:00 2001 From: "Matt A. Tobin" Date: Fri, 2 Feb 2018 04:16:08 -0500 Subject: Add m-esr52 at 52.6.0 --- dom/base/nsISelection.idl | 170 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 170 insertions(+) create mode 100644 dom/base/nsISelection.idl (limited to 'dom/base/nsISelection.idl') diff --git a/dom/base/nsISelection.idl b/dom/base/nsISelection.idl new file mode 100644 index 000000000..de43521e1 --- /dev/null +++ b/dom/base/nsISelection.idl @@ -0,0 +1,170 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* 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/. */ + +#include "nsISupports.idl" + +/* THIS IS A PUBLIC INTERFACE */ + +interface nsIDOMNode; +interface nsIDOMRange; +interface nsINode; + +%{C++ +namespace mozilla { +namespace dom { +class Selection; +} // namespace dom +} // namespace mozilla +%} + +/** + * Interface for manipulating and querying the current selected range + * of nodes within the document. + * + * @version 1.0 + */ + +[builtinclass, uuid(e0a4d4b3-f34e-44bd-b1f2-4e3bde9b6915)] +interface nsISelection : nsISupports +{ + /** + * Returns the node in which the selection begins. + */ + readonly attribute nsIDOMNode anchorNode; + + /** + * The offset within the (text) node where the selection begins. + */ + readonly attribute long anchorOffset; + + /** + * Returns the node in which the selection ends. + */ + readonly attribute nsIDOMNode focusNode; + + /** + * The offset within the (text) node where the selection ends. + */ + readonly attribute long focusOffset; + + /** + * Indicates if the selection is collapsed or not. + */ + readonly attribute boolean isCollapsed; + [noscript,notxpcom,nostdcall] boolean collapsed(); + + /** + * Returns the number of ranges in the selection. + */ + readonly attribute long rangeCount; + + /** + * Returns the range at the specified index. + */ + nsIDOMRange getRangeAt(in long index); + + /** + * Collapses the selection to a single point, at the specified offset + * in the given DOM node. When the selection is collapsed, and the content + * is focused and editable, the caret will blink there. + * @param parentNode The given dom node where the selection will be set + * @param offset Where in given dom node to place the selection (the offset into the given node) + */ + void collapse(in nsIDOMNode parentNode, in long offset); + [noscript] void collapseNative(in nsINode parentNode, in long offset); + + /** + * Extends the selection by moving the selection end to the specified node and offset, + * preserving the selection begin position. The new selection end result will always + * be from the anchorNode to the new focusNode, regardless of direction. + * @param parentNode The node where the selection will be extended to + * @param offset Where in node to place the offset in the new selection end + */ + void extend(in nsIDOMNode parentNode, in long offset); + [noscript] void extendNative(in nsINode parentNode, in long offset); + + /** + * Collapses the whole selection to a single point at the start + * of the current selection (irrespective of direction). If content + * is focused and editable, the caret will blink there. + */ + void collapseToStart(); + + /** + * Collapses the whole selection to a single point at the end + * of the current selection (irrespective of direction). If content + * is focused and editable, the caret will blink there. + */ + void collapseToEnd(); + + /** + * Indicates whether the node is part of the selection. If partlyContained + * is set to PR_TRUE, the function returns true when some part of the node + * is part of the selection. If partlyContained is set to PR_FALSE, the + * function only returns true when the entire node is part of the selection. + */ + boolean containsNode(in nsIDOMNode node, in boolean partlyContained); + + /** + * Adds all children of the specified node to the selection. + * @param parentNode the parent of the children to be added to the selection. + */ + void selectAllChildren(in nsIDOMNode parentNode); + + /** + * Adds a range to the current selection. + */ + void addRange(in nsIDOMRange range); + + /** + * Removes a range from the current selection. + */ + void removeRange(in nsIDOMRange range); + + /** + * Removes all ranges from the current selection. + */ + void removeAllRanges(); + + /** + * Deletes this selection from document the nodes belong to. + */ + void deleteFromDocument(); + + /** + * Returns the whole selection into a plain text string. + */ + DOMString toString(); + + /** + * Modifies the selection. Note that the parameters are case-insensitive. + * + * @param alter can be one of { "move", "extend" } + * - "move" collapses the selection to the end of the selection and + * applies the movement direction/granularity to the collapsed + * selection. + * - "extend" leaves the start of the selection unchanged, and applies + * movement direction/granularity to the end of the selection. + * @param direction can be one of { "forward", "backward", "left", "right" } + * @param granularity can be one of { "character", "word", + * "line", "lineboundary" } + * + * @returns NS_ERROR_NOT_IMPLEMENTED if the granularity is "sentence", + * "sentenceboundary", "paragraph", "paragraphboundary", or + * "documentboundary". Returns NS_ERROR_INVALID_ARG if alter, direction, + * or granularity has an unrecognized value. + */ + void modify(in DOMString alter, in DOMString direction, + in DOMString granularity); + +%{C++ + /** + * AsSelection() returns a pointer to Selection class if the instance is + * derived from it. Otherwise, nullptr but it should never happen + * since Selection is the only class implementing nsISelection. + */ + virtual mozilla::dom::Selection* AsSelection() = 0; +%} +}; -- cgit v1.2.3