xref: /AOO41X/main/offapi/com/sun/star/sheet/TableAutoFormatField.idl (revision fbef625e460ef3feded438b39e36a4c8f360d8f1)
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
24#ifndef __com_sun_star_sheet_TableAutoFormatField_idl__
25#define __com_sun_star_sheet_TableAutoFormatField_idl__
26
27#ifndef __com_sun_star_beans_XPropertySet_idl__
28#include <com/sun/star/beans/XPropertySet.idl>
29#endif
30
31#ifndef __com_sun_star_util_Color_idl__
32#include <com/sun/star/util/Color.idl>
33#endif
34
35#ifndef __com_sun_star_lang_Locale_idl__
36#include <com/sun/star/lang/Locale.idl>
37#endif
38
39#ifndef __com_sun_star_awt_FontSlant_idl__
40#include <com/sun/star/awt/FontSlant.idl>
41#endif
42
43#ifndef __com_sun_star_table_ShadowFormat_idl__
44#include <com/sun/star/table/ShadowFormat.idl>
45#endif
46
47#ifndef __com_sun_star_table_CellHoriJustify_idl__
48#include <com/sun/star/table/CellHoriJustify.idl>
49#endif
50
51#ifndef __com_sun_star_table_CellVertJustify_idl__
52#include <com/sun/star/table/CellVertJustify.idl>
53#endif
54
55#ifndef __com_sun_star_table_CellOrientation_idl__
56#include <com/sun/star/table/CellOrientation.idl>
57#endif
58
59#ifndef __com_sun_star_table_TableBorder_idl__
60#include <com/sun/star/table/TableBorder.idl>
61#endif
62
63//=============================================================================
64
65module com {  module sun {  module star {  module sheet {
66
67//=============================================================================
68
69/** represents a field in an AutoFormat. A field contains all cell
70    properties for a specific position in an AutoFormat.
71 */
72published service TableAutoFormatField
73{
74    //-------------------------------------------------------------------------
75
76//! service com::sun::star::beans::PropertySet;
77    /** provides access to the properties.
78     */
79    interface com::sun::star::beans::XPropertySet;
80
81    //-------------------------------------------------------------------------
82
83    /** specifies the name of the western font.
84     */
85    [property] string CharFontName;
86
87    /** specifies the name of the asian font.
88     */
89    [optional, property] string CharFontNameAsian;
90
91    /** specifies the name of the complex font.
92     */
93    [optional, property] string CharFontNameComplex;
94
95    //-------------------------------------------------------------------------
96
97    /** specifies the name of the western font style.
98     */
99    [property] string CharFontStyleName;
100
101    /** specifies the name of the asian font style.
102     */
103    [optional, property] string CharFontStyleNameAsian;
104
105    /** specifies the name of the complex font style.
106     */
107    [optional, property] string CharFontStyleNameComplex;
108
109    //-------------------------------------------------------------------------
110
111    /** contains the value of the character set of the western font.
112     */
113    [property] string CharFontCharSet;
114
115    /** contains the value of the character set of the asian font.
116     */
117    [optional, property] string CharFontCharSetAsian;
118
119    /** contains the value of the character set of the complex font.
120     */
121    [optional, property] string CharFontCharSetComplex;
122
123    //-------------------------------------------------------------------------
124
125    /** contains the value of the western font family.
126     */
127    [property] string CharFontFamily;
128
129    /** contains the value of the asian font family.
130     */
131    [optional, property] string CharFontFamilyAsian;
132
133    /** contains the value of the complex font family.
134     */
135    [optional, property] string CharFontFamilyComplex;
136
137    //-------------------------------------------------------------------------
138
139    /** contains the value of the pitch of the western font.
140     */
141    [property] string CharFontPitch;
142
143    /** contains the value of the pitch of the asian font.
144     */
145    [optional, property] string CharFontPitchAsian;
146
147    /** contains the value of the pitch of the complex font.
148     */
149    [optional, property] string CharFontPitchComplex;
150
151    //-------------------------------------------------------------------------
152
153    /** contains the height of characters of the western font in point.
154     */
155    [property] float CharHeight;
156
157    /** contains the height of characters of the asian font in point.
158     */
159    [optional, property] float CharHeightAsian;
160
161    /** contains the height of characters of the complex font in point.
162     */
163    [optional, property] float CharHeightComplex;
164
165    //-------------------------------------------------------------------------
166
167    /** contains the value for the weight of characters of the western font.
168     */
169    [property] float CharWeight;
170
171    /** contains the value for the weight of characters of the asian font.
172     */
173    [optional, property] float CharWeightAsian;
174
175    /** contains the value for the weight of characters of the complex font.
176     */
177    [optional, property] float CharWeightComplex;
178
179    //-------------------------------------------------------------------------
180
181    /** contains the value of the posture of characters of the western font.
182     */
183    [property] com::sun::star::awt::FontSlant CharPosture;
184
185    /** contains the value of the posture of characters of the asian font.
186     */
187    [optional, property] com::sun::star::awt::FontSlant CharPostureAsian;
188
189    /** contains the value of the posture of characters of the comlex font.
190     */
191    [optional, property] com::sun::star::awt::FontSlant CharPostureComplex;
192
193    //-------------------------------------------------------------------------
194
195    /** contains the value for the character underline.
196     */
197    [property] short CharUnderline;
198
199    //-------------------------------------------------------------------------
200
201    /** is <TRUE/> if the characters are crossed out.
202     */
203    [property] boolean CharCrossedOut;
204
205    //-------------------------------------------------------------------------
206
207    /** is <TRUE/> if the characters are contoured.
208     */
209    [property] boolean CharContoured;
210
211    //-------------------------------------------------------------------------
212
213    /** is <TRUE/> if the characters are shadowed.
214     */
215    [property] boolean CharShadowed;
216
217    //-------------------------------------------------------------------------
218
219    /** contains the value of the text color.
220     */
221    [property] com::sun::star::util::Color CharColor;
222
223    //-------------------------------------------------------------------------
224
225    /** contains the cell background color.
226     */
227    [property] com::sun::star::util::Color CellBackColor;
228
229    //-------------------------------------------------------------------------
230
231    /** is <TRUE/> if the cell background is transparent.
232
233        <p>In this case the <member>TableAutoFormatField::CellBackColor</member>
234        value is not used.</p>
235     */
236    [property] boolean IsCellBackgroundTransparent;
237
238    //-------------------------------------------------------------------------
239
240    /** contains a description of the shadow.
241     */
242    [optional, property] com::sun::star::table::ShadowFormat ShadowFormat;
243
244    //-------------------------------------------------------------------------
245
246    /** specifies the horizontal alignment of the cell contents.
247     */
248    [optional, property] com::sun::star::table::CellHoriJustify HoriJustify;
249
250    //-------------------------------------------------------------------------
251
252    /** specifies the vertical alignment of the cell contents.
253     */
254    [optional, property] com::sun::star::table::CellVertJustify VertJustify;
255
256    //-------------------------------------------------------------------------
257
258    /** is <TRUE/> if text breaks automatically at cell borders.
259     */
260    [optional, property] boolean IsTextWrapped;
261
262    //-------------------------------------------------------------------------
263
264    /** contains the orientation of the cell contents
265        (i.e. top-to-bottom or stacked).
266     */
267    [optional, property] com::sun::star::table::CellOrientation Orientation;
268
269    //-------------------------------------------------------------------------
270
271    /** contains the rotation angle of the cell contents.
272     */
273    [optional, property] long RotateAngle;
274
275    //-------------------------------------------------------------------------
276
277    /** contains the reference egde of the cell rotation.
278     */
279    [optional, property] com::sun::star::table::CellVertJustify RotateReference;
280
281    //-------------------------------------------------------------------------
282
283    /** contains the margin between cell contents and top border
284        (in 1/100 mm).
285     */
286    [optional, property] long ParaTopMargin;
287
288    //-------------------------------------------------------------------------
289
290    /** contains the margin between cell contents and bottom border
291        (in 1/100 mm).
292     */
293    [optional, property] long ParaBottomMargin;
294
295    //-------------------------------------------------------------------------
296
297    /** contains the margin between cell contents and left border
298        (in 1/100 mm).
299     */
300    [optional, property] long ParaLeftMargin;
301
302    //-------------------------------------------------------------------------
303
304    /** contains the margin between cell contents and right border
305        (in 1/100 mm).
306     */
307    [optional, property] long ParaRightMargin;
308
309    //-------------------------------------------------------------------------
310
311    /** property containing a description of the cell border.
312
313        @since OpenOffice 1.1.2
314     */
315    [optional, property] com::sun::star::table::TableBorder TableBorder;
316};
317
318//=============================================================================
319
320}; }; }; };
321
322//=============================================================================
323
324#endif
325
326