Back to index

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

import "nsIFind.idl";

Inheritance diagram for nsIFind:
Inheritance graph
[legend]
Collaboration diagram for nsIFind:
Collaboration graph
[legend]

List of all members.

Public Member Functions

nsIDOMRange Find (in wstring aPatText, in nsIDOMRange aSearchRange, in nsIDOMRange aStartPoint, in nsIDOMRange aEndPoint)
 Find some text in the current context.

Public Attributes

attribute boolean findBackwards
attribute boolean caseSensitive
attribute nsIWordBreaker wordBreaker
 Use "find entire words" mode by setting to a word breaker or null, to disable "entire words" mode.

Detailed Description

Definition at line 45 of file nsIFind.idl.


Member Function Documentation

nsIDOMRange nsIFind::Find ( in wstring  aPatText,
in nsIDOMRange  aSearchRange,
in nsIDOMRange  aStartPoint,
in nsIDOMRange  aEndPoint 
)

Find some text in the current context.

The implementation is responsible for performing the find and highlighting the text.

Parameters:
aPatTextThe text to search for.
aSearchRangeA Range specifying domain of search.
aStartPointA Range specifying search start point. If not collapsed, we'll start from end (forward) or start (backward). May be null; if so, we'll start at the start (forward) or end (back) of aSearchRange.
aEndPointA Range specifying search end point. If not collapsed, we'll end at end (forward) or start (backward). May be null; if so, we'll end at the end (forward) or start (back) of aSearchRange.
Return values:
Arange spanning the match that was found (or null).

Member Data Documentation

Definition at line 48 of file nsIFind.idl.

Definition at line 47 of file nsIFind.idl.

Use "find entire words" mode by setting to a word breaker or null, to disable "entire words" mode.

Definition at line 54 of file nsIFind.idl.


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