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_XReplaceable_idl__
24#define __com_sun_star_util_XReplaceable_idl__
25
26#ifndef __com_sun_star_util_XSearchable_idl__
27#include <com/sun/star/util/XSearchable.idl>
28#endif
29
30#ifndef __com_sun_star_util_XReplaceDescriptor_idl__
31#include <com/sun/star/util/XReplaceDescriptor.idl>
32#endif
33
34#ifndef __com_sun_star_util_XSearchDescriptor_idl__
35#include <com/sun/star/util/XSearchDescriptor.idl>
36#endif
37
38
39//=============================================================================
40
41module com {  module sun {  module star {  module util {
42
43//=============================================================================
44
45/** makes it possible to replace strings in a text described by a
46	<type>SearchDescriptor</type>.
47
48	@example
49	<listing>
50	'replace all bold words "search for" by "look for"
51	xReplaceDescr = xDocument.createReplaceDescriptor()
52	xReplaceDescr.SearchString = "search for"
53	xReplaceDescr.ReplaceString = "look for"
54	xFound = xDocument.replaceAll( xReplaceDescr )
55	</listing>
56 */
57published interface XReplaceable: com::sun::star::util::XSearchable
58{
59	//-------------------------------------------------------------------------
60	/** creates a descriptor which contains properties that
61		specify a search in this container.@see SearchDescriptor
62	 */
63	com::sun::star::util::XReplaceDescriptor createReplaceDescriptor();
64
65	//-------------------------------------------------------------------------
66	/** searches for all occurrences of whatever is specified.@see SearchDescriptor
67	 */
68	long replaceAll( [in] com::sun::star::util::XSearchDescriptor xDesc );
69
70};
71
72//=============================================================================
73
74}; }; }; };
75
76#endif
77