Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsIWebBrowserFind Interface Reference

nsIWebBrowserFind More...

import "nsIWebBrowserFind.idl";

Inheritance diagram for nsIWebBrowserFind:
Inheritance graph
Collaboration diagram for nsIWebBrowserFind:
Collaboration graph

List of all members.

Public Member Functions

boolean findNext ()

Public Attributes

attribute wstring searchString
attribute boolean findBackwards
attribute boolean wrapFind
attribute boolean entireWord
attribute boolean matchCase
attribute boolean searchFrames

Detailed Description


Searches for text in a web browser.

Get one by doing a GetInterface on an nsIWebBrowser.

By default, the implementation will search the focussed frame, or if there is no focussed frame, the web browser content area. It does not by default search subframes or iframes. To change this behaviour, and to explicitly set the frame to search, QueryInterface to nsIWebBrowserFindInFrames.


Definition at line 64 of file nsIWebBrowserFind.idl.

Member Function Documentation


Finds, highlights, and scrolls into view the next occurrence of the search string, using the current search settings. Fails if the search string is empty.

Whether an occurrence was found

Member Data Documentation


Whether to match entire words only. Default is false.

Definition at line 107 of file nsIWebBrowserFind.idl.


Whether to find backwards (towards the beginning of the document). Default is false (search forward).

Definition at line 90 of file nsIWebBrowserFind.idl.


Whether to match case (case sensitive) when searching. Default is false.

Definition at line 114 of file nsIWebBrowserFind.idl.


Whether to search through all frames in the content area. Default is true.

Note that you can control whether the search propagates into child or parent frames explicitly using nsIWebBrowserFindInFrames, but if one, but not both, of searchSubframes and searchParentFrames are set, this returns false.

Definition at line 126 of file nsIWebBrowserFind.idl.


The string to search for. This must be non-empty to search.

Definition at line 82 of file nsIWebBrowserFind.idl.


Whether the search wraps around to the start (or end) of the document if no match was found between the current position and the end (or beginning). Works correctly when searching backwards. Default is false.

Definition at line 100 of file nsIWebBrowserFind.idl.

The documentation for this interface was generated from the following file: