Method overview

Attributes

Constants

Methods

addSelectionListener()

void addSelectionListener(
  in nsISelectionListener newListener
);

Parameters

newListener

 

endBatchChanges()

Will resume User Interface updates after a previous call to startBatchChanges().

void endBatchChanges();

Parameters

None.

Returns cached value for nsTextFrame::GetPointFromOffset.

void getCachedFrameOffset(
  in nsIFrame aFrame,
  in PRInt32 inOffset,
  in nsPointRef aPoint
);

Parameters

aFrame

 

inOffset

 

aPoint

 

getEnumerator()

nsIEnumerator getEnumerator();

Parameters

None.

Return value

nsFrameSelection getFrameSelection();

Parameters

None.

Return value

A reference to the frame selection associated with this selection.

GetRangesForInterval()

Return array of ranges intersecting with the given DOM interval.

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
);

Parameters

beginNode

 

beginOffset

 

endNode

 

endOffset

These four parameters represent the range to compare against the selection.

allowAdjacent

Specifies whether the returned ranges are allowed to touch the input range rather than merely overlapping it.

resultCount

Returns the number of ranges that overlap (or touch) the input range.

results

Returns the ranges that overlap (or touch) the input range.

This method became obsolete in Gecko 12.0 (Firefox 12.0 / Thunderbird 12.0 / SeaMonkey 2.9). Use GetRangesForIntervalArray() instead.

void GetRangesForIntervalCOMArray(
  in nsIDOMNode beginNode,
  in PRInt32 beginOffset,
  in nsIDOMNode endNode,
  in PRInt32 endOffset,
  in PRBool allowAdjacent,
  in RangeArray results
);

Parameters

beginNode

 

beginOffset

 

endNode

 

endOffset

These four parameters represent the range to compare against the selection.

allowAdjacent

Specifies whether the returned ranges are allowed to touch the input range rather than merely overlapping it.

results

Returns the ranges that overlap (or touch) the input range.

void GetRangesForIntervalArray(
  in nsINode beginNode,
  in PRInt32 beginoffset,
  in nsINode endNode,
  in PRInt32 endOffset,
  in boolean allowAdjacent,
  in RangeArray results
);

Parameters

beginNode

 

beginOffset

 

endNode

 

endOffset

These four parameters represent the range to compare against the selection.

allowAdjacent

Specifies whether the returned ranges are allowed to touch the input range rather than merely overlapping it.

results

Returns the ranges that overlap (or touch) the input range.

getTableSelectionType()

Test if supplied range points to a single table element.

long getTableSelectionType(
  in nsIDOMRange range
);

Parameters

range

 

Return value

One of TABLESELECTION_* constants. "None" means a table element is not selected.

removeSelectionListener()

void removeSelectionListener(
  in nsISelectionListener listenerToRemove
);

Parameters

listenerToRemove

 

scrollIntoView()

Scrolls a region of the selection, so that it is visible in the scrolled view.

void scrollIntoView(
  in short aRegion,
  in boolean aIsSynchronous,
  in short aVPercent,
  in short aHPercent
);

Parameters

aRegion

The region inside the selection to scroll into view (see selection region constants defined in nsISelectionController).

aIsSynchronous

When true, scrolls the selection into view before returning. If false, posts a request which is processed at some point after the method returns.

aVPercent

How to align the frame vertically. A value of 0 means the frame's upper edge is aligned with the top edge of the visible area. A value of 100 means the frame's bottom edge is aligned with the bottom edge of the visible area. For values in between, the point "aVPercent" down the frame is placed at the point "aVPercent" down the visible area. A value of 50 centers the frame vertically. A value of -1 means move the frame the minimum amount necessary in order for the entire frame to be visible vertically (if possible).

aHPercent

How to align the frame horizontally. A value of 0 means the frame's left edge is aligned with the left edge of the visible area. A value of 100 means the frame's right edge is aligned with the right edge of the visible area. For values in between, the point "aHPercent" across the frame is placed at the point "aHPercent" across the visible area. A value of 50 centers the frame horizontally . A value of -1 means move the frame the minimum amount necessary in order for the entire frame to be visible horizontally (if possible).

void setAncestorLimiter(
  in nsIContent aContent
);

Parameters

aContent

 

Internal utility method to set the pres shell on a newly created selection.

void setPresShell(
  in nsIPresShell aPresShell
);

Parameters

aPresShell

 

Set the painting style for the range. The range must be a range in the selection. The textRangeStyle will be used by text frame when it is painting the selection.

void setTextRangeStyle(
  in nsIDOMRange range,
  in constTextRangeStyleRef textRangeStyle
);

Parameters

range

 

textRangeStyle

 

startBatchChanges()

Will stop User Interface updates while multiple selection methods are called. Call endBatchChanges() to resume User Interface updates.

void startBatchChanges();

Parameters

None.

toStringWithFormat()

wstring toStringWithFormat(
  in string formatType,
  in unsigned long flags,
  in PRInt32 wrapColumn
);

Parameters

formatType

 

flags

 

wrapColumn

 

Return value