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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XTextRange.idl,v $
  10  * $Revision: 1.10 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_text_XTextRange_idl__
  31 #define __com_sun_star_text_XTextRange_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 //=============================================================================
  38
  39  module com {  module sun {  module star {  module text {
  40
  41  published interface XText;
  42
  43 //=============================================================================
  44
  45 // DocMerge from xml: interface com::sun::star::text::XTextRange
  46 /** describes the object's position in a text.
  47
  48
  49
  50     <p>It represents a text range. The beginning and end of the range may
  51     be identical.
  52     </p>
  53  */
  54 published interface XTextRange: com::sun::star::uno::XInterface
  55 {
  56     //-------------------------------------------------------------------------
  57
  58     // DocMerge from idl: method com::sun::star::text::XTextRange::getText
  59     /** @returns
  60                 the text interface in which the text position is contained.
  61      */
  62     XText getText();
  63
  64     //-------------------------------------------------------------------------
  65
  66     // DocMerge from idl: method com::sun::star::text::XTextRange::getStart
  67     /** @returns
  68                 a text range which contains only the start of this text range.
  69      */
  70     XTextRange getStart();
  71
  72     //-------------------------------------------------------------------------
  73
  74     // DocMerge from idl: method com::sun::star::text::XTextRange::getEnd
  75     /** @returns
  76                 a text range which contains only the end of this text range.
  77      */
  78     XTextRange getEnd();
  79
  80     //-------------------------------------------------------------------------
  81
  82     // DocMerge from idl: method com::sun::star::text::XTextRange::getString
  83     /** @returns
  84                  the string that is included in this text range.
  85      */
  86     string getString();
  87
  88     //-------------------------------------------------------------------------
  89
  90     // DocMerge from xml: method com::sun::star::text::XTextRange::setString
  91     /** the whole string of characters of this piece of text is replaced.
  92
  93
  94
  95         <p>All styles are removed when applying this method.
  96
  97         </p>
  98      */
  99     [oneway] void setString( [in] string aString );
 100
 101 };
 102
 103 //=============================================================================
 104
 105 }; }; }; };
 106
 107 #endif