/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XTextRangeCompare.idl,v $
 *
 *  $Revision: 1.9 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 06:49:34 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/
#ifndef __com_sun_star_text_XTextRangeCompare_idl__
#define __com_sun_star_text_XTextRangeCompare_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif

//=============================================================================

 module com {  module sun {  module star {  module text {

 published interface XText;
 published interface XTextRange;

//=============================================================================

// DocMerge from xml: interface com::sun::star::text::XTextRangeCompare
/** compares the positions of two <type>TextRange</type>s within a
    <type>Text</type>.



    <p>Only <type>TextRange</type> instances within the same <type>Text</type>
    can be compared.
    </p>
 */
published interface XTextRangeCompare: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    // DocMerge from idl: method com::sun::star::text::XTextRangeCompare::compareRegionStarts
    /** @returns
                    1 if <var>xR1</var> starts before <var>xR2</var>,
                    0 if <var>xR1</var> starts at the same position as <var>xR2</var> and
                    -1 if <var>xR1</var> starts behind <var>xR2</var>.

                @throws com::sun::star::lang::IllegalArgumentException
                    if either <var>xR1</var> or <var>xR2</var> is not within this
                    text.
     */
    short compareRegionStarts( [in] XTextRange xR1, [in] XTextRange xR2 )
            raises( com::sun::star::lang::IllegalArgumentException );

    //-------------------------------------------------------------------------

    // DocMerge from idl: method com::sun::star::text::XTextRangeCompare::compareRegionEnds
    /** @returns
                    1, if <var>xR1</var> ends before <var>xR2</var>,
                    0, if <var>xR1</var> ends at the same position as <var>xR2</var> and
                    -1, if <var>xR1</var> ends behind <var>xR2</var>.

                @throws com::sun::star::lang::IllegalArgumentException
                    if either <var>xR1</var> or <var>xR2</var> is not within this
                    text.
     */
    short compareRegionEnds( [in] XTextRange xR1, [in] XTextRange xR2 )
            raises( com::sun::star::lang::IllegalArgumentException );
};

//=============================================================================

}; }; }; };

#endif
