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
  20
  21  module com {  module sun {  module star {  module text {
  22
  23  published interface XText;
  24  published interface XTextRange;
  25
  26 /** compares the positions of two TextRanges within a
  27     Text.
  28
  29
  30
  31     <p>Only TextRange instances within the same Text
  32     can be compared.
  33     </p>
  34  */
  35 published interface XTextRangeCompare: com::sun::star::uno::XInterface
  36 {
  37     /** @returns
  38                     1 if <var>xR1</var> starts before <var>xR2</var>,
  39                     0 if <var>xR1</var> starts at the same position as <var>xR2</var> and
  40                     -1 if <var>xR1</var> starts behind <var>xR2</var>.
  41
  42                 @throws com::sun::star::lang::IllegalArgumentException
  43                     if either <var>xR1</var> or <var>xR2</var> is not within this
  44                     text.
  45      */
  46     short compareRegionStarts( [in] XTextRange xR1, [in] XTextRange xR2 )
  47             raises( com::sun::star::lang::IllegalArgumentException );
  48
  49     /** @returns
  50                     1, if <var>xR1</var> ends before <var>xR2</var>,
  51                     0, if <var>xR1</var> ends at the same position as <var>xR2</var> and
  52                     -1, if <var>xR1</var> ends behind <var>xR2</var>.
  53
  54                 @throws com::sun::star::lang::IllegalArgumentException
  55                     if either <var>xR1</var> or <var>xR2</var> is not within this
  56                     text.
  57      */
  58     short compareRegionEnds( [in] XTextRange xR1, [in] XTextRange xR2 )
  59             raises( com::sun::star::lang::IllegalArgumentException );
  60 };
  61
  62
  63 }; }; }; };
  64
  65 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */