xref: /trunk/main/offapi/com/sun/star/util/XTextSearch.idl (revision 21947a4234354251e0dcd67df73217cd91d99f61)
1d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5d1766043SAndrew Rist * distributed with this work for additional information
6d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10cdf0e10cSrcweir *
11d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12cdf0e10cSrcweir *
13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14d1766043SAndrew Rist * software distributed under the License is distributed on an
15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17d1766043SAndrew Rist * specific language governing permissions and limitations
18d1766043SAndrew Rist * under the License.
19cdf0e10cSrcweir *
20d1766043SAndrew Rist *************************************************************/
21d1766043SAndrew Rist
22d1766043SAndrew Rist
23cdf0e10cSrcweir
24cdf0e10cSrcweir#ifndef __com_sun_star_lang_XTextSearch_idl__
25cdf0e10cSrcweir#define __com_sun_star_lang_XTextSearch_idl__
26cdf0e10cSrcweir
27cdf0e10cSrcweir
28cdf0e10cSrcweir#include <com/sun/star/lang/Locale.idl>
29cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl>
30b63233d8Sdamjan#include <com/sun/star/util/SearchOptions.idl>
31b63233d8Sdamjan#include <com/sun/star/util/SearchResult.idl>
32cdf0e10cSrcweir
33cdf0e10cSrcweir//=============================================================================
34cdf0e10cSrcweir
35cdf0e10cSrcweirmodule com { module sun { module star { module util {
36cdf0e10cSrcweir
37cdf0e10cSrcweir//=============================================================================
38cdf0e10cSrcweir
39cdf0e10cSrcweir/** enables an object to search in its content.
40cdf0e10cSrcweir */
41cdf0e10cSrcweirpublished interface XTextSearch : com::sun::star::uno::XInterface
42cdf0e10cSrcweir{
43cdf0e10cSrcweir    //-------------------------------------------------------------------------
44cdf0e10cSrcweir    /** set the options for the forward or backward search.
45cdf0e10cSrcweir
46cdf0e10cSrcweir    */
47cdf0e10cSrcweir    void setOptions ([in] SearchOptions options);
48cdf0e10cSrcweir    //-------------------------------------------------------------------------
49*21947a42Smseidel    /** search forward in the searchStr, starts at startPos and ends by endPos.
50cdf0e10cSrcweir        The result is returned in the SearchResult.
51cdf0e10cSrcweir
52cdf0e10cSrcweir    */
53cdf0e10cSrcweir    SearchResult  searchForward  ([in] string searchStr, [in] long startPos, [in] long endPos );
54cdf0e10cSrcweir    //-------------------------------------------------------------------------
55*21947a42Smseidel    /** search backward in the searchStr, starts at startPos and ends by endPos.
56*21947a42Smseidel        The endPos must be lower then the startPos, because the function searches backward!
57cdf0e10cSrcweir        The result is returned in the SearchResult.
58cdf0e10cSrcweir
59cdf0e10cSrcweir    */
60cdf0e10cSrcweir    SearchResult  searchBackward ([in] string searchStr, [in] long startPos, [in] long endPos );
61cdf0e10cSrcweir};
62cdf0e10cSrcweir
63cdf0e10cSrcweir//=============================================================================
64cdf0e10cSrcweir}; }; }; };
65cdf0e10cSrcweir
66cdf0e10cSrcweir#endif
67