Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsISelection2 Interface Reference

import "nsISelection2.idl";

Inheritance diagram for nsISelection2:
Inheritance graph
[legend]
Collaboration diagram for nsISelection2:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void GetRangesForInterval (in nsIDOMNode beginNode, in PRInt32 beginOffset, in nsIDOMNode endNode, in PRInt32 endOffset, in PRBool allowAdjacent, out PRUint32 resultCount,[retval, array, size_is(resultCount)] out nsIDOMRange results)
void GetRangesForIntervalCOMArray (in nsIDOMNode beginNode, in PRInt32 beginOffset, in nsIDOMNode endNode, in PRInt32 endOffset, in PRBool allowAdjacent, in RangeArray results)
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 focus to the specified node and offset, preserving the anchor postion.
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 entirelyContained)
 The value of entirelyContained determines the detail of the search to determine if the selection contains the node.
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
 The node representing one end of the selection.
readonly attribute long anchorOffset
 The offset within the (text) node where the selection begins.
readonly attribute nsIDOMNode focusNode
 The node with keyboard focus.
readonly attribute long focusOffset
 The offset within the (text) node where focus starts.
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

Definition at line 52 of file nsISelection2.idl.


Member Function Documentation

void nsISelection::addRange ( in nsIDOMRange  range) [inherited]

Adds a range to the current selection.

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

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:
parentNodeThe given dom node where the selection will be set
offsetWhere in given dom node to place the selection (the offset into the given node)

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.

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  entirelyContained 
) [inherited]

The value of entirelyContained determines the detail of the search to determine if the selection contains the node.

If entirelyContained is set to PR_TRUE, t or false if

Parameters:
nodeThe node where the selection will be extended to
entirelyContainedWhether

Deletes this selection from document the nodes belong to.

void nsISelection::extend ( in nsIDOMNode  parentNode,
in long  offset 
) [inherited]

Extends the selection by moving the focus to the specified node and offset, preserving the anchor postion.

The new selection end result will always be from the anchor to the new focus, regardless of direction.

Parameters:
parentNodeThe node where the selection will be extended to
offsetWhere in node to place the offset in the new focused node
nsIDOMRange nsISelection::getRangeAt ( in long  index) [inherited]

Returns the range at the specified index.

void nsISelection2::GetRangesForInterval ( in nsIDOMNode  beginNode,
in PRInt32  beginOffset,
in nsIDOMNode  endNode,
in PRInt32  endOffset,
in PRBool  allowAdjacent,
out PRUint32  resultCount,
[retval, array, size_is(resultCount)] out nsIDOMRange  results 
)
void nsISelection2::GetRangesForIntervalCOMArray ( in nsIDOMNode  beginNode,
in PRInt32  beginOffset,
in nsIDOMNode  endNode,
in PRInt32  endOffset,
in PRBool  allowAdjacent,
in RangeArray  results 
)

Here is the caller graph for this function:

Removes all ranges from the current selection.

void nsISelection::removeRange ( in nsIDOMRange  range) [inherited]

Removes a range from the current selection.

void nsISelection::selectAllChildren ( in nsIDOMNode  parentNode) [inherited]

Adds all children of the specified node to the selection.

Parameters:
parentNodethe parent of the children to be added to the selection.

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

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

Returns the whole selection into a plain text string.


Member Data Documentation

The node representing one end of the selection.

Definition at line 59 of file nsISelection.idl.

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

Definition at line 64 of file nsISelection.idl.

The node with keyboard focus.

Definition at line 69 of file nsISelection.idl.

The offset within the (text) node where focus starts.

Definition at line 74 of file nsISelection.idl.

Indicates if the selection is collapsed or not.

Definition at line 79 of file nsISelection.idl.

readonly attribute long nsISelection::rangeCount [inherited]

Returns the number of ranges in the selection.

Definition at line 84 of file nsISelection.idl.


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