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#ifndef __com_sun_star_formula_FormulaProperties_idl__
28#define __com_sun_star_formula_FormulaProperties_idl__
29
30//=============================================================================
31
32 module com {  module sun {  module star {  module formula {
33
34//=============================================================================
35
36/** The formula properties provide access to the properties of a formula
37	in a formula generator
38 */
39published service FormulaProperties
40{
41	//-------------------------------------------------------------------------
42
43    /** contains the alignment of the formula.
44        @see HorizontalAlignment
45	 */
46    [property] short    Alignment;
47	//-------------------------------------------------------------------------
48
49	/** contains the base font height in point the formula will be
50		formatted in.
51
52		<p> All properties containing relative values are related to this value.
53		</p>
54	 */
55    [property] short    BaseFontHeight;
56	//-------------------------------------------------------------------------
57
58	/** customized name for fixed font.
59	 */
60    [property] string   CustomFontNameFixed;
61	//-------------------------------------------------------------------------
62
63    /** determines if the customized fixed font is italic.
64	 */
65	[property] boolean FontFixedIsItalic;
66	//-------------------------------------------------------------------------
67
68    /** determines if the customized fixed font is bold.
69	 */
70	[property] boolean FontFixedIsBold;
71	//-------------------------------------------------------------------------
72
73    /** customized name for sans serif font
74	 */
75    [property] string   CustomFontNameSans;
76	//-------------------------------------------------------------------------
77
78    /** determines if the customized sans serif font is italic.
79	 */
80	[property] boolean FontSansIsItalic;
81	//-------------------------------------------------------------------------
82
83    /** determines if the customized sans serif font is bold.
84	 */
85	[property] boolean FontSansIsBold;
86	//-------------------------------------------------------------------------
87
88	/** customized name for serif font
89	 */
90    [property] string   CustomFontNameSerif;
91	//-------------------------------------------------------------------------
92
93    /** determines if the customized serif font is italic.
94	 */
95	[property] boolean FontSerifIsItalic;
96	//-------------------------------------------------------------------------
97
98    /** determines if the customized serif font is bold.
99	 */
100	[property] boolean FontSerifIsBold;
101	//-------------------------------------------------------------------------
102
103	/** contains the name of the font that is used to
104		display functions contained in the formula.
105	 */
106    [property] string FontNameFunctions;
107	//-------------------------------------------------------------------------
108
109    /** determines if the font that is used to display functions is italic.
110	 */
111	[property] boolean FontFunctionsIsItalic;
112	//-------------------------------------------------------------------------
113
114    /** determines if the font that is used to display functions is bold.
115	 */
116	[property] boolean FontFunctionsIsBold;
117	//-------------------------------------------------------------------------
118
119	/** contains the name of the font that is used to
120		display numbers contained in the formula.
121	 */
122    [property] string   FontNameNumbers;
123	//-------------------------------------------------------------------------
124
125    /** determines if the font that is used to display numbers is italic.
126	 */
127	[property] boolean FontNumbersIsItalic;
128	//-------------------------------------------------------------------------
129
130    /** determines if the font that is used to display numbers is bold.
131	 */
132	[property] boolean FontNumbersIsBold;
133	//-------------------------------------------------------------------------
134
135	/** contains the name of the font that is used to
136		display text contained in the formula.
137	 */
138    [property] string   FontNameText;
139	//-------------------------------------------------------------------------
140
141    /** determines if the font that is used to display text is italic.
142	 */
143	[property] boolean FontTextIsItalic;
144	//-------------------------------------------------------------------------
145
146    /** determines if the font that is used to display text is bold.
147	 */
148	[property] boolean FontTextIsBold;
149	//-------------------------------------------------------------------------
150
151	/** contains the name of the font that is used to
152		display variables contained in the formula.
153	 */
154    [property] string   FontNameVariables;
155	//-------------------------------------------------------------------------
156
157    /** determines if the font that is used to display variables is italic.
158	 */
159	[property] boolean FontVariablesIsItalic;
160	//-------------------------------------------------------------------------
161
162    /** determines if the font that is used to display variables is bold.
163	 */
164	[property] boolean FontVariablesIsBold;
165	//-------------------------------------------------------------------------
166
167	/** contains the command string of the formula
168	 */
169    [property] string   Formula;
170	//-------------------------------------------------------------------------
171
172    /** decides if all brackets (even those without 'left'/'right'
173        modifier) are scaled.
174	 */
175    [property] boolean  IsScaleAllBrackets;
176	//-------------------------------------------------------------------------
177
178	/** switches into text mode.
179	 */
180    [property] boolean  IsTextMode;
181	//-------------------------------------------------------------------------
182
183	/** contains the relative height of the font for functions.
184
185        The values unit is percent of the
186        <member scope="com::sun::star::formula">FormulaProperties::BaseFontHeight</member>
187	 */
188    [property] short    RelativeFontHeightFunctions;
189	//-------------------------------------------------------------------------
190
191	/** contains the relative height of the font for indices.
192
193        The values unit is percent of the
194        <member scope="com::sun::star::formula">FormulaProperties::BaseFontHeight</member>
195	 */
196    [property] short    RelativeFontHeightIndices;
197	//-------------------------------------------------------------------------
198
199	/** contains the relative height of the font for limits.
200
201        The values unit is percent of the
202        <member scope="com::sun::star::formula">FormulaProperties::BaseFontHeight</member>
203	 */
204    [property] short    RelativeFontHeightLimits;
205	//-------------------------------------------------------------------------
206
207	/** contains the relative height of the font for operators.
208
209        The values unit is percent of the
210        <member scope="com::sun::star::formula">FormulaProperties::BaseFontHeight</member>
211	 */
212    [property] short    RelativeFontHeightOperators;
213	//-------------------------------------------------------------------------
214
215	/** contains the relative height of the font for text.
216
217        The values unit is percent of the
218        <member scope="com::sun::star::formula">FormulaProperties::BaseFontHeight</member>
219	 */
220    [property] short    RelativeFontHeightText;
221	//-------------------------------------------------------------------------
222
223	/** contains the relative distance of brackets.
224	 */
225    [property] short    RelativeBracketDistance;
226	//-------------------------------------------------------------------------
227
228	/** contains the relative excess size of brackets.
229	 */
230    [property] short    RelativeBracketExcessSize;
231	//-------------------------------------------------------------------------
232
233	/** contains the relative excess length of a fraction bar.
234	 */
235    [property] short    RelativeFractionBarExcessLength;
236	//-------------------------------------------------------------------------
237
238	/** contains the relative line weight of a fraction bar.
239	 */
240    [property] short    RelativeFractionBarLineWeight;
241	//-------------------------------------------------------------------------
242
243	/** contains the relative depth of the denominator of a fraction
244	 */
245    [property] short    RelativeFractionDenominatorDepth;
246	//-------------------------------------------------------------------------
247
248	/** contains the relative height of the numerator of a fraction.
249	 */
250    [property] short    RelativeFractionNumeratorHeight;
251	//-------------------------------------------------------------------------
252
253	/** contains the relative superscript of indices.
254	 */
255    [property] short    RelativeIndexSubscript;
256	//-------------------------------------------------------------------------
257
258	/** contains the relative subscript of indices.
259	 */
260    [property] short    RelativeIndexSuperscript;
261	//-------------------------------------------------------------------------
262
263	/** contains the relative line spacing.
264	 */
265    [property] short    RelativeLineSpacing;
266	//-------------------------------------------------------------------------
267
268	/** contains the relative distance of lower limits.
269	 */
270    [property] short    RelativeLowerLimitDistance;
271	//-------------------------------------------------------------------------
272
273	/** contains the relative column spacing of matrices.
274	 */
275    [property] short    RelativeMatrixColumnSpacing;
276	//-------------------------------------------------------------------------
277
278	/** contains the relative line spacing of matrices.
279	 */
280    [property] short    RelativeMatrixLineSpacing;
281	//-------------------------------------------------------------------------
282
283	/** contains the relative excess of operators.
284	 */
285    [property] short    RelativeOperatorExcessSize;
286	//-------------------------------------------------------------------------
287
288	/** contains the relative spacing of operators.
289	 */
290    [property] short    RelativeOperatorSpacing;
291	//-------------------------------------------------------------------------
292
293	/** contains the relative root spacing
294	 */
295    [property] short    RelativeRootSpacing;
296	//-------------------------------------------------------------------------
297
298	/** contains the relative scaling of the bracket excess.
299	 */
300    [property] short    RelativeScaleBracketExcessSize;
301	//-------------------------------------------------------------------------
302
303	/** contains the relative spacing.
304	 */
305    [property] short    RelativeSpacing;
306	//-------------------------------------------------------------------------
307
308	/** contains the relative minimum height of the formula.
309	 */
310    [property] short    RelativeSymbolMinimumHeight;
311	//-------------------------------------------------------------------------
312
313	/** contains the relative primary height of symbols.
314	 */
315    [property] short    RelativeSymbolPrimaryHeight;
316	//-------------------------------------------------------------------------
317
318	/** contains the relative distance of upper limits
319	 */
320    [property] short    RelativeUpperLimitDistance;
321	//-------------------------------------------------------------------------
322
323	/** contains the metric value of the top margin of the formula.
324	 */
325    [property] short    TopMargin;
326	//-------------------------------------------------------------------------
327
328	/** contains the metric value of the bottom margin of the formula.
329	 */
330    [property] short    BottomMargin;
331	//-------------------------------------------------------------------------
332
333	/** contains the metric value of the left margin of the formula.
334	 */
335    [property] short    LeftMargin;
336	//-------------------------------------------------------------------------
337
338	/** contains the metric value of the right margin of the formula.
339	 */
340    [property] short    RightMargin;
341
342    //-------------------------------------------------------------------------
343
344    /** contains the baselines offset in respect to the top of the formula rectangle
345
346    @since OOo 3.4
347     */
348    [property, optional] short    BaseLine;
349};
350
351//=============================================================================
352
353}; }; }; };
354
355#endif
356