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#ifndef __com_sun_star_text_XTextRangeCompare_idl__ 24#define __com_sun_star_text_XTextRangeCompare_idl__ 25 26#ifndef __com_sun_star_uno_XInterface_idl__ 27#include <com/sun/star/uno/XInterface.idl> 28#endif 29 30#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 31#include <com/sun/star/lang/IllegalArgumentException.idl> 32#endif 33 34//============================================================================= 35 36 module com { module sun { module star { module text { 37 38 published interface XText; 39 published interface XTextRange; 40 41//============================================================================= 42 43// DocMerge from xml: interface com::sun::star::text::XTextRangeCompare 44/** compares the positions of two <type>TextRange</type>s within a 45 <type>Text</type>. 46 47 48 49 <p>Only <type>TextRange</type> instances within the same <type>Text</type> 50 can be compared. 51 </p> 52 */ 53published interface XTextRangeCompare: com::sun::star::uno::XInterface 54{ 55 //------------------------------------------------------------------------- 56 57 // DocMerge from idl: method com::sun::star::text::XTextRangeCompare::compareRegionStarts 58 /** @returns 59 1 if <var>xR1</var> starts before <var>xR2</var>, 60 0 if <var>xR1</var> starts at the same position as <var>xR2</var> and 61 -1 if <var>xR1</var> starts behind <var>xR2</var>. 62 63 @throws com::sun::star::lang::IllegalArgumentException 64 if either <var>xR1</var> or <var>xR2</var> is not within this 65 text. 66 */ 67 short compareRegionStarts( [in] XTextRange xR1, [in] XTextRange xR2 ) 68 raises( com::sun::star::lang::IllegalArgumentException ); 69 70 //------------------------------------------------------------------------- 71 72 // DocMerge from idl: method com::sun::star::text::XTextRangeCompare::compareRegionEnds 73 /** @returns 74 1, if <var>xR1</var> ends before <var>xR2</var>, 75 0, if <var>xR1</var> ends at the same position as <var>xR2</var> and 76 -1, if <var>xR1</var> ends behind <var>xR2</var>. 77 78 @throws com::sun::star::lang::IllegalArgumentException 79 if either <var>xR1</var> or <var>xR2</var> is not within this 80 text. 81 */ 82 short compareRegionEnds( [in] XTextRange xR1, [in] XTextRange xR2 ) 83 raises( com::sun::star::lang::IllegalArgumentException ); 84}; 85 86//============================================================================= 87 88}; }; }; }; 89 90#endif 91