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