/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XTextRange.idl,v $
 *
 *  $Revision: 1.9 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 06:49:19 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library 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 for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/
#ifndef __com_sun_star_text_XTextRange_idl__
#define __com_sun_star_text_XTextRange_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

//=============================================================================

 module com {  module sun {  module star {  module text {

 published interface XText;

//=============================================================================

// DocMerge from xml: interface com::sun::star::text::XTextRange
/** describes the object's position in a text.



    <p>It represents a text range. The beginning and end of the range may
    be identical.
    </p>
 */
published interface XTextRange: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    // DocMerge from idl: method com::sun::star::text::XTextRange::getText
    /** @returns
                the text interface in which the text position is contained.
     */
    XText getText();

    //-------------------------------------------------------------------------

    // DocMerge from idl: method com::sun::star::text::XTextRange::getStart
    /** @returns
                a text range which contains only the start of this text range.
     */
    XTextRange getStart();

    //-------------------------------------------------------------------------

    // DocMerge from idl: method com::sun::star::text::XTextRange::getEnd
    /** @returns
                a text range which contains only the end of this text range.
     */
    XTextRange getEnd();

    //-------------------------------------------------------------------------

    // DocMerge from idl: method com::sun::star::text::XTextRange::getString
    /** @returns
                 the string that is included in this text range.
     */
    string getString();

    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::text::XTextRange::setString
    /** the whole string of characters of this piece of text is replaced.



        <p>All styles are removed when applying this method.

        </p>
     */
    [oneway] void setString( [in] string aString );

};

//=============================================================================

}; }; }; };

#endif
