1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: SearchDescriptor.idl,v $
* $Revision: 1.9 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __com_sun_star_util_SearchDescriptor_idl__
#define __com_sun_star_util_SearchDescriptor_idl__
#ifndef __com_sun_star_util_XSearchDescriptor_idl__
#include <com/sun/star/util/XSearchDescriptor.idl>
#endif
#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif
//=============================================================================
module com { module sun { module star { module util {
//=============================================================================
/** describes what and how to search within a container.
*/
published service SearchDescriptor
{
interface com::sun::star::util::XSearchDescriptor;
interface com::sun::star::beans::XPropertySet;
//-------------------------------------------------------------------------
/** If <TRUE/>, the search is done backwards in the document.
*/
[property] boolean SearchBackwards;
//-------------------------------------------------------------------------
/** If <TRUE/>, the case of the letters is important for the match.
*/
[property] boolean SearchCaseSensitive;
//-------------------------------------------------------------------------
/** If <TRUE/>, only complete words will be found.
*/
[property] boolean SearchWords;
//-------------------------------------------------------------------------
/** If <TRUE/>, the search string is evaluated as a regular expression.
*/
[property] boolean SearchRegularExpression;
//-------------------------------------------------------------------------
/** If <TRUE/>, it is searched for positions where the paragraph style with
the name of the search pattern is applied.
*/
[property] boolean SearchStyles;
//-------------------------------------------------------------------------
/** If <TRUE/>, a "similarity search" is performed.
<p>In the case of a similarity search, the following properties
specify the kind of similarity:
</p>
<ul>
<li>SearchSimilarityRelax
</li>
<li>SearchSimilarityRemove
</li>
<li>SearchSimilarityAdd
</li>
<li>SearchSimilarityExchange
</li>
</ul>
*/
[property] boolean SearchSimilarity;
//-------------------------------------------------------------------------
/** If <TRUE/>, all similarity rules are applied together.
<p>In the case of a relaxed similarity search, the following
properties are applied together:
</p>
<ul>
<li>SearchSimilarityRemove
</li>
<li>SearchSimilarityAdd
</li>
<li>SearchSimilarityExchange
</li>
</ul>
*/
[property] boolean SearchSimilarityRelax;
//-------------------------------------------------------------------------
/** This property specifies the number of characters that may be
ignored to match the search pattern.
*/
[property] short SearchSimilarityRemove;
//-------------------------------------------------------------------------
/** specifies the number of characters that must be
added to match the search pattern.
*/
[property] short SearchSimilarityAdd;
//-------------------------------------------------------------------------
/** This property specifies the number of characters that must
be replaced to match the search pattern.
*/
[property] short SearchSimilarityExchange;
};
//=============================================================================
}; }; }; };
#endif
|
