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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_text_XText_idl__
  28 #define __com_sun_star_text_XText_idl__
  29
  30 #ifndef __com_sun_star_text_XSimpleText_idl__
  31 #include <com/sun/star/text/XSimpleText.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_text_XTextCursor_idl__
  35 #include <com/sun/star/text/XTextCursor.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  39 #include <com/sun/star/lang/IllegalArgumentException.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_text_XTextContent_idl__
  43 #include <com/sun/star/text/XTextContent.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_container_NoSuchElementException_idl__
  47 #include <com/sun/star/container/NoSuchElementException.idl>
  48 #endif
  49
  50
  51 //=============================================================================
  52
  53  module com {  module sun {  module star {  module text {
  54
  55 //=============================================================================
  56
  57 /** extends a <type>XSimpleText</type> by the capability of inserting
  58         <type>XTextContent</type>s.
  59  */
  60 published interface XText: com::sun::star::text::XSimpleText
  61 {
  62     //-------------------------------------------------------------------------
  63
  64     /** inserts a content, such as a text table, text frame or text
  65         field.
  66
  67         <p>Which contents are accepted is implementation-specific. Some
  68         implementations may only accept contents which were created by the
  69         factory that supplied the same text or the document which contains
  70         the text.
  71         </p>
  72
  73         @param xRange
  74             specifies the position of insertion.
  75
  76         @param xContent
  77             the text content to be inserted.
  78
  79         @param bAbsorb
  80             specifies whether the text spanned by <var>xRange</var> will be
  81             replaced. If <TRUE/> then the content of <var>xRange</var> will
  82             be replaced by <var>xContent</var>, otherwise <var>xContent</var>
  83             will be inserted at the end of <var>xRange</var>.
  84      */
  85     void insertTextContent( [in] com::sun::star::text::XTextRange xRange,
  86              [in] com::sun::star::text::XTextContent xContent,
  87              [in] boolean bAbsorb )
  88             raises( com::sun::star::lang::IllegalArgumentException );
  89
  90     //-------------------------------------------------------------------------
  91
  92     /** removes the specified content from the text object.
  93
  94         @example xDoc.removeTextContent( xDoc.TextTables.MyOwnTableName )
  95      */
  96     void removeTextContent( [in] com::sun::star::text::XTextContent xContent )
  97             raises( com::sun::star::container::NoSuchElementException );
  98
  99 };
 100
 101 //=============================================================================
 102
 103 }; }; }; };
 104
 105 #endif