typescript-closure-tools
Version:
Command-line tools to convert closure-style JSDoc annotations to typescript, and to convert typescript sources to closure externs files
92 lines (81 loc) • 4.2 kB
TypeScript
/// <reference path="../../../globals.d.ts" />
/// <reference path="./abstractrange.d.ts" />
declare module goog.dom.Range {
/**
* Create a new selection from the given browser window's current selection.
* Note that this object does not auto-update if the user changes their
* selection and should be used as a snapshot.
* @param {Window=} opt_win The window to get the selection of. Defaults to the
* window this class was defined in.
* @return {goog.dom.AbstractRange?} A range wrapper object, or null if there
* was an error.
*/
function createFromWindow(opt_win?: Window): goog.dom.AbstractRange;
/**
* Create a new range wrapper from the given browser selection object. Note
* that this object does not auto-update if the user changes their selection and
* should be used as a snapshot.
* @param {!Object} selection The browser selection object.
* @return {goog.dom.AbstractRange?} A range wrapper object or null if there
* was an error.
*/
function createFromBrowserSelection(selection: Object): goog.dom.AbstractRange;
/**
* Create a new range wrapper from the given browser range object.
* @param {Range|TextRange} range The browser range object.
* @param {boolean=} opt_isReversed Whether the focus node is before the anchor
* node.
* @return {!goog.dom.AbstractRange} A range wrapper object.
*/
function createFromBrowserRange(range: Range|TextRange, opt_isReversed?: boolean): goog.dom.AbstractRange;
/**
* Create a new range wrapper that selects the given node's text.
* @param {Node} node The node to select.
* @param {boolean=} opt_isReversed Whether the focus node is before the anchor
* node.
* @return {!goog.dom.AbstractRange} A range wrapper object.
*/
function createFromNodeContents(node: Node, opt_isReversed?: boolean): goog.dom.AbstractRange;
/**
* Create a new range wrapper that represents a caret at the given node,
* accounting for the given offset. This always creates a TextRange, regardless
* of whether node is an image node or other control range type node.
* @param {Node} node The node to place a caret at.
* @param {number} offset The offset within the node to place the caret at.
* @return {!goog.dom.AbstractRange} A range wrapper object.
*/
function createCaret(node: Node, offset: number): goog.dom.AbstractRange;
/**
* Create a new range wrapper that selects the area between the given nodes,
* accounting for the given offsets.
* @param {Node} anchorNode The node to anchor on.
* @param {number} anchorOffset The offset within the node to anchor on.
* @param {Node} focusNode The node to focus on.
* @param {number} focusOffset The offset within the node to focus on.
* @return {!goog.dom.AbstractRange} A range wrapper object.
*/
function createFromNodes(anchorNode: Node, anchorOffset: number, focusNode: Node, focusOffset: number): goog.dom.AbstractRange;
/**
* Clears the window's selection.
* @param {Window=} opt_win The window to get the selection of. Defaults to the
* window this class was defined in.
*/
function clearSelection(opt_win?: Window): void;
/**
* Tests if the window has a selection.
* @param {Window=} opt_win The window to check the selection of. Defaults to
* the window this class was defined in.
* @return {boolean} Whether the window has a selection.
*/
function hasSelection(opt_win?: Window): boolean;
/**
* Returns whether the focus position occurs before the anchor position.
* @param {Node} anchorNode The node to anchor on.
* @param {number} anchorOffset The offset within the node to anchor on.
* @param {Node} focusNode The node to focus on.
* @param {number} focusOffset The offset within the node to focus on.
* @return {boolean} Whether the focus position occurs before the anchor
* position.
*/
function isReversed(anchorNode: Node, anchorOffset: number, focusNode: Node, focusOffset: number): boolean;
}