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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
|
/*************************************************************************
*
* $RCSfile: XSearchable.idl,v $
*
* $Revision: 1.10 $
*
* last change: $Author: hr $ $Date: 2003-03-26 13:58:13 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library 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 for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (the "License"); You may not use this file
* except in compliance with the License. You may obtain a copy of the
* License at http://www.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef __com_sun_star_util_XSearchable_idl__
#define __com_sun_star_util_XSearchable_idl__
#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
#ifndef __com_sun_star_util_XSearchDescriptor_idl__
#include <com/sun/star/util/XSearchDescriptor.idl>
#endif
#ifndef __com_sun_star_container_XIndexAccess_idl__
#include <com/sun/star/container/XIndexAccess.idl>
#endif
//=============================================================================
module com { module sun { module star { module util {
//=============================================================================
/** enables the object to look for specified contents of the object
(in particular, for a text range which contains a specific string pattern).
@example
in a <type scope="com::sun::star::text">TextDocument</type>:
set all "search for" to bold using findFirst()/findNext():
<listing>
xSearchDescr = xDocument.createSearchDescriptor()
xSearchDescr.SearchString = "to look for"
xSearchDescr.SearchCaseSensitive = <TRUE/>
xSearchDescr.SearchWholeWords = <TRUE/>
xFound = xDocument.findFirst( xSearchDescr )
do while xFound
xFound.CharWeight = CharWeight_BOLD
xFound = xDocument.findNext( xFound.End, xSearchDescr )
loop
</listing>
replace all bold "search for" by "look for" using findAll():
<listing>
xSearchDescr = xDocument.createSearchDescriptor()
xSearchDescr.SearchString = "to look for"
xSearchDescr.SearchCaseSensitive = <TRUE/>
xSearchDescr.SearchWholeWords = <TRUE/>
xStyles = createPropertySet( xSearchDescr.SearchStyles )
xStyles.CharWeight = CharWeight_BOLD
xSearchDescr.SearchStyles = xStyles.PropertyValues
xAllFound = xDocument.findAll( xSearchDescr )
for n% = lbound(xAllFound) to ubound(xAllFound)
xAllFound(n%).String = "look for"
loop
</listing>
*/
interface XSearchable: com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
/** creates a <type>SearchDescriptor</type> which contains properties that
specify a search in this container.@see SearchDescriptor
*/
com::sun::star::util::XSearchDescriptor createSearchDescriptor();
//-------------------------------------------------------------------------
/** searches the contained texts for all occurrences of whatever is specified.@see SearchDescriptor
*/
com::sun::star::container::XIndexAccess findAll( [in] com::sun::star::util::XSearchDescriptor xDesc );
//-------------------------------------------------------------------------
/** searches the contained texts for the next occurrence of whatever is specified.
@returns
the position within the component, e.g. a <type scope="com::sun::star::text">XTextRange</type>
which determines the found elements.
@see SearchDescriptor
*/
com::sun::star::uno::XInterface findFirst( [in] com::sun::star::util::XSearchDescriptor xDesc );
//-------------------------------------------------------------------------
/** searches the contained texts for the next occurrence of whatever is specified.
@param xStartAt
represents a position within the component at which the search continues.
This position is returned by <method>XSearchable::findFirst</method> or
the previous <method>XSearchable::findNext</method>.
@see SearchDescriptor
*/
com::sun::star::uno::XInterface findNext( [in] com::sun::star::uno::XInterface xStartAt,
[in] com::sun::star::util::XSearchDescriptor xDesc );
};
//=============================================================================
}; }; }; };
#endif
|
