embedding/components/find/public/nsIFind.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Akkana Peck   <akkana@netscape.com>
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #include "nsISupports.idl"
  40
  41 interface nsIDOMRange;
  42 interface nsIWordBreaker;
  43
  44 [scriptable, uuid(75125d55-37ee-4575-b9b5-f33bfa68c2a1)]
  45 interface nsIFind : nsISupports
  46 {
  47   attribute boolean findBackwards;
  48   attribute boolean caseSensitive;
  49
  50   /**
  51    * Use "find entire words" mode by setting to a word breaker
  52    * or null, to disable "entire words" mode.
  53    */
  54   [noscript] attribute nsIWordBreaker wordBreaker;
  55
  56   /**
  57    * Find some text in the current context. The implementation is
  58    * responsible for performing the find and highlighting the text.
  59    *
  60    * @param aPatText     The text to search for.
  61    * @param aSearchRange A Range specifying domain of search.
  62    * @param aStartPoint  A Range specifying search start point.
  63    *                     If not collapsed, we'll start from
  64    *                     end (forward) or start (backward).
  65    * @param aEndPoint    A Range specifying search end point.
  66    *                     If not collapsed, we'll end at
  67    *                     end (forward) or start (backward).
  68    * @retval             A range spanning the match that was found (or null).
  69    */
  70   nsIDOMRange Find(in wstring aPatText, in nsIDOMRange aSearchRange,
  71                    in nsIDOMRange aStartPoint, in nsIDOMRange aEndPoint);
  72 };