LibreOffice
LibreOffice 24.2 SDK API Reference
FormulaProperties.idl
Go to the documentation of this file.
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 
20 
21  module com { module sun { module star { module formula {
22 
23 
27 published service FormulaProperties
28 {
29 
34  [property] short Alignment;
35 
42  [property] short BaseFontHeight;
43 
46  [property] string CustomFontNameFixed;
47 
50  [property] boolean FontFixedIsItalic;
51 
54  [property] boolean FontFixedIsBold;
55 
58  [property] string CustomFontNameSans;
59 
62  [property] boolean FontSansIsItalic;
63 
66  [property] boolean FontSansIsBold;
67 
70  [property] string CustomFontNameSerif;
71 
74  [property] boolean FontSerifIsItalic;
75 
78  [property] boolean FontSerifIsBold;
79 
83  [property] string FontNameFunctions;
84 
87  [property] boolean FontFunctionsIsItalic;
88 
91  [property] boolean FontFunctionsIsBold;
92 
96  [property] string FontNameNumbers;
97 
100  [property] boolean FontNumbersIsItalic;
101 
104  [property] boolean FontNumbersIsBold;
105 
109  [property] string FontNameText;
110 
113  [property] boolean FontTextIsItalic;
114 
117  [property] boolean FontTextIsBold;
118 
122  [property] string FontNameVariables;
123 
126  [property] boolean FontVariablesIsItalic;
127 
130  [property] boolean FontVariablesIsBold;
131 
134  [property] string Formula;
135 
139  [property] boolean IsScaleAllBrackets;
140 
146  [property] boolean IsTextMode;
147 
153  [property] short RelativeFontHeightFunctions;
154 
160  [property] short RelativeFontHeightIndices;
161 
167  [property] short RelativeFontHeightLimits;
168 
174  [property] short RelativeFontHeightOperators;
175 
181  [property] short RelativeFontHeightText;
182 
185  [property] short RelativeBracketDistance;
186 
189  [property] short RelativeBracketExcessSize;
190 
194 
198 
202 
206 
209  [property] short RelativeIndexSubscript;
210 
213  [property] short RelativeIndexSuperscript;
214 
217  [property] short RelativeLineSpacing;
218 
221  [property] short RelativeLowerLimitDistance;
222 
225  [property] short RelativeMatrixColumnSpacing;
226 
229  [property] short RelativeMatrixLineSpacing;
230 
233  [property] short RelativeOperatorExcessSize;
234 
237  [property] short RelativeOperatorSpacing;
238 
241  [property] short RelativeRootSpacing;
242 
246 
249  [property] short RelativeSpacing;
250 
253  [property] short RelativeSymbolMinimumHeight;
254 
257  [property] short RelativeSymbolPrimaryHeight;
258 
261  [property] short RelativeUpperLimitDistance;
262 
265  [property] short TopMargin;
266 
269  [property] short BottomMargin;
270 
273  [property] short LeftMargin;
274 
277  [property] short RightMargin;
278 
279 
284  [property, optional] short BaseLine;
285 
290  [property, optional] boolean IsRightToLeft;
291 };
292 
293 
294 }; }; }; };
295 
296 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
short RightMargin
contains the metric value of the right margin of the formula.
Definition: FormulaProperties.idl:277
short Alignment
contains the alignment of the formula.
Definition: FormulaProperties.idl:34
boolean FontSerifIsItalic
determines if the customized serif font is italic.
Definition: FormulaProperties.idl:74
string CustomFontNameFixed
customized name for fixed font.
Definition: FormulaProperties.idl:46
string FontNameNumbers
contains the name of the font that is used to display numbers contained in the formula.
Definition: FormulaProperties.idl:96
boolean FontVariablesIsBold
determines if the font that is used to display variables is bold.
Definition: FormulaProperties.idl:130
short RelativeFractionBarExcessLength
contains the relative excess length of a fraction bar.
Definition: FormulaProperties.idl:193
short LeftMargin
contains the metric value of the left margin of the formula.
Definition: FormulaProperties.idl:273
boolean FontVariablesIsItalic
determines if the font that is used to display variables is italic.
Definition: FormulaProperties.idl:126
short RelativeOperatorSpacing
contains the relative spacing of operators.
Definition: FormulaProperties.idl:237
boolean FontFixedIsBold
determines if the customized fixed font is bold.
Definition: FormulaProperties.idl:54
short RelativeFractionDenominatorDepth
contains the relative depth of the denominator of a fraction
Definition: FormulaProperties.idl:201
boolean FontFunctionsIsBold
determines if the font that is used to display functions is bold.
Definition: FormulaProperties.idl:91
short RelativeIndexSubscript
contains the relative superscript of indices.
Definition: FormulaProperties.idl:209
Definition: Ambiguous.idl:20
short RelativeBracketDistance
contains the relative distance of brackets.
Definition: FormulaProperties.idl:185
boolean FontFixedIsItalic
determines if the customized fixed font is italic.
Definition: FormulaProperties.idl:50
string CustomFontNameSans
customized name for sans serif font
Definition: FormulaProperties.idl:58
short RelativeFractionNumeratorHeight
contains the relative height of the numerator of a fraction.
Definition: FormulaProperties.idl:205
boolean FontNumbersIsBold
determines if the font that is used to display numbers is bold.
Definition: FormulaProperties.idl:104
string FontNameFunctions
contains the name of the font that is used to display functions contained in the formula.
Definition: FormulaProperties.idl:83
short BaseFontHeight
contains the base font height in point the formula will be formatted in.
Definition: FormulaProperties.idl:42
short RelativeMatrixColumnSpacing
contains the relative column spacing of matrices.
Definition: FormulaProperties.idl:225
short RelativeRootSpacing
contains the relative root spacing
Definition: FormulaProperties.idl:241
short BaseLine
contains the baselines offset in respect to the top of the formula rectangle
Definition: FormulaProperties.idl:284
string FontNameVariables
contains the name of the font that is used to display variables contained in the formula.
Definition: FormulaProperties.idl:122
short RelativeFontHeightText
contains the relative height of the font for text.
Definition: FormulaProperties.idl:181
short RelativeFontHeightIndices
contains the relative height of the font for indices.
Definition: FormulaProperties.idl:160
short TopMargin
contains the metric value of the top margin of the formula.
Definition: FormulaProperties.idl:265
boolean FontTextIsBold
determines if the font that is used to display text is bold.
Definition: FormulaProperties.idl:117
boolean FontFunctionsIsItalic
determines if the font that is used to display functions is italic.
Definition: FormulaProperties.idl:87
boolean FontSansIsBold
determines if the customized sans serif font is bold.
Definition: FormulaProperties.idl:66
short RelativeLowerLimitDistance
contains the relative distance of lower limits.
Definition: FormulaProperties.idl:221
short RelativeScaleBracketExcessSize
contains the relative scaling of the bracket excess.
Definition: FormulaProperties.idl:245
short RelativeMatrixLineSpacing
contains the relative line spacing of matrices.
Definition: FormulaProperties.idl:229
boolean FontNumbersIsItalic
determines if the font that is used to display numbers is italic.
Definition: FormulaProperties.idl:100
string Formula
contains the command string of the formula
Definition: FormulaProperties.idl:134
short RelativeIndexSuperscript
contains the relative subscript of indices.
Definition: FormulaProperties.idl:213
short RelativeSpacing
contains the relative spacing.
Definition: FormulaProperties.idl:249
boolean FontSansIsItalic
determines if the customized sans serif font is italic.
Definition: FormulaProperties.idl:62
short BottomMargin
contains the metric value of the bottom margin of the formula.
Definition: FormulaProperties.idl:269
short RelativeBracketExcessSize
contains the relative excess size of brackets.
Definition: FormulaProperties.idl:189
boolean FontSerifIsBold
determines if the customized serif font is bold.
Definition: FormulaProperties.idl:78
short RelativeSymbolMinimumHeight
contains the relative minimum height of the formula.
Definition: FormulaProperties.idl:253
string FontNameText
contains the name of the font that is used to display text contained in the formula.
Definition: FormulaProperties.idl:109
short RelativeLineSpacing
contains the relative line spacing.
Definition: FormulaProperties.idl:217
boolean IsScaleAllBrackets
decides if all brackets (even those without "left"/"right" modifier) are scaled.
Definition: FormulaProperties.idl:139
string CustomFontNameSerif
customized name for serif font
Definition: FormulaProperties.idl:70
boolean IsTextMode
switches into text mode.
Definition: FormulaProperties.idl:146
short RelativeFontHeightFunctions
contains the relative height of the font for functions.
Definition: FormulaProperties.idl:153
short RelativeOperatorExcessSize
contains the relative excess of operators.
Definition: FormulaProperties.idl:233
short RelativeSymbolPrimaryHeight
contains the relative primary height of symbols.
Definition: FormulaProperties.idl:257
short RelativeFontHeightOperators
contains the relative height of the font for operators.
Definition: FormulaProperties.idl:174
The formula properties provide access to the properties of a formula in a formula generator...
Definition: FormulaProperties.idl:27
short RelativeFractionBarLineWeight
contains the relative line weight of a fraction bar.
Definition: FormulaProperties.idl:197
boolean IsRightToLeft
switches into right-to-left layout.
Definition: FormulaProperties.idl:290
short RelativeUpperLimitDistance
contains the relative distance of upper limits
Definition: FormulaProperties.idl:261
boolean FontTextIsItalic
determines if the font that is used to display text is italic.
Definition: FormulaProperties.idl:113
short RelativeFontHeightLimits
contains the relative height of the font for limits.
Definition: FormulaProperties.idl:167