Back to index

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

import "nsISelectionController.idl";

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

List of all members.

Public Member Functions

void setDisplaySelection (in short toggle)
 SetDisplaySelection will set the display mode for the selection.
short getDisplaySelection ()
 GetDisplaySelection will get the display mode for the selection.
nsISelection getSelection (in short type)
 GetSelection will return the selection that the presentation shell may implement.
void scrollSelectionIntoView (in short type, in short region, in boolean isSynchronous)
 ScrollSelectionIntoView scrolls a region of the selection, so that it is visible in the scrolled view.
void repaintSelection (in short type)
 RepaintSelection repaints the selection specified by aType.
void setCaretEnabled (in boolean enabled)
 Set the caret as enabled or disabled.
void setCaretReadOnly (in boolean readOnly)
 Set the caret readonly or not.
boolean getCaretEnabled ()
 Gets the current state of the caret.
void setCaretVisibilityDuringSelection (in boolean visibility)
 Show the caret even in selections.
void characterMove (in boolean forward, in boolean extend)
 CharacterMove will move the selection one character forward/backward in the document.
void wordMove (in boolean forward, in boolean extend)
 WordMove will move the selection one word forward/backward in the document.
void lineMove (in boolean forward, in boolean extend)
 LineMove will move the selection one line forward/backward in the document.
void intraLineMove (in boolean forward, in boolean extend)
 IntraLineMove will move the selection to the front of the line or end of the line in the document.
void pageMove (in boolean forward, in boolean extend)
 PageMove will move the selection one page forward/backward in the document.
void completeScroll (in boolean forward)
 CompleteScroll will move page view to the top or bottom of the document.
void completeMove (in boolean forward, in boolean extend)
 CompleteMove will move page view to the top or bottom of the document this will also have the effect of collapsing the selection if the aExtend = PR_FALSE the "point" of selection that is extended is considered the "focus" point.
void scrollPage (in boolean forward)
 ScrollPage will scroll the page without affecting the selection.
void scrollLine (in boolean forward)
 ScrolLine will scroll line up or down dependent on the boolean.
void scrollHorizontal (in boolean left)
 ScrolHorizontal will scroll left or right dependent on the boolean.
void selectAll ()
 SelectAll will select the whole page.
boolean checkVisibility (in nsIDOMNode node, in short startOffset, in short endOffset)
 CheckVisibility will return true if textnode and offsets are actually rendered in the current precontext.
void setSelectionFlags (in short toggle)
short getSelectionFlags ()

Public Attributes

const short SELECTION_NONE = 0
const short SELECTION_NORMAL = 1
const short SELECTION_SPELLCHECK = 2
const short SELECTION_IME_RAWINPUT = 4
const short SELECTION_IME_SELECTEDRAWTEXT = 8
const short SELECTION_IME_CONVERTEDTEXT = 16
const short SELECTION_IME_SELECTEDCONVERTEDTEXT = 32
const short SELECTION_ACCESSIBILITY = 64
const short NUM_SELECTIONTYPES = 8
const short SELECTION_ANCHOR_REGION = 0
const short SELECTION_FOCUS_REGION = 1
const short NUM_SELECTION_REGIONS = 2
const short SELECTION_OFF = 0
const short SELECTION_HIDDEN = 1
const short SELECTION_ON = 2
const short SELECTION_DISABLED = 3
const short SELECTION_ATTENTION = 4
const short DISPLAY_TEXT = 1
const short DISPLAY_IMAGES = 2
const short DISPLAY_FRAMES = 4
const short DISPLAY_ALL = 7

Detailed Description

Definition at line 55 of file nsISelectionController.idl.


Member Function Documentation

CharacterMove will move the selection one character forward/backward in the document.

this will also have the effect of collapsing the selection if the aExtend = PR_FALSE the "point" of selection that is extended is considered the "focus" point. or the last point adjusted by the selection.

Parameters:
aForwardforward or backward if PR_FALSE
aExtendshould it collapse the selection of extend it?
boolean nsISelectionController::checkVisibility ( in nsIDOMNode  node,
in short  startOffset,
in short  endOffset 
)

CheckVisibility will return true if textnode and offsets are actually rendered in the current precontext.

Parameters:
aNodetextNode to test
aStartOffsetoffset in dom to first char of textnode to test
aEndOffsetoffset in dom to last char of textnode to test
aReturnBoolboolean returned TRUE if visible FALSE if not

CompleteMove will move page view to the top or bottom of the document this will also have the effect of collapsing the selection if the aExtend = PR_FALSE the "point" of selection that is extended is considered the "focus" point.

or the last point adjusted by the selection.

Parameters:
aForwardforward or backward if PR_FALSE
aExtendshould it collapse the selection of extend it?

CompleteScroll will move page view to the top or bottom of the document.

Parameters:
aForwardforward or backward if PR_FALSE

Gets the current state of the caret.

Parameters:
aEnabled[OUT] set to the current caret state, as set by SetCaretEnabled
Returns:
if aOutEnabled==null, returns NS_ERROR_INVALID_ARG else NS_OK

GetDisplaySelection will get the display mode for the selection.

OFF,ON,DISABLED

GetSelection will return the selection that the presentation shell may implement.

Parameters:
aTypewill hold the type of selection //SelectionType
_returnwill hold the return value

IntraLineMove will move the selection to the front of the line or end of the line in the document.

this will also have the effect of collapsing the selection if the aExtend = PR_FALSE the "point" of selection that is extended is considered the "focus" point. or the last point adjusted by the selection.

Parameters:
aForwardforward or backward if PR_FALSE
aExtendshould it collapse the selection of extend it?

LineMove will move the selection one line forward/backward in the document.

this will also have the effect of collapsing the selection if the aExtend = PR_FALSE the "point" of selection that is extended is considered the "focus" point. or the last point adjusted by the selection.

Parameters:
aForwardforward or backward if PR_FALSE
aExtendshould it collapse the selection of extend it?

PageMove will move the selection one page forward/backward in the document.

this will also have the effect of collapsing the selection if the aExtend = PR_FALSE the "point" of selection that is extended is considered the "focus" point. or the last point adjusted by the selection.

Parameters:
aForwardforward or backward if PR_FALSE
aExtendshould it collapse the selection of extend it?

RepaintSelection repaints the selection specified by aType.

Parameters:
aTypespecifies the selection to repaint.

ScrolHorizontal will scroll left or right dependent on the boolean.

Parameters:
aLeftif true will scroll left. if not will scroll right.

ScrolLine will scroll line up or down dependent on the boolean.

Parameters:
aForwardscroll forward or backwards in selection

ScrollPage will scroll the page without affecting the selection.

Parameters:
aForwardscroll forward or backwards in selection
void nsISelectionController::scrollSelectionIntoView ( in short  type,
in short  region,
in boolean  isSynchronous 
)

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

Parameters:
aTypethe selection to scroll into view. //SelectionType
aRegionthe region inside the selection to scroll into view. //SelectionRegion
aIsSynchronouswhen true, scrolls the selection into view before returning. If false, posts a request which is processed at some point after the method returns.

SelectAll will select the whole page.

Set the caret as enabled or disabled.

An enabled caret will draw or blink when made visible. A disabled caret will never show up. Can be called any time.

Parameters:
aEnablePR_TRUE to enable caret. PR_FALSE to disable.
Returns:
always NS_OK

Set the caret readonly or not.

An readonly caret will draw but not blink when made visible.

Parameters:
aReadOnlyPR_TRUE to enable caret. PR_FALSE to disable.
Returns:
always NS_OK

Show the caret even in selections.

By default the caret is hidden unless the selection is collapsed. Use this function to show the caret even in selections.

Parameters:
aVisibilityPR_TRUE to show the caret in selections. PR_FALSE to hide.
Returns:
always NS_OK

SetDisplaySelection will set the display mode for the selection.

OFF,ON,DISABLED

void nsISelectionDisplay::setSelectionFlags ( in short  toggle) [inherited]

WordMove will move the selection one word forward/backward in the document.

this will also have the effect of collapsing the selection if the aExtend = PR_FALSE the "point" of selection that is extended is considered the "focus" point. or the last point adjusted by the selection.

Parameters:
aForwardforward or backward if PR_FALSE
aExtendshould it collapse the selection of extend it?

Member Data Documentation

const short nsISelectionDisplay::DISPLAY_ALL = 7 [inherited]

Definition at line 47 of file nsISelectionDisplay.idl.

Definition at line 46 of file nsISelectionDisplay.idl.

Definition at line 45 of file nsISelectionDisplay.idl.

Definition at line 44 of file nsISelectionDisplay.idl.

Definition at line 69 of file nsISelectionController.idl.

Definition at line 65 of file nsISelectionController.idl.

Definition at line 64 of file nsISelectionController.idl.

Definition at line 67 of file nsISelectionController.idl.

Definition at line 75 of file nsISelectionController.idl.

Definition at line 74 of file nsISelectionController.idl.

Definition at line 68 of file nsISelectionController.idl.

Definition at line 72 of file nsISelectionController.idl.

Definition at line 62 of file nsISelectionController.idl.

Definition at line 60 of file nsISelectionController.idl.

Definition at line 63 of file nsISelectionController.idl.

Definition at line 61 of file nsISelectionController.idl.

Definition at line 57 of file nsISelectionController.idl.

Definition at line 58 of file nsISelectionController.idl.

Definition at line 71 of file nsISelectionController.idl.

Definition at line 73 of file nsISelectionController.idl.

Definition at line 59 of file nsISelectionController.idl.


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