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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_text_XTextRangeCompare_idl__
  20 #define __com_sun_star_text_XTextRangeCompare_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/lang/IllegalArgumentException.idl>
  25
  26
  27  module com {  module sun {  module star {  module text {
  28
  29  published interface XText;
  30  published interface XTextRange;
  31
  32 /** compares the positions of two TextRanges within a
  33     Text.
  34
  35
  36
  37     <p>Only TextRange instances within the same Text
  38     can be compared.
  39     </p>
  40  */
  41 published interface XTextRangeCompare: com::sun::star::uno::XInterface
  42 {
  43     /** @returns
  44                     1 if <var>xR1</var> starts before <var>xR2</var>,
  45                     0 if <var>xR1</var> starts at the same position as <var>xR2</var> and
  46                     -1 if <var>xR1</var> starts behind <var>xR2</var>.
  47
  48                 @throws com::sun::star::lang::IllegalArgumentException
  49                     if either <var>xR1</var> or <var>xR2</var> is not within this
  50                     text.
  51      */
  52     short compareRegionStarts( [in] XTextRange xR1, [in] XTextRange xR2 )
  53             raises( com::sun::star::lang::IllegalArgumentException );
  54
  55     /** @returns
  56                     1, if <var>xR1</var> ends before <var>xR2</var>,
  57                     0, if <var>xR1</var> ends at the same position as <var>xR2</var> and
  58                     -1, if <var>xR1</var> ends behind <var>xR2</var>.
  59
  60                 @throws com::sun::star::lang::IllegalArgumentException
  61                     if either <var>xR1</var> or <var>xR2</var> is not within this
  62                     text.
  63      */
  64     short compareRegionEnds( [in] XTextRange xR1, [in] XTextRange xR2 )
  65             raises( com::sun::star::lang::IllegalArgumentException );
  66 };
  67
  68
  69 }; }; }; };
  70
  71 #endif
  72
  73 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */