Interface nsIFindType

Hierarchy

Properties

caseSensitive entireWord findBackwards matchDiacritics

Methods

AddRef Find QueryInterface Release

Properties

caseSensitive

caseSensitive: boolean

entireWord

entireWord: boolean

findBackwards

findBackwards: boolean

matchDiacritics

matchDiacritics: boolean

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

Find

  • Find some text in the current context. The implementation is responsible for performing the find and highlighting the text.

    Retval

    A range spanning the match that was found (or null).

    Parameters

    • aPatText: string

      The text to search for.

    • aSearchRange: Range

      A Range specifying domain of search.

    • aStartPoint: Range

      A Range specifying search start point. If not collapsed, we'll start from end (forward) or start (backward).

    • aEndPoint: Range

      A Range specifying search end point. If not collapsed, we'll end at end (forward) or start (backward).

    Returns Range

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

Settings

Member Visibility

Theme

Generated using TypeDoc