blob: ad5dd666e64a9335b8ebce161380bd03bdab2306 (
plain)
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
|
/*************************************************************************
*
* 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: XReplaceable.idl,v $
* $Revision: 1.10 $
*
* 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_XReplaceable_idl__
#define __com_sun_star_util_XReplaceable_idl__
#ifndef __com_sun_star_util_XSearchable_idl__
#include <com/sun/star/util/XSearchable.idl>
#endif
#ifndef __com_sun_star_util_XReplaceDescriptor_idl__
#include <com/sun/star/util/XReplaceDescriptor.idl>
#endif
#ifndef __com_sun_star_util_XSearchDescriptor_idl__
#include <com/sun/star/util/XSearchDescriptor.idl>
#endif
//=============================================================================
module com { module sun { module star { module util {
//=============================================================================
/** makes it possible to replace strings in a text described by a
<type>SearchDescriptor</type>.
@example
<listing>
'replace all bold words "search for" by "look for"
xReplaceDescr = xDocument.createReplaceDescriptor()
xReplaceDescr.SearchString = "search for"
xReplaceDescr.ReplaceString = "look for"
xFound = xDocument.replaceAll( xReplaceDescr )
</listing>
*/
published interface XReplaceable: com::sun::star::util::XSearchable
{
//-------------------------------------------------------------------------
/** creates a descriptor which contains properties that
specify a search in this container.@see SearchDescriptor
*/
com::sun::star::util::XReplaceDescriptor createReplaceDescriptor();
//-------------------------------------------------------------------------
/** searches for all occurrences of whatever is specified.@see SearchDescriptor
*/
long replaceAll( [in] com::sun::star::util::XSearchDescriptor xDesc );
};
//=============================================================================
}; }; }; };
#endif
|