1*b1cdbd2cSJim Jagielski/**************************************************************
2*b1cdbd2cSJim Jagielski *
3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski * or more contributor license agreements.  See the NOTICE file
5*b1cdbd2cSJim Jagielski * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski * regarding copyright ownership.  The ASF licenses this file
7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski * with the License.  You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski *
11*b1cdbd2cSJim Jagielski *   http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski *
13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski * KIND, either express or implied.  See the License for the
17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski * under the License.
19*b1cdbd2cSJim Jagielski *
20*b1cdbd2cSJim Jagielski *************************************************************/
21*b1cdbd2cSJim Jagielski
22*b1cdbd2cSJim Jagielski
23*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_text_XTextRangeCompare_idl__
24*b1cdbd2cSJim Jagielski#define __com_sun_star_text_XTextRangeCompare_idl__
25*b1cdbd2cSJim Jagielski
26*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_uno_XInterface_idl__
27*b1cdbd2cSJim Jagielski#include <com/sun/star/uno/XInterface.idl>
28*b1cdbd2cSJim Jagielski#endif
29*b1cdbd2cSJim Jagielski
30*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
31*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/IllegalArgumentException.idl>
32*b1cdbd2cSJim Jagielski#endif
33*b1cdbd2cSJim Jagielski
34*b1cdbd2cSJim Jagielski//=============================================================================
35*b1cdbd2cSJim Jagielski
36*b1cdbd2cSJim Jagielski module com {  module sun {  module star {  module text {
37*b1cdbd2cSJim Jagielski
38*b1cdbd2cSJim Jagielski published interface XText;
39*b1cdbd2cSJim Jagielski published interface XTextRange;
40*b1cdbd2cSJim Jagielski
41*b1cdbd2cSJim Jagielski//=============================================================================
42*b1cdbd2cSJim Jagielski
43*b1cdbd2cSJim Jagielski// DocMerge from xml: interface com::sun::star::text::XTextRangeCompare
44*b1cdbd2cSJim Jagielski/** compares the positions of two <type>TextRange</type>s within a
45*b1cdbd2cSJim Jagielski	<type>Text</type>.
46*b1cdbd2cSJim Jagielski
47*b1cdbd2cSJim Jagielski
48*b1cdbd2cSJim Jagielski
49*b1cdbd2cSJim Jagielski	<p>Only <type>TextRange</type> instances within the same <type>Text</type>
50*b1cdbd2cSJim Jagielski	can be compared.
51*b1cdbd2cSJim Jagielski	</p>
52*b1cdbd2cSJim Jagielski */
53*b1cdbd2cSJim Jagielskipublished interface XTextRangeCompare: com::sun::star::uno::XInterface
54*b1cdbd2cSJim Jagielski{
55*b1cdbd2cSJim Jagielski	//-------------------------------------------------------------------------
56*b1cdbd2cSJim Jagielski
57*b1cdbd2cSJim Jagielski	// DocMerge from idl: method com::sun::star::text::XTextRangeCompare::compareRegionStarts
58*b1cdbd2cSJim Jagielski	/** @returns
59*b1cdbd2cSJim Jagielski					1 if <var>xR1</var> starts before <var>xR2</var>,
60*b1cdbd2cSJim Jagielski					0 if <var>xR1</var> starts at the same position as <var>xR2</var> and
61*b1cdbd2cSJim Jagielski					-1 if <var>xR1</var> starts behind <var>xR2</var>.
62*b1cdbd2cSJim Jagielski
63*b1cdbd2cSJim Jagielski				@throws com::sun::star::lang::IllegalArgumentException
64*b1cdbd2cSJim Jagielski					if either <var>xR1</var> or <var>xR2</var> is not within this
65*b1cdbd2cSJim Jagielski					text.
66*b1cdbd2cSJim Jagielski	 */
67*b1cdbd2cSJim Jagielski	short compareRegionStarts( [in] XTextRange xR1, [in] XTextRange xR2 )
68*b1cdbd2cSJim Jagielski			raises( com::sun::star::lang::IllegalArgumentException );
69*b1cdbd2cSJim Jagielski
70*b1cdbd2cSJim Jagielski	//-------------------------------------------------------------------------
71*b1cdbd2cSJim Jagielski
72*b1cdbd2cSJim Jagielski	// DocMerge from idl: method com::sun::star::text::XTextRangeCompare::compareRegionEnds
73*b1cdbd2cSJim Jagielski	/** @returns
74*b1cdbd2cSJim Jagielski					1, if <var>xR1</var> ends before <var>xR2</var>,
75*b1cdbd2cSJim Jagielski					0, if <var>xR1</var> ends at the same position as <var>xR2</var> and
76*b1cdbd2cSJim Jagielski					-1, if <var>xR1</var> ends behind <var>xR2</var>.
77*b1cdbd2cSJim Jagielski
78*b1cdbd2cSJim Jagielski				@throws com::sun::star::lang::IllegalArgumentException
79*b1cdbd2cSJim Jagielski					if either <var>xR1</var> or <var>xR2</var> is not within this
80*b1cdbd2cSJim Jagielski					text.
81*b1cdbd2cSJim Jagielski	 */
82*b1cdbd2cSJim Jagielski	short compareRegionEnds( [in] XTextRange xR1, [in] XTextRange xR2 )
83*b1cdbd2cSJim Jagielski			raises( com::sun::star::lang::IllegalArgumentException );
84*b1cdbd2cSJim Jagielski};
85*b1cdbd2cSJim Jagielski
86*b1cdbd2cSJim Jagielski//=============================================================================
87*b1cdbd2cSJim Jagielski
88*b1cdbd2cSJim Jagielski}; }; }; };
89*b1cdbd2cSJim Jagielski
90*b1cdbd2cSJim Jagielski#endif
91