xref: /AOO41X/main/offapi/com/sun/star/util/SearchDescriptor.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca) 
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_util_SearchDescriptor_idl__
24#define __com_sun_star_util_SearchDescriptor_idl__
25
26#ifndef __com_sun_star_util_XSearchDescriptor_idl__
27#include <com/sun/star/util/XSearchDescriptor.idl>
28#endif
29
30#ifndef __com_sun_star_beans_XPropertySet_idl__
31#include <com/sun/star/beans/XPropertySet.idl>
32#endif
33
34
35//=============================================================================
36
37module com {  module sun {  module star {  module util {
38
39//=============================================================================
40
41/** describes what and how to search within a container.
42 */
43published service SearchDescriptor
44{
45    interface com::sun::star::util::XSearchDescriptor;
46
47    interface com::sun::star::beans::XPropertySet;
48
49    //-------------------------------------------------------------------------
50    /** If <TRUE/>, the search is done backwards in the document.
51     */
52    [property] boolean SearchBackwards;
53
54    //-------------------------------------------------------------------------
55    /** If <TRUE/>, the case of the letters is important for the match.
56     */
57    [property] boolean SearchCaseSensitive;
58
59    //-------------------------------------------------------------------------
60    /** If <TRUE/>, only complete words will be found.
61     */
62    [property] boolean SearchWords;
63
64    //-------------------------------------------------------------------------
65    /** If <TRUE/>, the search string is evaluated as a regular expression.
66     */
67    [property] boolean SearchRegularExpression;
68
69    //-------------------------------------------------------------------------
70    /** If <TRUE/>, it is searched for positions where the paragraph style with
71        the name of the search pattern is applied.
72     */
73    [property] boolean SearchStyles;
74
75    //-------------------------------------------------------------------------
76    /** If <TRUE/>, a "similarity search" is performed.
77
78        <p>In the case of a similarity search, the following properties
79        specify the kind of similarity:
80        </p>
81        <ul>
82        <li>SearchSimilarityRelax
83        </li>
84        <li>SearchSimilarityRemove
85        </li>
86        <li>SearchSimilarityAdd
87        </li>
88        <li>SearchSimilarityExchange
89        </li>
90        </ul>
91     */
92    [property] boolean SearchSimilarity;
93
94    //-------------------------------------------------------------------------
95    /** If <TRUE/>, all similarity rules are applied together.
96
97        <p>In the case of a relaxed similarity search, the following
98        properties are applied together:
99
100        </p>
101        <ul>
102        <li>SearchSimilarityRemove
103        </li>
104        <li>SearchSimilarityAdd
105        </li>
106        <li>SearchSimilarityExchange
107        </li>
108        </ul>
109     */
110    [property] boolean SearchSimilarityRelax;
111
112    //-------------------------------------------------------------------------
113    /** This property specifies the number of characters that may be
114        ignored to match the search pattern.
115     */
116    [property] short SearchSimilarityRemove;
117
118    //-------------------------------------------------------------------------
119    /** specifies the number of characters that must be
120        added to match the search pattern.
121     */
122    [property] short SearchSimilarityAdd;
123
124    //-------------------------------------------------------------------------
125    /** This property specifies the number of characters that must
126        be replaced to match the search pattern.
127     */
128    [property] short SearchSimilarityExchange;
129
130};
131
132//=============================================================================
133
134}; }; }; };
135
136#endif
137