offapi/com/sun/star/text/XSimpleText.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
  22  module com {  module sun {  module star {  module text {
  23
  24
  25 /** is the main interface for a distinct text unit, i.e. the main text of
  26     a document, the text for headers and footers or for single cells of a
  27     table.@see XText
  28  */
  29 published interface XSimpleText: com::sun::star::text::XTextRange
  30 {
  31
  32     /** @returns
  33                 a new instance of a TextCursor service which can
  34                 be used to travel in the given text context.
  35
  36                 @see com::sun::star::text::TextCursor
  37      */
  38     com::sun::star::text::XTextCursor createTextCursor();
  39
  40
  41     /** @returns
  42                 a new instance of a TextCursor which is located
  43                 at the specified TextRange to travel in the
  44                 given text context.
  45
  46                 <p>The initial position is set to <var>aTextPosition</var>.
  47
  48                 @param aTextPosition
  49                 specifies the start position for the new
  50                 TextCursor.
  51
  52                 @see com::sun::star::text::TextCursor
  53      */
  54     com::sun::star::text::XTextCursor createTextCursorByRange( [in] com::sun::star::text::XTextRange aTextPosition );
  55
  56
  57     /** inserts a string of characters into the text.
  58
  59         <p>The string may contain the following white spaces:
  60         </p>
  61         <ul>
  62             <li>blank</li>
  63             <li>tab</li>
  64             <li>cr (which will insert a paragraph break)</li>
  65             <li>lf (which will insert a line break)</li>
  66         </ul>
  67
  68         @param xRange
  69             specifies the position of insertion. For example,
  70             XSimpleText::createTextCursor() can be used to
  71             get an XTextRange for this argument.
  72
  73             <p>If the parameter bAbsorb() was `TRUE`
  74             the text range will contain the new inserted string, otherwise
  75             the range (and it's text) will remain unchanged.
  76
  77         @param aString
  78             specifies the string to insert.
  79
  80         @param bAbsorb
  81             specifies whether the text spanned by <var>xRange</var> will be
  82             replaced. If `TRUE` then the content of <var>xRange</var> will
  83             be replaced by <var>aString</var>, otherwise <var>aString</var>
  84             will be inserted at the beginning of <var>xRange</var>.
  85
  86         @code{.java}
  87             xText.insertString( xTextCursor, "Hello " + aName + ",", false )
  88
  89             xText.insertControlCharacter( xTextCursor,
  90                 ControlCharacter.PARAGRAPH_BREAK, false );
  91
  92             xText.insertString( xTextCursor, "more text ...", false )
  93         @endcode
  94      */
  95     void insertString( [in] com::sun::star::text::XTextRange xRange,
  96              [in] string aString,
  97              [in] boolean bAbsorb );
  98
  99
 100     /** inserts a control character (like a paragraph break or a hard
 101         space) into the text.@see com::sun::star::text::ControlCharacter
 102      */
 103     void insertControlCharacter( [in] com::sun::star::text::XTextRange xRange,
 104              [in] short nControlCharacter,
 105              [in] boolean bAbsorb )
 106             raises( com::sun::star::lang::IllegalArgumentException );
 107
 108 };
 109
 110
 111 }; }; }; };
 112
 113 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */