Interface nsIAutoCompleteSimpleSearchType

Simple interface that allows the results of the next search to be overridden.

Hierarchy

Methods

AddRef QueryInterface Release overrideNextResult startSearch stopSearch

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

overrideNextResult

  • Sets the result that should be used next time startSearch is called.

    Parameters

    • values: nsIAutoCompleteResult

    Returns void

startSearch

  • Search for a given string and notify a listener (either synchronously or asynchronously) of the result

    Parameters

    • searchString: string

      The string to search for

    • searchParam: string

      An extra parameter

    • previousResult: nsIAutoCompleteResult

      A previous result to use for faster searching

    • listener: nsIAutoCompleteObserver

      A listener to notify when the search is complete

    • options: nsIPropertyBag2

      An optional set of additional search parameters that may be passed to the underlying implementation.

    Returns void

stopSearch

Settings

Member Visibility

Theme

Generated using TypeDoc