1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 *   Licensed to the Apache Software Foundation (ASF) under one or more
12 *   contributor license agreements. See the NOTICE file distributed
13 *   with this work for additional information regarding copyright
14 *   ownership. The ASF licenses this file to you under the Apache
15 *   License, Version 2.0 (the "License"); you may not use this file
16 *   except in compliance with the License. You may obtain a copy of
17 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19#ifndef __com_sun_star_formula_FormulaProperties_idl__
20#define __com_sun_star_formula_FormulaProperties_idl__
21
22
23 module com {  module sun {  module star {  module formula {
24
25
26/** The formula properties provide access to the properties of a formula
27    in a formula generator
28 */
29published service FormulaProperties
30{
31
32    /** contains the alignment of the formula.
33
34        @see com::sun::star::style::HorizontalAlignment
35     */
36    [property] short    Alignment;
37
38    /** contains the base font height in point the formula will be
39        formatted in.
40
41        <p> All properties containing relative values are related to this value.
42        </p>
43     */
44    [property] short    BaseFontHeight;
45
46    /** customized name for fixed font.
47     */
48    [property] string   CustomFontNameFixed;
49
50    /** determines if the customized fixed font is italic.
51     */
52    [property] boolean FontFixedIsItalic;
53
54    /** determines if the customized fixed font is bold.
55     */
56    [property] boolean FontFixedIsBold;
57
58    /** customized name for sans serif font
59     */
60    [property] string   CustomFontNameSans;
61
62    /** determines if the customized sans serif font is italic.
63     */
64    [property] boolean FontSansIsItalic;
65
66    /** determines if the customized sans serif font is bold.
67     */
68    [property] boolean FontSansIsBold;
69
70    /** customized name for serif font
71     */
72    [property] string   CustomFontNameSerif;
73
74    /** determines if the customized serif font is italic.
75     */
76    [property] boolean FontSerifIsItalic;
77
78    /** determines if the customized serif font is bold.
79     */
80    [property] boolean FontSerifIsBold;
81
82    /** contains the name of the font that is used to
83        display functions contained in the formula.
84     */
85    [property] string FontNameFunctions;
86
87    /** determines if the font that is used to display functions is italic.
88     */
89    [property] boolean FontFunctionsIsItalic;
90
91    /** determines if the font that is used to display functions is bold.
92     */
93    [property] boolean FontFunctionsIsBold;
94
95    /** contains the name of the font that is used to
96        display numbers contained in the formula.
97     */
98    [property] string   FontNameNumbers;
99
100    /** determines if the font that is used to display numbers is italic.
101     */
102    [property] boolean FontNumbersIsItalic;
103
104    /** determines if the font that is used to display numbers is bold.
105     */
106    [property] boolean FontNumbersIsBold;
107
108    /** contains the name of the font that is used to
109        display text contained in the formula.
110     */
111    [property] string   FontNameText;
112
113    /** determines if the font that is used to display text is italic.
114     */
115    [property] boolean FontTextIsItalic;
116
117    /** determines if the font that is used to display text is bold.
118     */
119    [property] boolean FontTextIsBold;
120
121    /** contains the name of the font that is used to
122        display variables contained in the formula.
123     */
124    [property] string   FontNameVariables;
125
126    /** determines if the font that is used to display variables is italic.
127     */
128    [property] boolean FontVariablesIsItalic;
129
130    /** determines if the font that is used to display variables is bold.
131     */
132    [property] boolean FontVariablesIsBold;
133
134    /** contains the command string of the formula
135     */
136    [property] string   Formula;
137
138    /** decides if all brackets (even those without "left"/"right"
139        modifier) are scaled.
140     */
141    [property] boolean  IsScaleAllBrackets;
142
143    /** switches into text mode.
144
145        This is a mode where formulas are displayed the same height as
146        a line of text.
147     */
148    [property] boolean  IsTextMode;
149
150    /** contains the relative height of the font for functions.
151
152        The values unit is percent of the
153        com::sun::star::formula::FormulaProperties::BaseFontHeight
154     */
155    [property] short    RelativeFontHeightFunctions;
156
157    /** contains the relative height of the font for indices.
158
159        The values unit is percent of the
160        com::sun::star::formula::FormulaProperties::BaseFontHeight
161     */
162    [property] short    RelativeFontHeightIndices;
163
164    /** contains the relative height of the font for limits.
165
166        The values unit is percent of the
167        com::sun::star::formula::FormulaProperties::BaseFontHeight
168     */
169    [property] short    RelativeFontHeightLimits;
170
171    /** contains the relative height of the font for operators.
172
173        The values unit is percent of the
174        com::sun::star::formula::FormulaProperties::BaseFontHeight
175     */
176    [property] short    RelativeFontHeightOperators;
177
178    /** contains the relative height of the font for text.
179
180        The values unit is percent of the
181        com::sun::star::formula::FormulaProperties::BaseFontHeight
182     */
183    [property] short    RelativeFontHeightText;
184
185    /** contains the relative distance of brackets.
186     */
187    [property] short    RelativeBracketDistance;
188
189    /** contains the relative excess size of brackets.
190     */
191    [property] short    RelativeBracketExcessSize;
192
193    /** contains the relative excess length of a fraction bar.
194     */
195    [property] short    RelativeFractionBarExcessLength;
196
197    /** contains the relative line weight of a fraction bar.
198     */
199    [property] short    RelativeFractionBarLineWeight;
200
201    /** contains the relative depth of the denominator of a fraction
202     */
203    [property] short    RelativeFractionDenominatorDepth;
204
205    /** contains the relative height of the numerator of a fraction.
206     */
207    [property] short    RelativeFractionNumeratorHeight;
208
209    /** contains the relative superscript of indices.
210     */
211    [property] short    RelativeIndexSubscript;
212
213    /** contains the relative subscript of indices.
214     */
215    [property] short    RelativeIndexSuperscript;
216
217    /** contains the relative line spacing.
218     */
219    [property] short    RelativeLineSpacing;
220
221    /** contains the relative distance of lower limits.
222     */
223    [property] short    RelativeLowerLimitDistance;
224
225    /** contains the relative column spacing of matrices.
226     */
227    [property] short    RelativeMatrixColumnSpacing;
228
229    /** contains the relative line spacing of matrices.
230     */
231    [property] short    RelativeMatrixLineSpacing;
232
233    /** contains the relative excess of operators.
234     */
235    [property] short    RelativeOperatorExcessSize;
236
237    /** contains the relative spacing of operators.
238     */
239    [property] short    RelativeOperatorSpacing;
240
241    /** contains the relative root spacing
242     */
243    [property] short    RelativeRootSpacing;
244
245    /** contains the relative scaling of the bracket excess.
246     */
247    [property] short    RelativeScaleBracketExcessSize;
248
249    /** contains the relative spacing.
250     */
251    [property] short    RelativeSpacing;
252
253    /** contains the relative minimum height of the formula.
254     */
255    [property] short    RelativeSymbolMinimumHeight;
256
257    /** contains the relative primary height of symbols.
258     */
259    [property] short    RelativeSymbolPrimaryHeight;
260
261    /** contains the relative distance of upper limits
262     */
263    [property] short    RelativeUpperLimitDistance;
264
265    /** contains the metric value of the top margin of the formula.
266     */
267    [property] short    TopMargin;
268
269    /** contains the metric value of the bottom margin of the formula.
270     */
271    [property] short    BottomMargin;
272
273    /** contains the metric value of the left margin of the formula.
274     */
275    [property] short    LeftMargin;
276
277    /** contains the metric value of the right margin of the formula.
278     */
279    [property] short    RightMargin;
280
281
282    /** contains the baselines offset in respect to the top of the formula rectangle
283
284    @since OOo 3.4
285     */
286    [property, optional] short    BaseLine;
287};
288
289
290}; }; }; };
291
292#endif
293
294/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
295