Interface nsITypeAheadFindType

**************************** nsTypeAheadFind *****************************

Hierarchy

Properties

caseSensitive currentWindow entireWord foundEditable foundLink matchDiacritics searchString

Methods

AddRef QueryInterface Release collapseSelection find getFoundRange init isRangeRendered isRangeVisible setDocShell setSelectionModeAndRepaint

Properties

caseSensitive

caseSensitive: boolean

Readonly currentWindow

currentWindow: mozIDOMWindow

entireWord

entireWord: boolean

Readonly foundEditable

foundEditable: Element

Readonly foundLink

foundLink: Element

matchDiacritics

matchDiacritics: boolean

Readonly searchString

searchString: string

***************************** Attributes *****************************

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

collapseSelection

  • Collapse the "found match" selection to its start. Because not all matches are owned by the same selection controller, this doesn't necessarily happen automatically.

    Returns void

find

  • *************************** Core functions ***************************

    Find aSearchString in page. If aLinksOnly is true, only search the page's hyperlinks for the string.

    Parameters

    • aSearchString: string
    • aLinksOnly: boolean
    • aMode: number
    • aDontIterateFrames: boolean

    Returns number

getFoundRange

  • Return the range of the most recent match.

    Returns Range

init

  • **************************** Initializer *****************************

    Necessary initialization that can't happen in the constructor, either because function calls here may fail, or because the docShell is required.

    Parameters

    • aDocShell: nsIDocShell

    Returns void

isRangeRendered

  • Check if a range is actually rendered (out of viewport always false)

    Parameters

    • aRange: Range

    Returns boolean

isRangeVisible

  • Check if a range is visible using heuristics

    Parameters

    • aRange: Range
    • aMustBeInViewPort: boolean

    Returns boolean

setDocShell

  • ************************** Helper functions **************************

    Change searched docShell. This happens when e.g. we use the same nsITypeAheadFind object to search different tabs.

    Parameters

    • aDocShell: nsIDocShell

    Returns void

setSelectionModeAndRepaint

  • Change the look of the the "found match" selection to aToggle, and repaint the selection.

    Parameters

    • toggle: number

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc