offapi/com/sun/star/formula/FormulaProperties.idl

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