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