embedding/components/find/public/nsIFind.idl@6474c204b198 (annotated)
embedding/components/find/public/nsIFind.idl
Wed, 31 Dec 2014 06:09:35 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Wed, 31 Dec 2014 06:09:35 +0100
- changeset 0
- 6474c204b198
- permissions
- -rw-r--r--
Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.
| michael@0 | 1 | /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ |
| michael@0 | 2 | /* This Source Code Form is subject to the terms of the Mozilla Public |
| michael@0 | 3 | * License, v. 2.0. If a copy of the MPL was not distributed with this |
| michael@0 | 4 | * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ |
| michael@0 | 5 | |
| michael@0 | 6 | #include "nsISupports.idl" |
| michael@0 | 7 | |
| michael@0 | 8 | interface nsIDOMRange; |
| michael@0 | 9 | interface nsIWordBreaker; |
| michael@0 | 10 | |
| michael@0 | 11 | [scriptable, uuid(75125d55-37ee-4575-b9b5-f33bfa68c2a1)] |
| michael@0 | 12 | interface nsIFind : nsISupports |
| michael@0 | 13 | { |
| michael@0 | 14 | attribute boolean findBackwards; |
| michael@0 | 15 | attribute boolean caseSensitive; |
| michael@0 | 16 | |
| michael@0 | 17 | /** |
| michael@0 | 18 | * Use "find entire words" mode by setting to a word breaker |
| michael@0 | 19 | * or null, to disable "entire words" mode. |
| michael@0 | 20 | */ |
| michael@0 | 21 | [noscript] attribute nsIWordBreaker wordBreaker; |
| michael@0 | 22 | |
| michael@0 | 23 | /** |
| michael@0 | 24 | * Find some text in the current context. The implementation is |
| michael@0 | 25 | * responsible for performing the find and highlighting the text. |
| michael@0 | 26 | * |
| michael@0 | 27 | * @param aPatText The text to search for. |
| michael@0 | 28 | * @param aSearchRange A Range specifying domain of search. |
| michael@0 | 29 | * @param aStartPoint A Range specifying search start point. |
| michael@0 | 30 | * If not collapsed, we'll start from |
| michael@0 | 31 | * end (forward) or start (backward). |
| michael@0 | 32 | * @param aEndPoint A Range specifying search end point. |
| michael@0 | 33 | * If not collapsed, we'll end at |
| michael@0 | 34 | * end (forward) or start (backward). |
| michael@0 | 35 | * @retval A range spanning the match that was found (or null). |
| michael@0 | 36 | */ |
| michael@0 | 37 | nsIDOMRange Find(in wstring aPatText, in nsIDOMRange aSearchRange, |
| michael@0 | 38 | in nsIDOMRange aStartPoint, in nsIDOMRange aEndPoint); |
| michael@0 | 39 | }; |
