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
  20
  21
  22 module com {  module sun {  module star {  module util {
  23
  24
  25 /** describes what and how to search within a container.
  26  */
  27 published service SearchDescriptor
  28 {
  29     interface com::sun::star::util::XSearchDescriptor;
  30
  31     interface com::sun::star::beans::XPropertySet;
  32
  33     /** If `TRUE`, the search is done backwards in the document.
  34      */
  35     [property] boolean SearchBackwards;
  36
  37     /** If `TRUE`, the case of the letters is important for the match.
  38      */
  39     [property] boolean SearchCaseSensitive;
  40
  41     /** If `TRUE`, only complete words will be found.
  42      */
  43     [property] boolean SearchWords;
  44
  45     /** If `TRUE`, the search string is evaluated as a regular expression.
  46
  47         <p> SearchRegularExpression, SearchWildcard and SearchSimilarity
  48         are mutually exclusive, only one can be `TRUE` at the same time. </p>
  49      */
  50     [property] boolean SearchRegularExpression;
  51
  52     /** If `TRUE`, it is searched for positions where the paragraph style with
  53         the name of the search pattern is applied.
  54      */
  55     [property] boolean SearchStyles;
  56
  57     /** If `TRUE`, a "similarity search" is performed.
  58
  59         <p>In the case of a similarity search, the following properties
  60         specify the kind of similarity:
  61         </p>
  62         <ul>
  63         <li>SearchSimilarityRelax
  64         </li>
  65         <li>SearchSimilarityRemove
  66         </li>
  67         <li>SearchSimilarityAdd
  68         </li>
  69         <li>SearchSimilarityExchange
  70         </li>
  71         </ul>
  72
  73         <p> SearchRegularExpression, SearchWildcard and SearchSimilarity
  74         are mutually exclusive, only one can be `TRUE` at the same time. </p>
  75      */
  76     [property] boolean SearchSimilarity;
  77
  78     /** If `TRUE`, all similarity rules are applied together.
  79
  80         <p>In the case of a relaxed similarity search, the following
  81         properties are applied together:
  82
  83         </p>
  84         <ul>
  85         <li>SearchSimilarityRemove
  86         </li>
  87         <li>SearchSimilarityAdd
  88         </li>
  89         <li>SearchSimilarityExchange
  90         </li>
  91         </ul>
  92      */
  93     [property] boolean SearchSimilarityRelax;
  94
  95     /** This property specifies the number of characters that may be
  96         ignored to match the search pattern.
  97      */
  98     [property] short SearchSimilarityRemove;
  99
 100     /** specifies the number of characters that must be
 101         added to match the search pattern.
 102      */
 103     [property] short SearchSimilarityAdd;
 104
 105     /** This property specifies the number of characters that must
 106         be replaced to match the search pattern.
 107      */
 108     [property] short SearchSimilarityExchange;
 109
 110     /** If `TRUE`, the search string is evaluated as a wildcard pattern.
 111
 112         <p> Wildcards are '*' (asterisk) for any sequence of characters,
 113         including an empty sequence, and '?' (question mark) for exactly
 114         one character. Escape character is '\' (U+005C REVERSE SOLIDUS)
 115         aka backslash, it escapes the special meaning of a question
 116         mark, asterisk or escape character that follows immediately
 117         after the escape character. </p>
 118
 119         <p> SearchRegularExpression, SearchWildcard and SearchSimilarity
 120         are mutually exclusive, only one can be `TRUE` at the same time. </p>
 121
 122         @since LibreOffice 5.2
 123      */
 124     [optional, property] boolean SearchWildcard;
 125
 126     /** Specifies the character used to escape special characters in wildcards.
 127
 128         @since LibreOffice 24.2
 129      */
 130     [optional, property] long WildcardEscapeCharacter;
 131
 132 };
 133
 134
 135 }; }; }; };
 136
 137 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */