Public Member Functions | Public Attributes

nsISelection Interface Reference

Interface for manipulating and querying the current selected range of nodes within the document. More...

import "nsISelection.idl";

Inheritance diagram for nsISelection:
Collaboration diagram for nsISelection:

List of all members.

Public Member Functions

nsIDOMRange getRangeAt (in long index)
 Returns the range at the specified index.
void collapse (in nsIDOMNode parentNode, in long offset)
 Collapses the selection to a single point, at the specified offset in the given DOM node.
void extend (in nsIDOMNode parentNode, in long offset)
 Extends the selection by moving the selection end to the specified node and offset, preserving the selection begin position.
void collapseToStart ()
 Collapses the whole selection to a single point at the start of the current selection (irrespective of direction).
void collapseToEnd ()
 Collapses the whole selection to a single point at the end of the current selection (irrespective of direction).
boolean containsNode (in nsIDOMNode node, in boolean partlyContained)
 Indicates whether the node is part of the selection.
void selectAllChildren (in nsIDOMNode parentNode)
 Adds all children of the specified node to the selection.
void addRange (in nsIDOMRange range)
 Adds a range to the current selection.
void removeRange (in nsIDOMRange range)
 Removes a range from the current selection.
void removeAllRanges ()
 Removes all ranges from the current selection.
void deleteFromDocument ()
 Deletes this selection from document the nodes belong to.
void selectionLanguageChange (in boolean langRTL)
 Modifies the cursor Bidi level after a change in keyboard direction.
wstring toString ()
 Returns the whole selection into a plain text string.

Public Attributes

readonly attribute nsIDOMNode anchorNode
 Returns the node in which the selection begins.
readonly attribute long anchorOffset
 The offset within the (text) node where the selection begins.
readonly attribute nsIDOMNode focusNode
 Returns the node in which the selection ends.
readonly attribute long focusOffset
 The offset within the (text) node where the selection ends.
readonly attribute boolean isCollapsed
 Indicates if the selection is collapsed or not.
readonly attribute long rangeCount
 Returns the number of ranges in the selection.

Detailed Description

Interface for manipulating and querying the current selected range of nodes within the document.

Status:
FROZEN
Version:
1.0

Member Function Documentation

void nsISelection::addRange ( in nsIDOMRange  range  ) 

Adds a range to the current selection.

void nsISelection::collapse ( in nsIDOMNode  parentNode,
in long  offset 
)

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.

Parameters:
parentNode The given dom node where the selection will be set
offset Where in given dom node to place the selection (the offset into the given node)
void nsISelection::collapseToEnd (  ) 

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 nsISelection::collapseToStart (  ) 

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.

boolean nsISelection::containsNode ( in nsIDOMNode  node,
in boolean  partlyContained 
)

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.

void nsISelection::deleteFromDocument (  ) 

Deletes this selection from document the nodes belong to.

void nsISelection::extend ( in nsIDOMNode  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.

Parameters:
parentNode The node where the selection will be extended to
offset Where in node to place the offset in the new selection end
nsIDOMRange nsISelection::getRangeAt ( in long  index  ) 

Returns the range at the specified index.

void nsISelection::removeAllRanges (  ) 

Removes all ranges from the current selection.

void nsISelection::removeRange ( in nsIDOMRange  range  ) 

Removes a range from the current selection.

void nsISelection::selectAllChildren ( in nsIDOMNode  parentNode  ) 

Adds all children of the specified node to the selection.

Parameters:
parentNode the parent of the children to be added to the selection.
void nsISelection::selectionLanguageChange ( in boolean  langRTL  ) 

Modifies the cursor Bidi level after a change in keyboard direction.

Parameters:
langRTL is PR_TRUE if the new language is right-to-left or PR_FALSE if the new language is left-to-right.
wstring nsISelection::toString (  ) 

Returns the whole selection into a plain text string.


Member Data Documentation

Returns the node in which the selection begins.

readonly attribute long nsISelection::anchorOffset

The offset within the (text) node where the selection begins.

readonly attribute nsIDOMNode nsISelection::focusNode

Returns the node in which the selection ends.

readonly attribute long nsISelection::focusOffset

The offset within the (text) node where the selection ends.

readonly attribute boolean nsISelection::isCollapsed

Indicates if the selection is collapsed or not.

readonly attribute long nsISelection::rangeCount

Returns the number of ranges in the selection.


The documentation for this interface was generated from the following file: