blob: fb88bfaff431adbc431b7a8ee93515db83f29500 (
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
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
|
/*************************************************************************
*
* 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: XSearchable.idl,v $
* $Revision: 1.14 $
*
* 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_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 = "search for"
xSearchDescr.SearchCaseSensitive = <TRUE/>
xSearchDescr.SearchWords = <TRUE/>
xFound = xDocument.findFirst( xSearchDescr )
do while not IsNull(xFound)
xFound.CharWeight = com.sun.star.awt.FontWeight.BOLD
xFound = xDocument.findNext( xFound.End, xSearchDescr )
loop
</listing>
*/
published 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
|
