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