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

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