diff options
Diffstat (limited to 'offapi/com/sun/star/text/XTextRangeCompare.idl')
-rw-r--r-- | offapi/com/sun/star/text/XTextRangeCompare.idl | 94 |
1 files changed, 94 insertions, 0 deletions
diff --git a/offapi/com/sun/star/text/XTextRangeCompare.idl b/offapi/com/sun/star/text/XTextRangeCompare.idl new file mode 100644 index 000000000000..5f15feab1905 --- /dev/null +++ b/offapi/com/sun/star/text/XTextRangeCompare.idl @@ -0,0 +1,94 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org 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 version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#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 |