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_XTextContent_idl__
24#define __com_sun_star_text_XTextContent_idl__
25
26#ifndef __com_sun_star_lang_XComponent_idl__
27#include <com/sun/star/lang/XComponent.idl>
28#endif
29
30#ifndef __com_sun_star_text_XTextRange_idl__
31#include <com/sun/star/text/XTextRange.idl>
32#endif
33
34#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
35#include <com/sun/star/lang/IllegalArgumentException.idl>
36#endif
37
38
39//=============================================================================
40
41 module com {  module sun {  module star {  module text {
42
43//=============================================================================
44
45/** enables objects to be inserted into a text and to provide their
46    location in a text once they are inserted into it.
47 */
48published interface XTextContent: com::sun::star::lang::XComponent
49{
50	//-------------------------------------------------------------------------
51
52	/** is called when this object gets embedded in a text.
53
54
55
56		<p>This acts like a multi-phase construction, thus the object may be
57		invalid until it is attached to a text position. In general, this method
58		is called from within
59
60
61
62
63		.
64
65		</p>
66		<p>Both text objects and text content objects may only be connected
67		to each other if they are created by the same component. When
68		implementing new components, this behaviour is deprecated.</p>
69	 */
70	void attach( [in] com::sun::star::text::XTextRange xTextRange )
71			raises( com::sun::star::lang::IllegalArgumentException );
72
73	//-------------------------------------------------------------------------
74
75	/** @returns
76				the text range to which the content is attached.
77
78        <p>Note: The anchor of the actual implementation for text tables
79        does not have a position in the text. Thus that anchor can not be
80        used for some operation like <member>attach</member> for example or
81        <member scope="com::sun::star::text">insertTextContent</member>
82        or other function that require the object to have a position in the text.</p>
83
84        <p>The reason why a text table still needs an anchor is that for example
85        tables should be insertable via <member scope="com::sun::star::text">insertTextContent</member>
86        and that interface uses a parameter of that type.</p>
87	 */
88	com::sun::star::text::XTextRange getAnchor();
89
90};
91
92//=============================================================================
93
94}; }; }; };
95
96#endif
97