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
24#ifndef __com_sun_star_lang_SearchResult_idl__
25#define __com_sun_star_lang_SearchResult_idl__
26
27
28//=============================================================================
29
30module com { module sun { module star { module util {
31
32//=============================================================================
33
34published  struct SearchResult  {
35	//-------------------------------------------------------------------------
36	/** Number of subexpressions,
37	if it is 0, then no match found; this value is 1 for ABSOLUTE and APPROXIMATE match.
38	The start and endOffset are always dependent on the search direction.
39	For example:
40	if you search "X" in the text "-X-" the offset are:
41		for forward: 	start = 1, end = 2
42        for backward:   start = 2, end = 1
43    Forward, the startOffset is inclusive, the endOffset exclusive.
44    Backward, the startOffset is exclusive, the endOffset inclusive.
45
46	For regular expressions it can be greater than 1.
47	If the value is 1, startoffset[0] and endoffset[0] points to the matching sub string
48	if value is > 1, still startoffset[0] and endoffset[0] points to the matching substring for whole regular expression
49	startoffset[i] and endoffset[i] points to the matching substring of i th matching substring.
50	*/
51	long subRegExpressions;
52	sequence<long> startOffset;		// inclusive
53	sequence<long> endOffset;  		// exclusive
54};
55
56//=============================================================================
57}; }; }; };
58
59#endif
60
61