third_party/WebKit/public/web/WebFindOptions.h

   1 /*
   2  * Copyright (C) 2009 Google Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  *     * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *     * Redistributions in binary form must reproduce the above
  11  * copyright notice, this list of conditions and the following disclaimer
  12  * in the documentation and/or other materials provided with the
  13  * distribution.
  14  *     * Neither the name of Google Inc. nor the names of its
  15  * contributors may be used to endorse or promote products derived from
  16  * this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #ifndef WebFindOptions_h
  32 #define WebFindOptions_h
  33
  34 #include "../platform/WebString.h"
  35
  36 namespace blink {
  37
  38 // Options used when performing a find-in-page query.
  39 struct WebFindOptions {
  40     // Whether to search forward or backward within the page.
  41     bool forward;
  42
  43     // Whether search should be case-sensitive.
  44     bool matchCase;
  45
  46     // Whether this operation is the first request or a follow-up.
  47     bool findNext;
  48
  49     // Whether this operation should look for matches only at the start of words.
  50     bool wordStart;
  51
  52     // When combined with wordStart, accepts a match in the middle of a word if the match begins with
  53     // an uppercase letter followed by a lowercase or non-letter. Accepts several other intra-word matches.
  54     bool medialCapitalAsWordStart;
  55
  56     WebFindOptions()
  57         : forward(true)
  58         , matchCase(false)
  59         , findNext(false)
  60         , wordStart(false)
  61         , medialCapitalAsWordStart(false) { }
  62 };
  63
  64 } // namespace blink
  65
  66 #endif