summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/formula/FormulaProperties.idl
blob: e238abe8bd17ce657fb7a551a00b016bee600f52 (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
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#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 com::sun::star::style::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.

        This is a mode where formulas are displayed the same height as
        a line of text.
     */
    [property] boolean  IsTextMode;

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

        The values unit is percent of the
        com::sun::star::formula::FormulaProperties::BaseFontHeight
     */
    [property] short    RelativeFontHeightFunctions;

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

        The values unit is percent of the
        com::sun::star::formula::FormulaProperties::BaseFontHeight
     */
    [property] short    RelativeFontHeightIndices;

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

        The values unit is percent of the
        com::sun::star::formula::FormulaProperties::BaseFontHeight
     */
    [property] short    RelativeFontHeightLimits;

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

        The values unit is percent of the
        com::sun::star::formula::FormulaProperties::BaseFontHeight
     */
    [property] short    RelativeFontHeightOperators;

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

        The values unit is percent of the
        com::sun::star::formula::FormulaProperties::BaseFontHeight
     */
    [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

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */