offapi/com/sun/star/text/XTextRange.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_XTextRange_idl__
  20 #define __com_sun_star_text_XTextRange_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24
  25  module com {  module sun {  module star {  module text {
  26
  27  published interface XText;
  28
  29 /** describes the object's position in a text.
  30
  31
  32
  33     <p>It represents a text range. The beginning and end of the range may
  34     be identical.
  35     </p>
  36  */
  37 published interface XTextRange: com::sun::star::uno::XInterface
  38 {
  39     /** @returns
  40                 the text interface in which the text position is contained.
  41      */
  42     XText getText();
  43
  44     /** @returns
  45                 a text range which contains only the start of this text range.
  46      */
  47     XTextRange getStart();
  48
  49     /** @returns
  50                 a text range which contains only the end of this text range.
  51      */
  52     XTextRange getEnd();
  53
  54     /** @returns
  55                  the string that is included in this text range.
  56      */
  57     string getString();
  58
  59     /** the whole string of characters of this piece of text is replaced.
  60
  61
  62
  63         <p>All styles are removed when applying this method.
  64
  65         </p>
  66      */
  67     void setString( [in] string aString );
  68
  69 };
  70
  71
  72 }; }; }; };
  73
  74 #endif
  75
  76 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */