offapi/com/sun/star/text/XText.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: XText.idl,v $
  10  * $Revision: 1.11 $
  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_XText_idl__
  31 #define __com_sun_star_text_XText_idl__
  32
  33 #ifndef __com_sun_star_text_XSimpleText_idl__
  34 #include <com/sun/star/text/XSimpleText.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 /** extends a <type>XSimpleText</type> by the capability of inserting
  61         <type>XTextContent</type>s.
  62  */
  63 published interface XText: com::sun::star::text::XSimpleText
  64 {
  65     //-------------------------------------------------------------------------
  66
  67     /** inserts a content, such as a text table, text frame or text
  68         field.
  69
  70         <p>Which contents are accepted is implementation-specific. Some
  71         implementations may only accept contents which were created by the
  72         factory that supplied the same text or the document which contains
  73         the text.
  74         </p>
  75
  76         @param xRange
  77             specifies the position of insertion.
  78
  79         @param xContent
  80             the text content to be inserted.
  81
  82         @param bAbsorb
  83             specifies whether the text spanned by <var>xRange</var> will be
  84             replaced. If <TRUE/> then the content of <var>xRange</var> will
  85             be replaced by <var>xContent</var>, otherwise <var>xContent</var>
  86             will be inserted at the end of <var>xRange</var>.
  87      */
  88     void insertTextContent( [in] com::sun::star::text::XTextRange xRange,
  89              [in] com::sun::star::text::XTextContent xContent,
  90              [in] boolean bAbsorb )
  91             raises( com::sun::star::lang::IllegalArgumentException );
  92
  93     //-------------------------------------------------------------------------
  94
  95     /** removes the specified content from the text object.
  96
  97         @example xDoc.removeTextContent( xDoc.TextTables.MyOwnTableName )
  98      */
  99     void removeTextContent( [in] com::sun::star::text::XTextContent xContent )
 100             raises( com::sun::star::container::NoSuchElementException );
 101
 102 };
 103
 104 //=============================================================================
 105
 106 }; }; }; };
 107
 108 #endif