xref: /aoo41x/main/offapi/com/sun/star/text/XText.idl (revision d1766043)
1*d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4*d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5*d1766043SAndrew Rist * distributed with this work for additional information
6*d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9*d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10*d1766043SAndrew Rist *
11*d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12*d1766043SAndrew Rist *
13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14*d1766043SAndrew Rist * software distributed under the License is distributed on an
15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17*d1766043SAndrew Rist * specific language governing permissions and limitations
18*d1766043SAndrew Rist * under the License.
19*d1766043SAndrew Rist *
20*d1766043SAndrew Rist *************************************************************/
21*d1766043SAndrew Rist
22*d1766043SAndrew Rist
23cdf0e10cSrcweir#ifndef __com_sun_star_text_XText_idl__
24cdf0e10cSrcweir#define __com_sun_star_text_XText_idl__
25cdf0e10cSrcweir
26cdf0e10cSrcweir#ifndef __com_sun_star_text_XSimpleText_idl__
27cdf0e10cSrcweir#include <com/sun/star/text/XSimpleText.idl>
28cdf0e10cSrcweir#endif
29cdf0e10cSrcweir
30cdf0e10cSrcweir#ifndef __com_sun_star_text_XTextCursor_idl__
31cdf0e10cSrcweir#include <com/sun/star/text/XTextCursor.idl>
32cdf0e10cSrcweir#endif
33cdf0e10cSrcweir
34cdf0e10cSrcweir#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
35cdf0e10cSrcweir#include <com/sun/star/lang/IllegalArgumentException.idl>
36cdf0e10cSrcweir#endif
37cdf0e10cSrcweir
38cdf0e10cSrcweir#ifndef __com_sun_star_text_XTextContent_idl__
39cdf0e10cSrcweir#include <com/sun/star/text/XTextContent.idl>
40cdf0e10cSrcweir#endif
41cdf0e10cSrcweir
42cdf0e10cSrcweir#ifndef __com_sun_star_container_NoSuchElementException_idl__
43cdf0e10cSrcweir#include <com/sun/star/container/NoSuchElementException.idl>
44cdf0e10cSrcweir#endif
45cdf0e10cSrcweir
46cdf0e10cSrcweir
47cdf0e10cSrcweir//=============================================================================
48cdf0e10cSrcweir
49cdf0e10cSrcweir module com {  module sun {  module star {  module text {
50cdf0e10cSrcweir
51cdf0e10cSrcweir//=============================================================================
52cdf0e10cSrcweir
53cdf0e10cSrcweir/** extends a <type>XSimpleText</type> by the capability of inserting
54cdf0e10cSrcweir		<type>XTextContent</type>s.
55cdf0e10cSrcweir */
56cdf0e10cSrcweirpublished interface XText: com::sun::star::text::XSimpleText
57cdf0e10cSrcweir{
58cdf0e10cSrcweir	//-------------------------------------------------------------------------
59cdf0e10cSrcweir
60cdf0e10cSrcweir	/** inserts a content, such as a text table, text frame or text
61cdf0e10cSrcweir		field.
62cdf0e10cSrcweir
63cdf0e10cSrcweir		<p>Which contents are accepted is implementation-specific. Some
64cdf0e10cSrcweir		implementations may only accept contents which were created by the
65cdf0e10cSrcweir		factory that supplied the same text or the document which contains
66cdf0e10cSrcweir		the text.
67cdf0e10cSrcweir		</p>
68cdf0e10cSrcweir
69cdf0e10cSrcweir        @param xRange
70cdf0e10cSrcweir            specifies the position of insertion.
71cdf0e10cSrcweir
72cdf0e10cSrcweir        @param xContent
73cdf0e10cSrcweir            the text content to be inserted.
74cdf0e10cSrcweir
75cdf0e10cSrcweir        @param bAbsorb
76cdf0e10cSrcweir            specifies whether the text spanned by <var>xRange</var> will be
77cdf0e10cSrcweir            replaced. If <TRUE/> then the content of <var>xRange</var> will
78cdf0e10cSrcweir            be replaced by <var>xContent</var>, otherwise <var>xContent</var>
79cdf0e10cSrcweir            will be inserted at the end of <var>xRange</var>.
80cdf0e10cSrcweir	 */
81cdf0e10cSrcweir	void insertTextContent( [in] com::sun::star::text::XTextRange xRange,
82cdf0e10cSrcweir			 [in] com::sun::star::text::XTextContent xContent,
83cdf0e10cSrcweir			 [in] boolean bAbsorb )
84cdf0e10cSrcweir			raises( com::sun::star::lang::IllegalArgumentException );
85cdf0e10cSrcweir
86cdf0e10cSrcweir	//-------------------------------------------------------------------------
87cdf0e10cSrcweir
88cdf0e10cSrcweir	/** removes the specified content from the text object.
89cdf0e10cSrcweir
90cdf0e10cSrcweir		@example xDoc.removeTextContent( xDoc.TextTables.MyOwnTableName )
91cdf0e10cSrcweir	 */
92cdf0e10cSrcweir	void removeTextContent( [in] com::sun::star::text::XTextContent xContent )
93cdf0e10cSrcweir			raises( com::sun::star::container::NoSuchElementException );
94cdf0e10cSrcweir
95cdf0e10cSrcweir};
96cdf0e10cSrcweir
97cdf0e10cSrcweir//=============================================================================
98cdf0e10cSrcweir
99cdf0e10cSrcweir}; }; }; };
100cdf0e10cSrcweir
101cdf0e10cSrcweir#endif
102