xref: /aoo41x/main/offapi/com/sun/star/text/BaseFrame.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_BaseFrame_idl__
24#define __com_sun_star_text_BaseFrame_idl__
25
26#ifndef __com_sun_star_text_BaseFrameProperties_idl__
27#include <com/sun/star/text/BaseFrameProperties.idl>
28#endif
29
30#ifndef __com_sun_star_text_TextContent_idl__
31#include <com/sun/star/text/TextContent.idl>
32#endif
33
34#ifndef __com_sun_star_drawing_XShape_idl__
35#include <com/sun/star/drawing/XShape.idl>
36#endif
37
38#ifndef __com_sun_star_beans_XPropertySet_idl__
39#include <com/sun/star/beans/XPropertySet.idl>
40#endif
41
42#ifndef __com_sun_star_container_XNamed_idl__
43#include <com/sun/star/container/XNamed.idl>
44#endif
45#ifndef __com_sun_star_style_GraphicLocation_idl__
46#include <com/sun/star/style/GraphicLocation.idl>
47#endif
48#ifndef __com_sun_star_table_BorderLine_idl__
49#include <com/sun/star/table/BorderLine.idl>
50#endif
51#ifndef __com_sun_star_table_ShadowFormat_idl__
52#include <com/sun/star/table/ShadowFormat.idl>
53#endif
54#ifndef __com_sun_star_text_XTextFrame_idl__
55#include <com/sun/star/text/XTextFrame.idl>
56#endif
57
58//=============================================================================
59
60 module com {  module sun {  module star {  module text {
61
62//=============================================================================
63
64/** specifies the base service of text frames, graphic objects, and embedded objects
65 */
66published service BaseFrame
67{
68    service BaseFrameProperties;
69    service TextContent;
70    //-------------------------------------------------------------------------
71	/** This interface specifies the access to the shape data (position
72				and size) of the text frame.
73
74				<p>This interface is valid before the text frame is attached
75				to a surrounding text, but when attached the values can change
76				(e.g., due to a revised layout of the surrounding text).
77
78				<p>The position is relative to the position of the anchor
79				[see <member>XTextFrame::getAnchor()</member>]. Size and position are
80				both measured in 100th mm. The size is not valid if the
81				size is relative and no layout exists or if the layout is invalid.
82
83				<p>This interface is only for the layout.  In particular, the
84				setting of values is only allowed for the layout component of the
85				owner text of this text component.
86	 */
87	[optional] interface com::sun::star::drawing::XShape;
88	//-------------------------------------------------------------------------
89	/** This interface makes it possible to access the properties of
90				this text frame.
91
92				<p>This interface is valid before the text frame is attached to
93				a surrounding text.
94	 */
95	interface com::sun::star::beans::XPropertySet;
96	//-------------------------------------------------------------------------
97	/** This interface specifies the name of this text frame.
98
99				<p>The name may be set automatically by the container if it is not
100				set when inserted. In this case a random, unique name is assigned.
101	 */
102	interface com::sun::star::container::XNamed;
103    //-------------------------------------------------------------------------
104	/** contains the name of the frame style that is applied to this object.
105	 */
106	[property] string FrameStyleName;
107
108};
109
110//=============================================================================
111
112}; }; }; };
113
114#endif
115