embedding/components/find/public/nsIFind.idl

changeset 0
6474c204b198
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/embedding/components/find/public/nsIFind.idl	Wed Dec 31 06:09:35 2014 +0100
     1.3 @@ -0,0 +1,39 @@
     1.4 +/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
     1.5 +/* This Source Code Form is subject to the terms of the Mozilla Public
     1.6 + * License, v. 2.0. If a copy of the MPL was not distributed with this
     1.7 + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
     1.8 + 
     1.9 +#include "nsISupports.idl"
    1.10 +
    1.11 +interface nsIDOMRange;
    1.12 +interface nsIWordBreaker;
    1.13 +
    1.14 +[scriptable, uuid(75125d55-37ee-4575-b9b5-f33bfa68c2a1)]
    1.15 +interface nsIFind : nsISupports
    1.16 +{
    1.17 +  attribute boolean findBackwards;
    1.18 +  attribute boolean caseSensitive;
    1.19 +
    1.20 +  /**
    1.21 +   * Use "find entire words" mode by setting to a word breaker
    1.22 +   * or null, to disable "entire words" mode.
    1.23 +   */
    1.24 +  [noscript] attribute nsIWordBreaker wordBreaker;
    1.25 +
    1.26 +  /**
    1.27 +   * Find some text in the current context. The implementation is
    1.28 +   * responsible for performing the find and highlighting the text.
    1.29 +   *
    1.30 +   * @param aPatText     The text to search for.
    1.31 +   * @param aSearchRange A Range specifying domain of search.
    1.32 +   * @param aStartPoint  A Range specifying search start point.
    1.33 +   *                     If not collapsed, we'll start from
    1.34 +   *                     end (forward) or start (backward).
    1.35 +   * @param aEndPoint    A Range specifying search end point.
    1.36 +   *                     If not collapsed, we'll end at
    1.37 +   *                     end (forward) or start (backward).
    1.38 +   * @retval             A range spanning the match that was found (or null).
    1.39 +   */
    1.40 +  nsIDOMRange Find(in wstring aPatText, in nsIDOMRange aSearchRange,
    1.41 +                   in nsIDOMRange aStartPoint, in nsIDOMRange aEndPoint);
    1.42 +};

mercurial