xref: /trunk/main/offapi/com/sun/star/util/SearchOptions.idl (revision ffd38472365e95f6a578737bc9a5eb0fac624a86)
1*b63233d8Sdamjan/**************************************************************
2*b63233d8Sdamjan *
3*b63233d8Sdamjan * Licensed to the Apache Software Foundation (ASF) under one
4*b63233d8Sdamjan * or more contributor license agreements.  See the NOTICE file
5*b63233d8Sdamjan * distributed with this work for additional information
6*b63233d8Sdamjan * regarding copyright ownership.  The ASF licenses this file
7*b63233d8Sdamjan * to you under the Apache License, Version 2.0 (the
8*b63233d8Sdamjan * "License"); you may not use this file except in compliance
9*b63233d8Sdamjan * with the License.  You may obtain a copy of the License at
10*b63233d8Sdamjan *
11*b63233d8Sdamjan *   http://www.apache.org/licenses/LICENSE-2.0
12*b63233d8Sdamjan *
13*b63233d8Sdamjan * Unless required by applicable law or agreed to in writing,
14*b63233d8Sdamjan * software distributed under the License is distributed on an
15*b63233d8Sdamjan * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b63233d8Sdamjan * KIND, either express or implied.  See the License for the
17*b63233d8Sdamjan * specific language governing permissions and limitations
18*b63233d8Sdamjan * under the License.
19*b63233d8Sdamjan *
20*b63233d8Sdamjan *************************************************************/
21*b63233d8Sdamjan
22*b63233d8Sdamjan
23*b63233d8Sdamjan
24*b63233d8Sdamjan#ifndef __com_sun_star_lang_SearchOptions_idl__
25*b63233d8Sdamjan#define __com_sun_star_lang_SearchOptions_idl__
26*b63233d8Sdamjan
27*b63233d8Sdamjan
28*b63233d8Sdamjan#include <com/sun/star/lang/Locale.idl>
29*b63233d8Sdamjan#include <com/sun/star/uno/XInterface.idl>
30*b63233d8Sdamjan#include <com/sun/star/util/SearchAlgorithms.idl>
31*b63233d8Sdamjan
32*b63233d8Sdamjan//=============================================================================
33*b63233d8Sdamjan
34*b63233d8Sdamjanmodule com { module sun { module star { module util {
35*b63233d8Sdamjan
36*b63233d8Sdamjan//=============================================================================
37*b63233d8Sdamjan
38*b63233d8Sdamjanpublished  struct SearchOptions  {
39*b63233d8Sdamjan    //-------------------------------------------------------------------------
40*b63233d8Sdamjan    /** search type */
41*b63233d8Sdamjan    SearchAlgorithms    algorithmType;
42*b63233d8Sdamjan
43*b63233d8Sdamjan    /** some flags - can be mixed
44*b63233d8Sdamjan
45*b63233d8Sdamjan        @see <type>SearchFlags</type>
46*b63233d8Sdamjan    */
47*b63233d8Sdamjan    long            searchFlag;
48*b63233d8Sdamjan
49*b63233d8Sdamjan    /** The text or pattern to be searched. */
50*b63233d8Sdamjan    string          searchString;
51*b63233d8Sdamjan
52*b63233d8Sdamjan    /** The replacement text
53*b63233d8Sdamjan        (is for optional replacing - SearchOption is only the data container for it) */
54*b63233d8Sdamjan    string          replaceString;
55*b63233d8Sdamjan
56*b63233d8Sdamjan    /** The locale for case insensitive search. */
57*b63233d8Sdamjan    ::com::sun::star::lang::Locale  Locale;
58*b63233d8Sdamjan
59*b63233d8Sdamjan    /** This many characters can be different (as a replacement) between
60*b63233d8Sdamjan        the found word and the search pattern in a "Weighted Levenshtein
61*b63233d8Sdamjan        Distance" search. */
62*b63233d8Sdamjan    long            changedChars;
63*b63233d8Sdamjan
64*b63233d8Sdamjan    /** This many characters can be missing in the found word in a
65*b63233d8Sdamjan        "Weighted Levenshtein Distance" search. */
66*b63233d8Sdamjan    long            deletedChars;
67*b63233d8Sdamjan
68*b63233d8Sdamjan    /** This many characters can be additional in the found word in a
69*b63233d8Sdamjan        "Weighted Levenshtein Distance" search. */
70*b63233d8Sdamjan    long            insertedChars;
71*b63233d8Sdamjan
72*b63233d8Sdamjan    /** Flags for the transliteration. Same meaning as the enum of
73*b63233d8Sdamjan        <type scope="com::sun::star::i18n">TransliterationModules</type>
74*b63233d8Sdamjan    */
75*b63233d8Sdamjan    long            transliterateFlags;
76*b63233d8Sdamjan};
77*b63233d8Sdamjan
78*b63233d8Sdamjan//=============================================================================
79*b63233d8Sdamjan}; }; }; };
80*b63233d8Sdamjan
81*b63233d8Sdamjan#endif
82