xref: /AOO41X/main/offapi/com/sun/star/text/TextContent.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
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_TextContent_idl__
24#define __com_sun_star_text_TextContent_idl__
25
26#ifndef __com_sun_star_text_XTextContent_idl__
27#include <com/sun/star/text/XTextContent.idl>
28#endif
29
30#ifndef __com_sun_star_text_TextContentAnchorType_idl__
31#include <com/sun/star/text/TextContentAnchorType.idl>
32#endif
33
34#ifndef __com_sun_star_text_WrapTextMode_idl__
35#include <com/sun/star/text/WrapTextMode.idl>
36#endif
37
38
39//=============================================================================
40
41module com { module sun { module star { module text {
42
43//=============================================================================
44/** is an object which can be anchored in a text, like instances of
45    <type>TextFrame</type> or <type>TextField</type>.
46
47    <p>If the concrete <type>TextContent</type> has a textual
48    representation which fades into the surrounding text, then
49    <type>XTextField</type> is used.
50
51    <p>If the concrete <type>TextContent</type> has a "floating" object,
52    like a graphic, <type scope="com::sun::star::drawing">XShape</type>
53    is used.
54
55    @see TextField
56    @see TextTable
57    @see TextFrame
58    @see TextSection
59    @see TextGraphicObject
60    @see TextEmbeddedObject
61*/
62published service TextContent
63{
64
65    /** This interface is used for the attachment of this text content
66        to the surrounding text.
67    */
68    interface com::sun::star::text::XTextContent;
69
70    //-------------------------------------------------------------------------
71    /** specifies how the text content is attached to its surrounding
72        <type>Text</type>.
73    */
74    [optional, property] com::sun::star::text::TextContentAnchorType AnchorType;
75
76    //-------------------------------------------------------------------------
77    /** contains the anchor type of the text content.
78     @see com::sun::star::text::TextContentAnchorType
79     */
80    [optional, readonly, property] sequence<com::sun::star::text::TextContentAnchorType> AnchorTypes;
81
82    //-------------------------------------------------------------------------
83    /** specifies if the text content is a shape
84        and how the text is wrapped around the shape.
85    */
86    [optional, property] com::sun::star::text::WrapTextMode TextWrap;
87
88};
89
90//=============================================================================
91
92}; }; }; };
93
94#endif
95