Interface nsIWebBrowserFindInFramesType

nsIWebBrowserFindInFrames

Controls how find behaves when multiple frames or iframes are present.

Get by doing a QueryInterface from nsIWebBrowserFind.

Hierarchy

Properties

currentSearchFrame: mozIDOMWindowProxy

currentSearchFrame

Frame at which to start the search. Once the search is done, this will be set to be the last frame searched, whether or not a result was found. Has to be equal to or contained within the rootSearchFrame.

rootSearchFrame: mozIDOMWindowProxy

rootSearchFrame

Frame within which to confine the search (normally the content area frame). Set this to only search a subtree of the frame hierarchy.

searchParentFrames: boolean

searchParentFrames

Whether to allow the search to propagate out of the currentSearchFrame into its parent frame(s). Search is always confined within the rootSearchFrame. Default is true.

Setting nsIWebBrowserfind.searchFrames to true sets this to true.

searchSubframes: boolean

searchSubframes

Whether to recurse down into subframes while searching. Default is true.

Setting nsIWebBrowserfind.searchFrames to true sets this to true.

Methods

  • 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

  • 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

  • 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

Generated using TypeDoc