summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sheet/TableAutoFormatField.idl
blob: fe2801df4a099745569fc23ec4d5f9628dfaa5be (plain)
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
328
329
330
331
332
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: TableAutoFormatField.idl,v $
 * $Revision: 1.17 $
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_sheet_TableAutoFormatField_idl__
#define __com_sun_star_sheet_TableAutoFormatField_idl__

#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif

#ifndef __com_sun_star_util_Color_idl__
#include <com/sun/star/util/Color.idl>
#endif

#ifndef __com_sun_star_lang_Locale_idl__
#include <com/sun/star/lang/Locale.idl>
#endif

#ifndef __com_sun_star_awt_FontSlant_idl__
#include <com/sun/star/awt/FontSlant.idl>
#endif

#ifndef __com_sun_star_table_ShadowFormat_idl__
#include <com/sun/star/table/ShadowFormat.idl>
#endif

#ifndef __com_sun_star_table_CellHoriJustify_idl__
#include <com/sun/star/table/CellHoriJustify.idl>
#endif

#ifndef __com_sun_star_table_CellVertJustify_idl__
#include <com/sun/star/table/CellVertJustify.idl>
#endif

#ifndef __com_sun_star_table_CellOrientation_idl__
#include <com/sun/star/table/CellOrientation.idl>
#endif

#ifndef __com_sun_star_table_TableBorder_idl__
#include <com/sun/star/table/TableBorder.idl>
#endif

//=============================================================================

module com {  module sun {  module star {  module sheet {

//=============================================================================

/** represents a field in an AutoFormat. A field contains all cell
    properties for a specific position in an AutoFormat.
 */
published service TableAutoFormatField
{
    //-------------------------------------------------------------------------

//! service com::sun::star::beans::PropertySet;
    /** provides access to the properties.
     */
    interface com::sun::star::beans::XPropertySet;

    //-------------------------------------------------------------------------

    /** specifies the name of the western font.
     */
    [property] string CharFontName;

    /** specifies the name of the asian font.
     */
    [optional, property] string CharFontNameAsian;

    /** specifies the name of the complex font.
     */
    [optional, property] string CharFontNameComplex;

    //-------------------------------------------------------------------------

    /** specifies the name of the western font style.
     */
    [property] string CharFontStyleName;

    /** specifies the name of the asian font style.
     */
    [optional, property] string CharFontStyleNameAsian;

    /** specifies the name of the complex font style.
     */
    [optional, property] string CharFontStyleNameComplex;

    //-------------------------------------------------------------------------

    /** contains the value of the character set of the western font.
     */
    [property] string CharFontCharSet;

    /** contains the value of the character set of the asian font.
     */
    [optional, property] string CharFontCharSetAsian;

    /** contains the value of the character set of the complex font.
     */
    [optional, property] string CharFontCharSetComplex;

    //-------------------------------------------------------------------------

    /** contains the value of the western font family.
     */
    [property] string CharFontFamily;

    /** contains the value of the asian font family.
     */
    [optional, property] string CharFontFamilyAsian;

    /** contains the value of the complex font family.
     */
    [optional, property] string CharFontFamilyComplex;

    //-------------------------------------------------------------------------

    /** contains the value of the pitch of the western font.
     */
    [property] string CharFontPitch;

    /** contains the value of the pitch of the asian font.
     */
    [optional, property] string CharFontPitchAsian;

    /** contains the value of the pitch of the complex font.
     */
    [optional, property] string CharFontPitchComplex;

    //-------------------------------------------------------------------------

    /** contains the height of characters of the western font in point.
     */
    [property] float CharHeight;

    /** contains the height of characters of the asian font in point.
     */
    [optional, property] float CharHeightAsian;

    /** contains the height of characters of the complex font in point.
     */
    [optional, property] float CharHeightComplex;

    //-------------------------------------------------------------------------

    /** contains the value for the weight of characters of the western font.
     */
    [property] float CharWeight;

    /** contains the value for the weight of characters of the asian font.
     */
    [optional, property] float CharWeightAsian;

    /** contains the value for the weight of characters of the complex font.
     */
    [optional, property] float CharWeightComplex;

    //-------------------------------------------------------------------------

    /** contains the value of the posture of characters of the western font.
     */
    [property] com::sun::star::awt::FontSlant CharPosture;

    /** contains the value of the posture of characters of the asian font.
     */
    [optional, property] com::sun::star::awt::FontSlant CharPostureAsian;

    /** contains the value of the posture of characters of the comlex font.
     */
    [optional, property] com::sun::star::awt::FontSlant CharPostureComplex;

    //-------------------------------------------------------------------------

    /** contains the value for the character underline.
     */
    [property] short CharUnderline;

    //-------------------------------------------------------------------------

    /** is <TRUE/> if the characters are crossed out.
     */
    [property] boolean CharCrossedOut;

    //-------------------------------------------------------------------------

    /** is <TRUE/> if the characters are contoured.
     */
    [property] boolean CharContoured;

    //-------------------------------------------------------------------------

    /** is <TRUE/> if the characters are shadowed.
     */
    [property] boolean CharShadowed;

    //-------------------------------------------------------------------------

    /** contains the value of the text color.
     */
    [property] com::sun::star::util::Color CharColor;

    //-------------------------------------------------------------------------

    /** contains the cell background color.
     */
    [property] com::sun::star::util::Color CellBackColor;

    //-------------------------------------------------------------------------

    /** is <TRUE/> if the cell background is transparent.

        <p>In this case the <member>TableAutoFormatField::CellBackColor</member>
        value is not used.</p>
     */
    [property] boolean IsCellBackgroundTransparent;

    //-------------------------------------------------------------------------

    /** contains a description of the shadow.
     */
    [optional, property] com::sun::star::table::ShadowFormat ShadowFormat;

    //-------------------------------------------------------------------------

    /** specifies the horizontal alignment of the cell contents.
     */
    [optional, property] com::sun::star::table::CellHoriJustify HoriJustify;

    //-------------------------------------------------------------------------

    /** specifies the vertical alignment of the cell contents.
     */
    [optional, property] com::sun::star::table::CellVertJustify VertJustify;

    //-------------------------------------------------------------------------

    /** is <TRUE/> if text breaks automatically at cell borders.
     */
    [optional, property] boolean IsTextWrapped;

    //-------------------------------------------------------------------------

    /** contains the orientation of the cell contents
        (i.e. top-to-bottom or stacked).
     */
    [optional, property] com::sun::star::table::CellOrientation Orientation;

    //-------------------------------------------------------------------------

    /** contains the rotation angle of the cell contents.
     */
    [optional, property] long RotateAngle;

    //-------------------------------------------------------------------------

    /** contains the reference egde of the cell rotation.
     */
    [optional, property] com::sun::star::table::CellVertJustify RotateReference;

    //-------------------------------------------------------------------------

    /** contains the margin between cell contents and top border
        (in 1/100 mm).
     */
    [optional, property] long ParaTopMargin;

    //-------------------------------------------------------------------------

    /** contains the margin between cell contents and bottom border
        (in 1/100 mm).
     */
    [optional, property] long ParaBottomMargin;

    //-------------------------------------------------------------------------

    /** contains the margin between cell contents and left border
        (in 1/100 mm).
     */
    [optional, property] long ParaLeftMargin;

    //-------------------------------------------------------------------------

    /** contains the margin between cell contents and right border
        (in 1/100 mm).
     */
    [optional, property] long ParaRightMargin;

    //-------------------------------------------------------------------------

    /** property containing a description of the cell border.

        @since OOo 1.1.2
     */
    [optional, property] com::sun::star::table::TableBorder TableBorder;
};

//=============================================================================

}; }; }; };

//=============================================================================

#endif