Interface nsISelectionControllerType

Hierarchy

Properties

caretVisible

Methods

AddRef QueryInterface Release characterMove completeMove completeScroll getCaretEnabled getDOMSelection getDisplaySelection getSelection getSelectionFlags intraLineMove lineMove pageMove physicalMove repaintSelection scrollCharacter scrollLine scrollPage scrollSelectionIntoView selectionWillLoseFocus selectionWillTakeFocus setCaretEnabled setCaretReadOnly setCaretVisibilityDuringSelection setDisplaySelection setSelectionFlags wordMove

Properties

Readonly caretVisible

caretVisible: boolean

This is true if the caret is enabled, visible, and currently blinking. This is still true when the caret is enabled, visible, but in its "off" blink cycle.

Methods

AddRef

  • Increases the reference count for this interface. The associated instance will not be deleted unless the reference count is returned to zero.

    Returns

    The resulting reference count.

    Returns number

QueryInterface

  • Parameters

    • aIID: object
    • Optional aInstancePtr: object

    Returns any

  • A run time mechanism for interface discovery.

    Returns

    NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.

    aInstancePtr must not be null.

    Parameters

    • aIID: object

      [in] A requested interface IID

    • aInstancePtr: object

      [out] A pointer to an interface pointer to receive the result.

    Returns void

Release

  • Decreases the reference count for this interface. Generally, if the reference count returns to zero, the associated instance is deleted.

    Returns

    The resulting reference count.

    Returns number

characterMove

  • 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

    • forward: boolean
    • extend: boolean

    Returns void

completeMove

  • 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

    • forward: boolean
    • extend: boolean

    Returns void

completeScroll

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

    Parameters

    • forward: boolean

    Returns void

getCaretEnabled

  • Gets the current state of the caret.

    Returns

    if aOutEnabled==null, returns NS_ERROR_INVALID_ARG else NS_OK

    Returns boolean

getDOMSelection

  • Return the selection object corresponding to a selection type.

    Parameters

    • aType: number

    Returns Selection

getDisplaySelection

  • GetDisplaySelection will get the display mode for the selection. OFF,ON,DISABLED

    Returns number

getSelection

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

    Parameters

    • type: number

    Returns Selection

getSelectionFlags

  • GetSelectionFlags used to get whether you want to see HRULES/IMAGES with border. also used to tell if the presshell is an editor right now. this should change

    Returns number

intraLineMove

  • 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

    • forward: boolean
    • extend: boolean

    Returns void

lineMove

  • 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

    • forward: boolean
    • extend: boolean

    Returns void

pageMove

  • 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

    • forward: boolean
    • extend: boolean

    Returns void

physicalMove

  • PhysicalMove will move the selection one "unit" in a given direction within 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

    • direction: number
    • amount: number
    • extend: boolean

    Returns void

repaintSelection

  • RepaintSelection repaints the selection specified by aType.

    Parameters

    • type: number

    Returns void

scrollCharacter

  • ScrollCharacter will scroll right or left dependent on the boolean

    Parameters

    • right: boolean

    Returns void

scrollLine

  • ScrollLine will scroll line up or down dependent on the boolean

    Parameters

    • forward: boolean

    Returns void

scrollPage

  • ScrollPage will scroll the page without affecting the selection.

    Parameters

    • forward: boolean

    Returns void

scrollSelectionIntoView

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

    Parameters

    • type: number
    • region: number
    • flags: number

    Returns void

selectionWillLoseFocus

  • Called when the selection controller has lost the focus.

    This will take care to hide and repaint the selection.

    Returns void

selectionWillTakeFocus

  • Called when the selection controller should take the focus.

    This will take care to hide the previously-focused selection, show this selection, and repaint both.

    Returns void

setCaretEnabled

  • 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.

    Returns

    always NS_OK

    Parameters

    • enabled: boolean

    Returns void

setCaretReadOnly

  • Set the caret readonly or not. An readonly caret will draw but not blink when made visible.

    Returns

    always NS_OK

    Parameters

    • readOnly: boolean

    Returns void

setCaretVisibilityDuringSelection

  • 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.

    Returns

    always NS_OK

    Parameters

    • visibility: boolean

    Returns void

setDisplaySelection

  • SetDisplaySelection will set the display mode for the selection. OFF,ON,DISABLED

    Parameters

    • toggle: number

    Returns void

setSelectionFlags

  • SetSelectionFlags used to set whether you want to see HRULES/IMAGES with border. also used to tell if the presshell is an editor right now. this should change

    Parameters

    • toggle: number

    Returns void

wordMove

  • 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

    • forward: boolean
    • extend: boolean

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc