offapi/com/sun/star/util/SearchOptions.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 #ifndef __com_sun_star_util_SearchOptions_idl__
  21 #define __com_sun_star_util_SearchOptions_idl__
  22
  23
  24 #include <com/sun/star/lang/Locale.idl>
  25 #include <com/sun/star/uno/XInterface.idl>
  26 #include <com/sun/star/util/SearchAlgorithms.idl>
  27
  28
  29 module com { module sun { module star { module util {
  30
  31
  32 published  struct SearchOptions  {
  33     /** search type */
  34     SearchAlgorithms    algorithmType;
  35
  36     /** some flags - can be mixed
  37
  38         @see SearchFlags
  39     */
  40     long             searchFlag;
  41
  42     /** The text or pattern to be searched. */
  43     string            searchString;
  44
  45     /** The replacement text
  46         (is for optional replacing - SearchOption is only the data container for it) */
  47     string            replaceString;
  48
  49     /** The locale for case insensitive search. */
  50     ::com::sun::star::lang::Locale  Locale;
  51
  52     /** This many characters can be different (as a replacement) between
  53         the found word and the search pattern in a "Weighted Levenshtein
  54         Distance" search. */
  55     long            changedChars;
  56
  57     /** This many characters can be missing in the found word in a
  58         "Weighted Levenshtein Distance" search. */
  59     long            deletedChars;
  60
  61     /** This many characters can be additional in the found word in a
  62         "Weighted Levenshtein Distance" search. */
  63     long            insertedChars;
  64
  65     /** Flags for the transliteration. Same meaning as the enum of
  66         com::sun::star::i18n::TransliterationModules
  67     */
  68     long            transliterateFlags;
  69 };
  70
  71 }; }; }; };
  72
  73 #endif
  74
  75 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */