offapi/com/sun/star/text/XTextRangeCompare.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XTextRangeCompare.idl,v $
  10  * $Revision: 1.10 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_text_XTextRangeCompare_idl__
  31 #define __com_sun_star_text_XTextRangeCompare_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  38 #include <com/sun/star/lang/IllegalArgumentException.idl>
  39 #endif
  40
  41 //=============================================================================
  42
  43  module com {  module sun {  module star {  module text {
  44
  45  published interface XText;
  46  published interface XTextRange;
  47
  48 //=============================================================================
  49
  50 // DocMerge from xml: interface com::sun::star::text::XTextRangeCompare
  51 /** compares the positions of two <type>TextRange</type>s within a
  52     <type>Text</type>.
  53
  54
  55
  56     <p>Only <type>TextRange</type> instances within the same <type>Text</type>
  57     can be compared.
  58     </p>
  59  */
  60 published interface XTextRangeCompare: com::sun::star::uno::XInterface
  61 {
  62     //-------------------------------------------------------------------------
  63
  64     // DocMerge from idl: method com::sun::star::text::XTextRangeCompare::compareRegionStarts
  65     /** @returns
  66                     1 if <var>xR1</var> starts before <var>xR2</var>,
  67                     0 if <var>xR1</var> starts at the same position as <var>xR2</var> and
  68                     -1 if <var>xR1</var> starts behind <var>xR2</var>.
  69
  70                 @throws com::sun::star::lang::IllegalArgumentException
  71                     if either <var>xR1</var> or <var>xR2</var> is not within this
  72                     text.
  73      */
  74     short compareRegionStarts( [in] XTextRange xR1, [in] XTextRange xR2 )
  75             raises( com::sun::star::lang::IllegalArgumentException );
  76
  77     //-------------------------------------------------------------------------
  78
  79     // DocMerge from idl: method com::sun::star::text::XTextRangeCompare::compareRegionEnds
  80     /** @returns
  81                     1, if <var>xR1</var> ends before <var>xR2</var>,
  82                     0, if <var>xR1</var> ends at the same position as <var>xR2</var> and
  83                     -1, if <var>xR1</var> ends behind <var>xR2</var>.
  84
  85                 @throws com::sun::star::lang::IllegalArgumentException
  86                     if either <var>xR1</var> or <var>xR2</var> is not within this
  87                     text.
  88      */
  89     short compareRegionEnds( [in] XTextRange xR1, [in] XTextRange xR2 )
  90             raises( com::sun::star::lang::IllegalArgumentException );
  91 };
  92
  93 //=============================================================================
  94
  95 }; }; }; };
  96
  97 #endif