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_BaseFrameProperties_idl__
24#define __com_sun_star_text_BaseFrameProperties_idl__
25
26#ifndef __com_sun_star_style_GraphicLocation_idl__
27#include <com/sun/star/style/GraphicLocation.idl>
28#endif
29#ifndef __com_sun_star_table_BorderLine_idl__
30#include <com/sun/star/table/BorderLine.idl>
31#endif
32#ifndef __com_sun_star_table_ShadowFormat_idl__
33#include <com/sun/star/table/ShadowFormat.idl>
34#endif
35#ifndef __com_sun_star_text_XTextFrame_idl__
36#include <com/sun/star/text/XTextFrame.idl>
37#endif
38#ifndef __com_sun_star_text_WrapTextMode_idl__
39#include <com/sun/star/text/WrapTextMode.idl>
40#endif
41#ifndef __com_sun_star_awt_Size_idl__
42#include <com/sun/star/awt/Size.idl>
43#endif
44#ifndef __com_sun_star_util_Color_idl__
45#include <com/sun/star/util/Color.idl>
46#endif
47#ifndef _com_sun_star_xml_UserDefinedAttributesSupplier_idl_
48#include <com/sun/star/xml/UserDefinedAttributesSupplier.idl>
49#endif
50
51//=============================================================================
52
53 module com {  module sun {  module star {  module text {
54
55//=============================================================================
56
57/** specifies the properties that are provided by all text frames, graphic objects, embedded objects
58 and frame styles.
59 */
60published service BaseFrameProperties
61{
62    /** gives access to the UserDefinedAttributes property.
63        @since OpenOffice 2.1
64     */
65    [optional] service com::sun::star::xml::UserDefinedAttributesSupplier;
66
67    //-------------------------------------------------------------------------
68	/** contains the number of the page where the objects are anchored.
69		<p> The value is valid only if the
70		AnchorType is
71		<const>TextContentAnchorType::AT_PAGE</const>.</p>
72	 */
73	[property] short AnchorPageNo;
74    //-------------------------------------------------------------------------
75    /** contains the text frame the current frame is anchored to.
76		<p> The value is valid only if the
77        AnchorType is <const>TextContentAnchorType::AT_FRAME</const>.</p>
78	 */
79    [property] com::sun::star::text::XTextFrame AnchorFrame;
80    //-------------------------------------------------------------------------
81	/** contains the color of the background of the object.
82	 */
83	[property] com::sun::star::util::Color BackColor;
84	//-------------------------------------------------------------------------
85	/** contains the URL for the background graphic.
86	 */
87	[property] string BackGraphicURL;
88
89	//-------------------------------------------------------------------------
90	/** contains the name of the file filter for the background graphic.
91	 */
92	[property] string BackGraphicFilter;
93
94	//-------------------------------------------------------------------------
95	/** determines the position of the background graphic.
96	 */
97	[property] com::sun::star::style::GraphicLocation BackGraphicLocation;
98
99	//-------------------------------------------------------------------------
100	/** contains the left border of the object.
101
102		@see BaseFrame::com::sun::star::table::BorderLine
103	 */
104	[property] com::sun::star::table::BorderLine LeftBorder;
105
106	//-------------------------------------------------------------------------
107	/** contains the right border of the object.
108
109		@see BaseFrame::com::sun::star::table::BorderLine
110	 */
111	[property] com::sun::star::table::BorderLine RightBorder;
112
113	//-------------------------------------------------------------------------
114	/** contains the top border of the object.
115
116		@see BaseFrame::com::sun::star::table::BorderLine
117	 */
118	[property] com::sun::star::table::BorderLine TopBorder;
119
120	//-------------------------------------------------------------------------
121	/** contains the bottom border of the object.
122
123		@see BaseFrame::com::sun::star::table::BorderLine
124	 */
125	[property] com::sun::star::table::BorderLine BottomBorder;
126
127	//-------------------------------------------------------------------------
128	/** contains the distance from the border to the object.
129	 */
130	[property] long BorderDistance;
131
132	//-------------------------------------------------------------------------
133	/** contains the distance from the left border to the object.
134	 */
135	[property] long LeftBorderDistance;
136
137	//-------------------------------------------------------------------------
138	/** contains the distance from the right border to the object.
139	 */
140	[property] long RightBorderDistance;
141
142	//-------------------------------------------------------------------------
143	/** contains the distance from the top border to the object.
144	 */
145	[property] long TopBorderDistance;
146
147	//-------------------------------------------------------------------------
148	/** contains the distance from the bottom border to the object.
149	 */
150	[property] long BottomBorderDistance;
151
152	//-------------------------------------------------------------------------
153	/** If TRUE, the "BackColor" is ignored.
154	 */
155	[property] boolean BackTransparent;
156
157	//-------------------------------------------------------------------------
158
159	/** determines if the content is protected.
160	 */
161	[property] boolean ContentProtected;
162    //-------------------------------------------------------------------------
163	/** contains the left margin of the object.
164	 */
165	[property] long LeftMargin;
166
167	//-------------------------------------------------------------------------
168	/** contains the right margin of the object.
169	 */
170	[property] long RightMargin;
171
172	//-------------------------------------------------------------------------
173
174	/** contains the top margin of the object.
175	 */
176	[property] long TopMargin;
177
178	//-------------------------------------------------------------------------
179	/** contains the bottom margin of the object.
180	 */
181	[property] long BottomMargin;
182
183	//-------------------------------------------------------------------------
184	/** contains the height of the object (1/100 mm).
185		<p>It is only valid if <member>TextEmbeddedObject::RelativeHeight</member> is zero.</p>
186	 */
187	[property] long Height;
188
189	//-------------------------------------------------------------------------
190	/** contains the width of the object (1/100 mm).
191		<p>It is only valid if <member>TextEmbeddedObject::RelativeWidth</member> is zero.</p>
192	 */
193	[property] long Width;
194	//-------------------------------------------------------------------------
195	/** contains the relative height of the object.
196		<p> It is only valid if it is greater than zero.</p>
197	 */
198	[property] short RelativeHeight;
199
200	//-------------------------------------------------------------------------
201	/** contains the relative width of the object.
202		<p> It is only valid if it is greater than zero. </p>
203	 */
204	[property] short RelativeWidth;
205	//-------------------------------------------------------------------------
206	/** determines whether the width follows the height.
207	 */
208	[property] boolean IsSyncWidthToHeight;
209	//-------------------------------------------------------------------------
210	/** determines whether the height follows the width.
211	 */
212	[property] boolean IsSyncHeightToWidth;
213	//-------------------------------------------------------------------------
214	/** determines the horizontal orientation of the object.
215
216		@see BaseFrame::HoriOrientation
217	 */
218	[property] short HoriOrient;
219	//-------------------------------------------------------------------------
220	/** contains the horizontal position of the object (1/100 mm).
221		<p> It is only valid if "HoriOrient" is HoriOrientation_NONE.</p>
222	 */
223	[property] long HoriOrientPosition;
224
225	//-------------------------------------------------------------------------
226	/** determines the environment of the object to which the orientation
227		is related.
228
229		@see BaseFrame::RelOrientation
230	 */
231	[property] short HoriOrientRelation;
232
233	//-------------------------------------------------------------------------
234	/** determines the vertical orientation of the object.
235
236		@see BaseFrame::VertOrientation
237	 */
238	[property] short VertOrient;
239
240	//-------------------------------------------------------------------------
241	/** contains the vertical position of the object (1/100 mm).
242
243		It is only valid if <member>TextEmbeddedObject::VertOrient</member> is
244		<const>VertOrientation::NONE</const>.
245	 */
246	[property] long VertOrientPosition;
247
248	//-------------------------------------------------------------------------
249
250	/** determines the environment of the object to which the orientation is related.
251
252		@see BaseFrame::RelOrientation
253	 */
254	[property] short VertOrientRelation;
255
256	//-------------------------------------------------------------------------
257	/** contains the URL of a hyperlink that is set at the object.
258	 */
259	[property] string HyperLinkURL;
260
261	//-------------------------------------------------------------------------
262	/** contains the name of the target for a hyperlink that is set at the object.
263	 */
264	[property] string HyperLinkTarget;
265
266	//-------------------------------------------------------------------------
267	/** contains the name of the hyperlink that is set at the object.
268	 */
269	[property] string HyperLinkName;
270
271	//-------------------------------------------------------------------------
272	/** determines if the object is opaque or transparent for text.
273	 */
274	[property] boolean Opaque;
275
276	//-------------------------------------------------------------------------
277	/** determines if the object is mirrored on even pages.
278	 */
279	[property] boolean PageToggle;
280
281	//-------------------------------------------------------------------------
282	/** determines if the position is protected.
283	 */
284	[property] boolean PositionProtected;
285
286	//-------------------------------------------------------------------------
287	/** determines if the object is included in printing.
288	 */
289	[property] boolean Print;
290
291	//-------------------------------------------------------------------------
292	/** contains the type of the shadow of the object.
293	 */
294	[property] com::sun::star::table::ShadowFormat ShadowFormat;
295
296	//-------------------------------------------------------------------------
297	/** determines if the object gets an image map from a server.
298	 */
299	[property] boolean ServerMap;
300
301	//-------------------------------------------------------------------------
302	/** contains the size of the object.
303
304		@see BaseFrame::Height
305		@see BaseFrame::Width
306	 */
307	[property] com::sun::star::awt::Size Size;
308
309	//-------------------------------------------------------------------------
310	/** determines if the size is protected.
311	 */
312	[property] boolean SizeProtected;
313	//-------------------------------------------------------------------------
314	/** determines the type of the surrounding text.
315
316        @deprecated
317	 */
318        [property] com::sun::star::text::WrapTextMode Surround;
319
320	//-------------------------------------------------------------------------
321	/** determines if the text of the paragraph in which the object
322		is anchored, wraps around the object.
323	 */
324	[property] boolean SurroundAnchorOnly;
325
326    //-------------------------------------------------------------------------
327    /** determines the influence of the text wrap on the positioning of the
328        shape
329
330        <p>The value of this property is only evaluated for the positioning
331        of the shape, if the text document setting ConsiderTextWrapOnObjPos
332        is <TRUE/>. Valid values are given by <member>WrapInfluenceOnPosition</member></p>
333
334        @since OpenOffice 2.0
335     */
336    [optional, property] short WrapInfluenceOnPosition;
337
338    //-------------------------------------------------------------------------
339    /** returns the actual size of the object.
340
341        <p>Since to obtain the correct actual size of the object not only
342        the  layouting for the frame needs to be finished but the whole
343        document needs to be formatted as well. Thus if that was not done
344        previously it may take some while to retrieve this value.</p>
345
346        @since OpenOffice 2.0.4
347     */
348    [optional, property, maybevoid] com::sun::star::awt::Size LayoutSize;
349
350    //-------------------------------------------------------------------------
351        /** contains short title for the object
352
353            <p>This short title is visible as an alternative tag in HTML format.
354            Accessibility tools can read this text.</p>
355
356            @since OpenOffice 3.2
357        */
358        [optional, property] string Title;
359
360    //-------------------------------------------------------------------------
361        /** contains description for the object
362
363            <p>The long description text can be entered to describe a object in
364            more detail to users with screen reader software. The description is
365            visible as an alternative tag for accessibility tools.</p>
366
367            @since OpenOffice 3.2
368        */
369        [optional, property] string Description;
370};
371
372//=============================================================================
373
374}; }; }; };
375
376#endif
377