summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/formula/FormulaProperties.idl
blob: 4e03ff36c3a5fc9f6339cd0966ab6f26acd82ba5 (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
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * 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_formula_FormulaProperties_idl__
#define __com_sun_star_formula_FormulaProperties_idl__

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

 module com {  module sun {  module star {  module formula {

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

/** The formula properties provide access to the properties of a formula
    in a formula generator
 */
published service FormulaProperties
{
    //-------------------------------------------------------------------------

    /** contains the alignment of the formula.
        @see HorizontalAlignment
     */
    [property] short    Alignment;
    //-------------------------------------------------------------------------

    /** contains the base font height in point the formula will be
        formatted in.

        <p> All properties containing relative values are related to this value.
        </p>
     */
    [property] short    BaseFontHeight;
    //-------------------------------------------------------------------------

    /** customized name for fixed font.
     */
    [property] string   CustomFontNameFixed;
    //-------------------------------------------------------------------------

    /** determines if the customized fixed font is italic.
     */
    [property] boolean FontFixedIsItalic;
    //-------------------------------------------------------------------------

    /** determines if the customized fixed font is bold.
     */
    [property] boolean FontFixedIsBold;
    //-------------------------------------------------------------------------

    /** customized name for sans serif font
     */
    [property] string   CustomFontNameSans;
    //-------------------------------------------------------------------------

    /** determines if the customized sans serif font is italic.
     */
    [property] boolean FontSansIsItalic;
    //-------------------------------------------------------------------------

    /** determines if the customized sans serif font is bold.
     */
    [property] boolean FontSansIsBold;
    //-------------------------------------------------------------------------

    /** customized name for serif font
     */
    [property] string   CustomFontNameSerif;
    //-------------------------------------------------------------------------

    /** determines if the customized serif font is italic.
     */
    [property] boolean FontSerifIsItalic;
    //-------------------------------------------------------------------------

    /** determines if the customized serif font is bold.
     */
    [property] boolean FontSerifIsBold;
    //-------------------------------------------------------------------------

    /** contains the name of the font that is used to
        display functions contained in the formula.
     */
    [property] string FontNameFunctions;
    //-------------------------------------------------------------------------

    /** determines if the font that is used to display functions is italic.
     */
    [property] boolean FontFunctionsIsItalic;
    //-------------------------------------------------------------------------

    /** determines if the font that is used to display functions is bold.
     */
    [property] boolean FontFunctionsIsBold;
    //-------------------------------------------------------------------------

    /** contains the name of the font that is used to
        display numbers contained in the formula.
     */
    [property] string   FontNameNumbers;
    //-------------------------------------------------------------------------

    /** determines if the font that is used to display numbers is italic.
     */
    [property] boolean FontNumbersIsItalic;
    //-------------------------------------------------------------------------

    /** determines if the font that is used to display numbers is bold.
     */
    [property] boolean FontNumbersIsBold;
    //-------------------------------------------------------------------------

    /** contains the name of the font that is used to
        display text contained in the formula.
     */
    [property] string   FontNameText;
    //-------------------------------------------------------------------------

    /** determines if the font that is used to display text is italic.
     */
    [property] boolean FontTextIsItalic;
    //-------------------------------------------------------------------------

    /** determines if the font that is used to display text is bold.
     */
    [property] boolean FontTextIsBold;
    //-------------------------------------------------------------------------

    /** contains the name of the font that is used to
        display variables contained in the formula.
     */
    [property] string   FontNameVariables;
    //-------------------------------------------------------------------------

    /** determines if the font that is used to display variables is italic.
     */
    [property] boolean FontVariablesIsItalic;
    //-------------------------------------------------------------------------

    /** determines if the font that is used to display variables is bold.
     */
    [property] boolean FontVariablesIsBold;
    //-------------------------------------------------------------------------

    /** contains the command string of the formula
     */
    [property] string   Formula;
    //-------------------------------------------------------------------------

    /** decides if all brackets (even those without 'left'/'right'
        modifier) are scaled.
     */
    [property] boolean  IsScaleAllBrackets;
    //-------------------------------------------------------------------------

    /** switches into text mode.
     */
    [property] boolean  IsTextMode;
    //-------------------------------------------------------------------------

    /** contains the relative height of the font for functions.

        The values unit is percent of the
        <member scope="com::sun::star::formula">FormulaProperties::BaseFontHeight</member>
     */
    [property] short    RelativeFontHeightFunctions;
    //-------------------------------------------------------------------------

    /** contains the relative height of the font for indices.

        The values unit is percent of the
        <member scope="com::sun::star::formula">FormulaProperties::BaseFontHeight</member>
     */
    [property] short    RelativeFontHeightIndices;
    //-------------------------------------------------------------------------

    /** contains the relative height of the font for limits.

        The values unit is percent of the
        <member scope="com::sun::star::formula">FormulaProperties::BaseFontHeight</member>
     */
    [property] short    RelativeFontHeightLimits;
    //-------------------------------------------------------------------------

    /** contains the relative height of the font for operators.

        The values unit is percent of the
        <member scope="com::sun::star::formula">FormulaProperties::BaseFontHeight</member>
     */
    [property] short    RelativeFontHeightOperators;
    //-------------------------------------------------------------------------

    /** contains the relative height of the font for text.

        The values unit is percent of the
        <member scope="com::sun::star::formula">FormulaProperties::BaseFontHeight</member>
     */
    [property] short    RelativeFontHeightText;
    //-------------------------------------------------------------------------

    /** contains the relative distance of brackets.
     */
    [property] short    RelativeBracketDistance;
    //-------------------------------------------------------------------------

    /** contains the relative excess size of brackets.
     */
    [property] short    RelativeBracketExcessSize;
    //-------------------------------------------------------------------------

    /** contains the relative excess length of a fraction bar.
     */
    [property] short    RelativeFractionBarExcessLength;
    //-------------------------------------------------------------------------

    /** contains the relative line weight of a fraction bar.
     */
    [property] short    RelativeFractionBarLineWeight;
    //-------------------------------------------------------------------------

    /** contains the relative depth of the denominator of a fraction
     */
    [property] short    RelativeFractionDenominatorDepth;
    //-------------------------------------------------------------------------

    /** contains the relative height of the numerator of a fraction.
     */
    [property] short    RelativeFractionNumeratorHeight;
    //-------------------------------------------------------------------------

    /** contains the relative superscript of indices.
     */
    [property] short    RelativeIndexSubscript;
    //-------------------------------------------------------------------------

    /** contains the relative subscript of indices.
     */
    [property] short    RelativeIndexSuperscript;
    //-------------------------------------------------------------------------

    /** contains the relative line spacing.
     */
    [property] short    RelativeLineSpacing;
    //-------------------------------------------------------------------------

    /** contains the relative distance of lower limits.
     */
    [property] short    RelativeLowerLimitDistance;
    //-------------------------------------------------------------------------

    /** contains the relative column spacing of matrices.
     */
    [property] short    RelativeMatrixColumnSpacing;
    //-------------------------------------------------------------------------

    /** contains the relative line spacing of matrices.
     */
    [property] short    RelativeMatrixLineSpacing;
    //-------------------------------------------------------------------------

    /** contains the relative excess of operators.
     */
    [property] short    RelativeOperatorExcessSize;
    //-------------------------------------------------------------------------

    /** contains the relative spacing of operators.
     */
    [property] short    RelativeOperatorSpacing;
    //-------------------------------------------------------------------------

    /** contains the relative root spacing
     */
    [property] short    RelativeRootSpacing;
    //-------------------------------------------------------------------------

    /** contains the relative scaling of the bracket excess.
     */
    [property] short    RelativeScaleBracketExcessSize;
    //-------------------------------------------------------------------------

    /** contains the relative spacing.
     */
    [property] short    RelativeSpacing;
    //-------------------------------------------------------------------------

    /** contains the relative minimum height of the formula.
     */
    [property] short    RelativeSymbolMinimumHeight;
    //-------------------------------------------------------------------------

    /** contains the relative primary height of symbols.
     */
    [property] short    RelativeSymbolPrimaryHeight;
    //-------------------------------------------------------------------------

    /** contains the relative distance of upper limits
     */
    [property] short    RelativeUpperLimitDistance;
    //-------------------------------------------------------------------------

    /** contains the metric value of the top margin of the formula.
     */
    [property] short    TopMargin;
    //-------------------------------------------------------------------------

    /** contains the metric value of the bottom margin of the formula.
     */
    [property] short    BottomMargin;
    //-------------------------------------------------------------------------

    /** contains the metric value of the left margin of the formula.
     */
    [property] short    LeftMargin;
    //-------------------------------------------------------------------------

    /** contains the metric value of the right margin of the formula.
     */
    [property] short    RightMargin;

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

    /** contains the baselines offset in respect to the top of the formula rectangle

    @since OOo 3.4
     */
    [property, optional] short    BaseLine;
};

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

}; }; }; };

#endif