xref: /aoo41x/main/offapi/com/sun/star/text/BaseFrame.idl (revision d1766043)
1*d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4*d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5*d1766043SAndrew Rist * distributed with this work for additional information
6*d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9*d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10*d1766043SAndrew Rist *
11*d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12*d1766043SAndrew Rist *
13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14*d1766043SAndrew Rist * software distributed under the License is distributed on an
15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17*d1766043SAndrew Rist * specific language governing permissions and limitations
18*d1766043SAndrew Rist * under the License.
19*d1766043SAndrew Rist *
20*d1766043SAndrew Rist *************************************************************/
21*d1766043SAndrew Rist
22*d1766043SAndrew Rist
23cdf0e10cSrcweir#ifndef __com_sun_star_text_BaseFrame_idl__
24cdf0e10cSrcweir#define __com_sun_star_text_BaseFrame_idl__
25cdf0e10cSrcweir
26cdf0e10cSrcweir#ifndef __com_sun_star_text_BaseFrameProperties_idl__
27cdf0e10cSrcweir#include <com/sun/star/text/BaseFrameProperties.idl>
28cdf0e10cSrcweir#endif
29cdf0e10cSrcweir
30cdf0e10cSrcweir#ifndef __com_sun_star_text_TextContent_idl__
31cdf0e10cSrcweir#include <com/sun/star/text/TextContent.idl>
32cdf0e10cSrcweir#endif
33cdf0e10cSrcweir
34cdf0e10cSrcweir#ifndef __com_sun_star_drawing_XShape_idl__
35cdf0e10cSrcweir#include <com/sun/star/drawing/XShape.idl>
36cdf0e10cSrcweir#endif
37cdf0e10cSrcweir
38cdf0e10cSrcweir#ifndef __com_sun_star_beans_XPropertySet_idl__
39cdf0e10cSrcweir#include <com/sun/star/beans/XPropertySet.idl>
40cdf0e10cSrcweir#endif
41cdf0e10cSrcweir
42cdf0e10cSrcweir#ifndef __com_sun_star_container_XNamed_idl__
43cdf0e10cSrcweir#include <com/sun/star/container/XNamed.idl>
44cdf0e10cSrcweir#endif
45cdf0e10cSrcweir#ifndef __com_sun_star_style_GraphicLocation_idl__
46cdf0e10cSrcweir#include <com/sun/star/style/GraphicLocation.idl>
47cdf0e10cSrcweir#endif
48cdf0e10cSrcweir#ifndef __com_sun_star_table_BorderLine_idl__
49cdf0e10cSrcweir#include <com/sun/star/table/BorderLine.idl>
50cdf0e10cSrcweir#endif
51cdf0e10cSrcweir#ifndef __com_sun_star_table_ShadowFormat_idl__
52cdf0e10cSrcweir#include <com/sun/star/table/ShadowFormat.idl>
53cdf0e10cSrcweir#endif
54cdf0e10cSrcweir#ifndef __com_sun_star_text_XTextFrame_idl__
55cdf0e10cSrcweir#include <com/sun/star/text/XTextFrame.idl>
56cdf0e10cSrcweir#endif
57cdf0e10cSrcweir
58cdf0e10cSrcweir//=============================================================================
59cdf0e10cSrcweir
60cdf0e10cSrcweir module com {  module sun {  module star {  module text {
61cdf0e10cSrcweir
62cdf0e10cSrcweir//=============================================================================
63cdf0e10cSrcweir
64cdf0e10cSrcweir/** specifies the base service of text frames, graphic objects, and embedded objects
65cdf0e10cSrcweir */
66cdf0e10cSrcweirpublished service BaseFrame
67cdf0e10cSrcweir{
68cdf0e10cSrcweir    service BaseFrameProperties;
69cdf0e10cSrcweir    service TextContent;
70cdf0e10cSrcweir    //-------------------------------------------------------------------------
71cdf0e10cSrcweir	/** This interface specifies the access to the shape data (position
72cdf0e10cSrcweir				and size) of the text frame.
73cdf0e10cSrcweir
74cdf0e10cSrcweir				<p>This interface is valid before the text frame is attached
75cdf0e10cSrcweir				to a surrounding text, but when attached the values can change
76cdf0e10cSrcweir				(e.g., due to a revised layout of the surrounding text).
77cdf0e10cSrcweir
78cdf0e10cSrcweir				<p>The position is relative to the position of the anchor
79cdf0e10cSrcweir				[see <member>XTextFrame::getAnchor()</member>]. Size and position are
80cdf0e10cSrcweir				both measured in 100th mm. The size is not valid if the
81cdf0e10cSrcweir				size is relative and no layout exists or if the layout is invalid.
82cdf0e10cSrcweir
83cdf0e10cSrcweir				<p>This interface is only for the layout.  In particular, the
84cdf0e10cSrcweir				setting of values is only allowed for the layout component of the
85cdf0e10cSrcweir				owner text of this text component.
86cdf0e10cSrcweir	 */
87cdf0e10cSrcweir	[optional] interface com::sun::star::drawing::XShape;
88cdf0e10cSrcweir	//-------------------------------------------------------------------------
89cdf0e10cSrcweir	/** This interface makes it possible to access the properties of
90cdf0e10cSrcweir				this text frame.
91cdf0e10cSrcweir
92cdf0e10cSrcweir				<p>This interface is valid before the text frame is attached to
93cdf0e10cSrcweir				a surrounding text.
94cdf0e10cSrcweir	 */
95cdf0e10cSrcweir	interface com::sun::star::beans::XPropertySet;
96cdf0e10cSrcweir	//-------------------------------------------------------------------------
97cdf0e10cSrcweir	/** This interface specifies the name of this text frame.
98cdf0e10cSrcweir
99cdf0e10cSrcweir				<p>The name may be set automatically by the container if it is not
100cdf0e10cSrcweir				set when inserted. In this case a random, unique name is assigned.
101cdf0e10cSrcweir	 */
102cdf0e10cSrcweir	interface com::sun::star::container::XNamed;
103cdf0e10cSrcweir    //-------------------------------------------------------------------------
104cdf0e10cSrcweir	/** contains the name of the frame style that is applied to this object.
105cdf0e10cSrcweir	 */
106cdf0e10cSrcweir	[property] string FrameStyleName;
107cdf0e10cSrcweir
108cdf0e10cSrcweir};
109cdf0e10cSrcweir
110cdf0e10cSrcweir//=============================================================================
111cdf0e10cSrcweir
112cdf0e10cSrcweir}; }; }; };
113cdf0e10cSrcweir
114cdf0e10cSrcweir#endif
115