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