1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef __com_sun_star_text_BaseFrameProperties_idl__
#define __com_sun_star_text_BaseFrameProperties_idl__
#include <com/sun/star/style/GraphicLocation.idl>
#include <com/sun/star/table/BorderLine.idl>
#include <com/sun/star/table/ShadowFormat.idl>
#include <com/sun/star/text/XTextFrame.idl>
#include <com/sun/star/text/WrapTextMode.idl>
#include <com/sun/star/awt/Size.idl>
#include <com/sun/star/util/Color.idl>
#include <com/sun/star/xml/UserDefinedAttributesSupplier.idl>
#include <com/sun/star/drawing/FillStyle.idl>
#include <com/sun/star/awt/Gradient.idl>
module com { module sun { module star { module text {
/** specifies the properties that are provided by all text frames, graphic objects, embedded objects
and frame styles.
*/
published service BaseFrameProperties
{
/** gives access to the UserDefinedAttributes property.
@since OOo 2.1
*/
[optional] service com::sun::star::xml::UserDefinedAttributesSupplier;
/** contains the number of the page where the objects are anchored.
<p> The value is valid only if the
AnchorType is
<const>TextContentAnchorType::AT_PAGE</const>.</p>
*/
[property] short AnchorPageNo;
/** contains the text frame the current frame is anchored to.
<p> The value is valid only if the
AnchorType is <const>TextContentAnchorType::AT_FRAME</const>.</p>
*/
[property] com::sun::star::text::XTextFrame AnchorFrame;
/** contains the color of the background of the object.
*/
[property] com::sun::star::util::Color BackColor;
/** contains the URL for the background graphic.
*/
[property] string BackGraphicURL;
/** contains the name of the file filter for the background graphic.
*/
[property] string BackGraphicFilter;
/** determines the position of the background graphic.
*/
[property] com::sun::star::style::GraphicLocation BackGraphicLocation;
/** contains the left border of the object.
@see BaseFrame::com::sun::star::table::BorderLine
*/
[property] com::sun::star::table::BorderLine LeftBorder;
/** contains the right border of the object.
@see BaseFrame::com::sun::star::table::BorderLine
*/
[property] com::sun::star::table::BorderLine RightBorder;
/** contains the top border of the object.
@see BaseFrame::com::sun::star::table::BorderLine
*/
[property] com::sun::star::table::BorderLine TopBorder;
/** contains the bottom border of the object.
@see BaseFrame::com::sun::star::table::BorderLine
*/
[property] com::sun::star::table::BorderLine BottomBorder;
/** contains the distance from the border to the object.
*/
[property] long BorderDistance;
/** contains the distance from the left border to the object.
*/
[property] long LeftBorderDistance;
/** contains the distance from the right border to the object.
*/
[property] long RightBorderDistance;
/** contains the distance from the top border to the object.
*/
[property] long TopBorderDistance;
/** contains the distance from the bottom border to the object.
*/
[property] long BottomBorderDistance;
/** If TRUE, the "BackColor" is ignored.
*/
[property] boolean BackTransparent;
/** determines if the content is protected.
*/
[property] boolean ContentProtected;
/** contains the left margin of the object.
*/
[property] long LeftMargin;
/** contains the right margin of the object.
*/
[property] long RightMargin;
/** contains the top margin of the object.
*/
[property] long TopMargin;
/** contains the bottom margin of the object.
*/
[property] long BottomMargin;
/** contains the height of the object (1/100 mm).
<p>It is only valid if <member>TextEmbeddedObject::RelativeHeight</member> is zero.</p>
*/
[property] long Height;
/** contains the width of the object (1/100 mm).
<p>It is only valid if <member>TextEmbeddedObject::RelativeWidth</member> is zero.</p>
*/
[property] long Width;
/** contains the relative height of the object.
<p> It is only valid if it is greater than zero.</p>
*/
[property] short RelativeHeight;
/** contains the relative width of the object.
<p> It is only valid if it is greater than zero. </p>
*/
[property] short RelativeWidth;
/** determines whether the width follows the height.
*/
[property] boolean IsSyncWidthToHeight;
/** determines whether the height follows the width.
*/
[property] boolean IsSyncHeightToWidth;
/** determines the horizontal orientation of the object.
@see BaseFrame::HoriOrientation
*/
[property] short HoriOrient;
/** contains the horizontal position of the object (1/100 mm).
<p> It is only valid if "HoriOrient" is HoriOrientation_NONE.</p>
*/
[property] long HoriOrientPosition;
/** determines the environment of the object to which the orientation
is related.
@see BaseFrame::RelOrientation
*/
[property] short HoriOrientRelation;
/** determines the vertical orientation of the object.
@see BaseFrame::VertOrientation
*/
[property] short VertOrient;
/** contains the vertical position of the object (1/100 mm).
It is only valid if <member>TextEmbeddedObject::VertOrient</member> is
<const>VertOrientation::NONE</const>.
*/
[property] long VertOrientPosition;
/** determines the environment of the object to which the orientation is related.
@see BaseFrame::RelOrientation
*/
[property] short VertOrientRelation;
/** contains the URL of a hyperlink that is set at the object.
*/
[property] string HyperLinkURL;
/** contains the name of the target for a hyperlink that is set at the object.
*/
[property] string HyperLinkTarget;
/** contains the name of the hyperlink that is set at the object.
*/
[property] string HyperLinkName;
/** determines if the object is opaque or transparent for text.
*/
[property] boolean Opaque;
/** determines if the object is mirrored on even pages.
*/
[property] boolean PageToggle;
/** determines if the position is protected.
*/
[property] boolean PositionProtected;
/** determines if the object is included in printing.
*/
[property] boolean Print;
/** contains the type of the shadow of the object.
*/
[property] com::sun::star::table::ShadowFormat ShadowFormat;
/** determines if the object gets an image map from a server.
*/
[property] boolean ServerMap;
/** contains the size of the object.
@see BaseFrame::Height
@see BaseFrame::Width
*/
[property] com::sun::star::awt::Size Size;
/** determines if the size is protected.
*/
[property] boolean SizeProtected;
/** determines the type of the surrounding text.
@deprecated
*/
[property] com::sun::star::text::WrapTextMode Surround;
/** determines if the text of the paragraph in which the object
is anchored, wraps around the object.
*/
[property] boolean SurroundAnchorOnly;
/** determines the influence of the text wrap on the positioning of the
shape
<p>The value of this property is only evaluated for the positioning
of the shape, if the text document setting ConsiderTextWrapOnObjPos
is <TRUE/>. Valid values are given by #WrapInfluenceOnPosition</p>
@since OOo 2.0
*/
[optional, property] short WrapInfluenceOnPosition;
/** returns the actual size of the object.
<p>Since to obtain the correct actual size of the object not only
the layouting for the frame needs to be finished but the whole
document needs to be formatted as well. Thus if that was not done
previously it may take some while to retrieve this value.</p>
@since OOo 2.0.4
*/
[optional, property, maybevoid] com::sun::star::awt::Size LayoutSize;
/** contains short title for the object
<p>This short title is visible as an alternative tag in HTML format.
Accessibility tools can read this text.</p>
@since OOo 3.2
*/
[optional, property] string Title;
/** contains description for the object
<p>The long description text can be entered to describe a object in
more detail to users with screen reader software. The description is
visible as an alternative tag for accessibility tools.</p>
@since OOo 3.2
*/
[optional, property] string Description;
/** This enumeration selects the style the area will be filled with.
<p>Currently only set for gradients.</p>
@since LibreOffice 4.1
*/
[optional, property] com::sun::star::drawing::FillStyle FillStyle;
/** If the property #FillStyle is set to <const>
FillStyle::GRADIENT</const>, this describes the gradient used.
@since LibreOffice 4.1
*/
[optional, property] com::sun::star::awt::Gradient FillGradient;
/** If the property #FillStyle is set to <const>
FillStyle::GRADIENT</const>, this is the name of the gradient used.
@since LibreOffice 4.1
*/
[optional, property] string FillGradientName;
};
}; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|