embedding/components/find/public/nsIFind.idl

changeset 0
6474c204b198
equal deleted inserted replaced
-1:000000000000 0:8b423c2e8b0a
1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2 /* This Source Code Form is subject to the terms of the Mozilla Public
3 * License, v. 2.0. If a copy of the MPL was not distributed with this
4 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
5
6 #include "nsISupports.idl"
7
8 interface nsIDOMRange;
9 interface nsIWordBreaker;
10
11 [scriptable, uuid(75125d55-37ee-4575-b9b5-f33bfa68c2a1)]
12 interface nsIFind : nsISupports
13 {
14 attribute boolean findBackwards;
15 attribute boolean caseSensitive;
16
17 /**
18 * Use "find entire words" mode by setting to a word breaker
19 * or null, to disable "entire words" mode.
20 */
21 [noscript] attribute nsIWordBreaker wordBreaker;
22
23 /**
24 * Find some text in the current context. The implementation is
25 * responsible for performing the find and highlighting the text.
26 *
27 * @param aPatText The text to search for.
28 * @param aSearchRange A Range specifying domain of search.
29 * @param aStartPoint A Range specifying search start point.
30 * If not collapsed, we'll start from
31 * end (forward) or start (backward).
32 * @param aEndPoint A Range specifying search end point.
33 * If not collapsed, we'll end at
34 * end (forward) or start (backward).
35 * @retval A range spanning the match that was found (or null).
36 */
37 nsIDOMRange Find(in wstring aPatText, in nsIDOMRange aSearchRange,
38 in nsIDOMRange aStartPoint, in nsIDOMRange aEndPoint);
39 };

mercurial