offapi/com/sun/star/text/XSimpleText.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: XSimpleText.idl,v $
  10  * $Revision: 1.13 $
  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_XSimpleText_idl__
  31 #define __com_sun_star_text_XSimplText_idl__
  32
  33 #ifndef __com_sun_star_text_XTextRange_idl__
  34 #include <com/sun/star/text/XTextRange.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_text_XTextCursor_idl__
  38 #include <com/sun/star/text/XTextCursor.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  42 #include <com/sun/star/lang/IllegalArgumentException.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_text_XTextContent_idl__
  46 #include <com/sun/star/text/XTextContent.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_container_NoSuchElementException_idl__
  50 #include <com/sun/star/container/NoSuchElementException.idl>
  51 #endif
  52
  53
  54 //=============================================================================
  55
  56  module com {  module sun {  module star {  module text {
  57
  58 //=============================================================================
  59
  60 /** is the main interface for a distinct text unit, i.e. the main text of
  61     a document, the text for headers and footers or for single cells of a
  62     table.@see XText
  63  */
  64 published interface XSimpleText: com::sun::star::text::XTextRange
  65 {
  66     //-------------------------------------------------------------------------
  67
  68     /** @returns
  69                 a new instance of a <type>TextCursor</type> service which can
  70                 be used to travel in the given text context.
  71
  72                 @see com::sun::star::text::TextCursor
  73      */
  74     com::sun::star::text::XTextCursor createTextCursor();
  75
  76     //-------------------------------------------------------------------------
  77
  78     /** @returns
  79                 a new instance of a <type>TextCursor</type> which is located
  80                 at the specified <type>TextRange</type> to travel in the
  81                 given text context.
  82
  83                 <p>The initial position is set to <var>aTextPosition</var>.
  84
  85                 @param aTextPosition
  86                 specifies the start position for the new
  87                 <type>TextCursor</type>.
  88
  89                 @see com::sun::star::text::TextCursor
  90      */
  91     com::sun::star::text::XTextCursor createTextCursorByRange( [in] com::sun::star::text::XTextRange aTextPosition );
  92
  93     //-------------------------------------------------------------------------
  94
  95     /** inserts a string of characters into the text.
  96
  97         <p>The string may contain the following white spaces:
  98         </p>
  99         <ul>
 100             <li>blank</li>
 101             <li>tab</li>
 102             <li>cr (which will insert a paragraph break)</li>
 103             <li>lf (which will insert a line break)</li>
 104         </ul>
 105
 106         @param xRange
 107             specifies the position of insertion. For example,
 108             <method>XSimpleText::createTextCursor</member> can be used to
 109             get an <type>XTextRange</type> for this argument.
 110
 111             <p>If the parameter <member>bAbsorb</member> was <TRUE/>
 112             the text range will contain the new inserted string, otherwise
 113             the range (and it's text) will remain unchanged.
 114
 115         @param aString
 116             specifies the string to insert.
 117
 118         @param bAbsorb
 119             specifies whether the text spanned by <var>xRange</var> will be
 120             replaced. If <TRUE/> then the content of <var>xRange</var> will
 121             be replaced by <var>aString</var>, otherwise <var>aString</var>
 122             will be inserted at the beginning of <var>xRange</var>.
 123
 124         @example
 125             <listing>
 126             xText.insertString( xTextCursor, "Hello " + aName$ + ",", false )
 127
 128             xText.insertControlCharacter( xTextCursor,
 129             ControlCharacter_PARAGRAPH_BREAK, false );
 130
 131             xText.insertString( xTextCursor, "more text ...", false )
 132             </listing>
 133      */
 134     [oneway] void insertString( [in] com::sun::star::text::XTextRange xRange,
 135              [in] string aString,
 136              [in] boolean bAbsorb );
 137
 138     //-------------------------------------------------------------------------
 139
 140     /** inserts a control character (like a paragraph break or a hard
 141         space) into the text.@see com::sun::star::text::ControlCharacter
 142      */
 143     void insertControlCharacter( [in] com::sun::star::text::XTextRange xRange,
 144              [in] short nControlCharacter,
 145              [in] boolean bAbsorb )
 146             raises( com::sun::star::lang::IllegalArgumentException );
 147
 148 };
 149
 150 //=============================================================================
 151
 152 }; }; }; };
 153
 154 #endif