offapi/com/sun/star/util/SearchDescriptor.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_util_SearchDescriptor_idl__
  20 #define __com_sun_star_util_SearchDescriptor_idl__
  21
  22 #include <com/sun/star/util/XSearchDescriptor.idl>
  23
  24 #include <com/sun/star/beans/XPropertySet.idl>
  25
  26
  27
  28 module com {  module sun {  module star {  module util {
  29
  30
  31 /** describes what and how to search within a container.
  32  */
  33 published service SearchDescriptor
  34 {
  35     interface com::sun::star::util::XSearchDescriptor;
  36
  37     interface com::sun::star::beans::XPropertySet;
  38
  39     /** If `TRUE`, the search is done backwards in the document.
  40      */
  41     [property] boolean SearchBackwards;
  42
  43     /** If `TRUE`, the case of the letters is important for the match.
  44      */
  45     [property] boolean SearchCaseSensitive;
  46
  47     /** If `TRUE`, only complete words will be found.
  48      */
  49     [property] boolean SearchWords;
  50
  51     /** If `TRUE`, the search string is evaluated as a regular expression.
  52
  53         <p> SearchRegularExpression, SearchWildcard and SearchSimilarity
  54         are mutually exclusive, only one can be `TRUE` at the same time. </p>
  55      */
  56     [property] boolean SearchRegularExpression;
  57
  58     /** If `TRUE`, it is searched for positions where the paragraph style with
  59         the name of the search pattern is applied.
  60      */
  61     [property] boolean SearchStyles;
  62
  63     /** If `TRUE`, a "similarity search" is performed.
  64
  65         <p>In the case of a similarity search, the following properties
  66         specify the kind of similarity:
  67         </p>
  68         <ul>
  69         <li>SearchSimilarityRelax
  70         </li>
  71         <li>SearchSimilarityRemove
  72         </li>
  73         <li>SearchSimilarityAdd
  74         </li>
  75         <li>SearchSimilarityExchange
  76         </li>
  77         </ul>
  78
  79         <p> SearchRegularExpression, SearchWildcard and SearchSimilarity
  80         are mutually exclusive, only one can be `TRUE` at the same time. </p>
  81      */
  82     [property] boolean SearchSimilarity;
  83
  84     /** If `TRUE`, all similarity rules are applied together.
  85
  86         <p>In the case of a relaxed similarity search, the following
  87         properties are applied together:
  88
  89         </p>
  90         <ul>
  91         <li>SearchSimilarityRemove
  92         </li>
  93         <li>SearchSimilarityAdd
  94         </li>
  95         <li>SearchSimilarityExchange
  96         </li>
  97         </ul>
  98      */
  99     [property] boolean SearchSimilarityRelax;
 100
 101     /** This property specifies the number of characters that may be
 102         ignored to match the search pattern.
 103      */
 104     [property] short SearchSimilarityRemove;
 105
 106     /** specifies the number of characters that must be
 107         added to match the search pattern.
 108      */
 109     [property] short SearchSimilarityAdd;
 110
 111     /** This property specifies the number of characters that must
 112         be replaced to match the search pattern.
 113      */
 114     [property] short SearchSimilarityExchange;
 115
 116     /** If `TRUE`, the search string is evaluated as a wildcard pattern.
 117
 118         <p> Wildcards are '*' (asterisk) for any sequence of characters,
 119         including an empty sequence, and '?' (question mark) for exactly
 120         one character. Escape character is '\' (U+005C REVERSE SOLIDUS)
 121         aka backslash, it escapes the special meaning of a question
 122         mark, asterisk or escape character that follows immediately
 123         after the escape character. </p>
 124
 125         <p> SearchRegularExpression, SearchWildcard and SearchSimilarity
 126         are mutually exclusive, only one can be `TRUE` at the same time. </p>
 127
 128         @since LibreOffice 5.2
 129      */
 130     [optional, property] boolean SearchWildcard;
 131
 132 };
 133
 134
 135 }; }; }; };
 136
 137 #endif
 138
 139 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */