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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef __com_sun_star_formula_FormulaProperties_idl__
  29 #define __com_sun_star_formula_FormulaProperties_idl__
  30
  31 //=============================================================================
  32
  33  module com {  module sun {  module star {  module formula {
  34
  35 //=============================================================================
  36
  37 /** The formula properties provide access to the properties of a formula
  38     in a formula generator
  39  */
  40 published service FormulaProperties
  41 {
  42     //-------------------------------------------------------------------------
  43
  44     /** contains the alignment of the formula.
  45         @see HorizontalAlignment
  46      */
  47     [property] short    Alignment;
  48     //-------------------------------------------------------------------------
  49
  50     /** contains the base font height in point the formula will be
  51         formatted in.
  52
  53         <p> All properties containing relative values are related to this value.
  54         </p>
  55      */
  56     [property] short    BaseFontHeight;
  57     //-------------------------------------------------------------------------
  58
  59     /** customized name for fixed font.
  60      */
  61     [property] string   CustomFontNameFixed;
  62     //-------------------------------------------------------------------------
  63
  64     /** determines if the customized fixed font is italic.
  65      */
  66     [property] boolean FontFixedIsItalic;
  67     //-------------------------------------------------------------------------
  68
  69     /** determines if the customized fixed font is bold.
  70      */
  71     [property] boolean FontFixedIsBold;
  72     //-------------------------------------------------------------------------
  73
  74     /** customized name for sans serif font
  75      */
  76     [property] string   CustomFontNameSans;
  77     //-------------------------------------------------------------------------
  78
  79     /** determines if the customized sans serif font is italic.
  80      */
  81     [property] boolean FontSansIsItalic;
  82     //-------------------------------------------------------------------------
  83
  84     /** determines if the customized sans serif font is bold.
  85      */
  86     [property] boolean FontSansIsBold;
  87     //-------------------------------------------------------------------------
  88
  89     /** customized name for serif font
  90      */
  91     [property] string   CustomFontNameSerif;
  92     //-------------------------------------------------------------------------
  93
  94     /** determines if the customized serif font is italic.
  95      */
  96     [property] boolean FontSerifIsItalic;
  97     //-------------------------------------------------------------------------
  98
  99     /** determines if the customized serif font is bold.
 100      */
 101     [property] boolean FontSerifIsBold;
 102     //-------------------------------------------------------------------------
 103
 104     /** contains the name of the font that is used to
 105         display functions contained in the formula.
 106      */
 107     [property] string FontNameFunctions;
 108     //-------------------------------------------------------------------------
 109
 110     /** determines if the font that is used to display functions is italic.
 111      */
 112     [property] boolean FontFunctionsIsItalic;
 113     //-------------------------------------------------------------------------
 114
 115     /** determines if the font that is used to display functions is bold.
 116      */
 117     [property] boolean FontFunctionsIsBold;
 118     //-------------------------------------------------------------------------
 119
 120     /** contains the name of the font that is used to
 121         display numbers contained in the formula.
 122      */
 123     [property] string   FontNameNumbers;
 124     //-------------------------------------------------------------------------
 125
 126     /** determines if the font that is used to display numbers is italic.
 127      */
 128     [property] boolean FontNumbersIsItalic;
 129     //-------------------------------------------------------------------------
 130
 131     /** determines if the font that is used to display numbers is bold.
 132      */
 133     [property] boolean FontNumbersIsBold;
 134     //-------------------------------------------------------------------------
 135
 136     /** contains the name of the font that is used to
 137         display text contained in the formula.
 138      */
 139     [property] string   FontNameText;
 140     //-------------------------------------------------------------------------
 141
 142     /** determines if the font that is used to display text is italic.
 143      */
 144     [property] boolean FontTextIsItalic;
 145     //-------------------------------------------------------------------------
 146
 147     /** determines if the font that is used to display text is bold.
 148      */
 149     [property] boolean FontTextIsBold;
 150     //-------------------------------------------------------------------------
 151
 152     /** contains the name of the font that is used to
 153         display variables contained in the formula.
 154      */
 155     [property] string   FontNameVariables;
 156     //-------------------------------------------------------------------------
 157
 158     /** determines if the font that is used to display variables is italic.
 159      */
 160     [property] boolean FontVariablesIsItalic;
 161     //-------------------------------------------------------------------------
 162
 163     /** determines if the font that is used to display variables is bold.
 164      */
 165     [property] boolean FontVariablesIsBold;
 166     //-------------------------------------------------------------------------
 167
 168     /** contains the command string of the formula
 169      */
 170     [property] string   Formula;
 171     //-------------------------------------------------------------------------
 172
 173     /** decides if all brackets (even those without "left"/"right"
 174         modifier) are scaled.
 175      */
 176     [property] boolean  IsScaleAllBrackets;
 177     //-------------------------------------------------------------------------
 178
 179     /** switches into text mode.
 180      */
 181     [property] boolean  IsTextMode;
 182     //-------------------------------------------------------------------------
 183
 184     /** contains the relative height of the font for functions.
 185
 186         The values unit is percent of the
 187         <member scope="com::sun::star::formula">FormulaProperties::BaseFontHeight</member>
 188      */
 189     [property] short    RelativeFontHeightFunctions;
 190     //-------------------------------------------------------------------------
 191
 192     /** contains the relative height of the font for indices.
 193
 194         The values unit is percent of the
 195         <member scope="com::sun::star::formula">FormulaProperties::BaseFontHeight</member>
 196      */
 197     [property] short    RelativeFontHeightIndices;
 198     //-------------------------------------------------------------------------
 199
 200     /** contains the relative height of the font for limits.
 201
 202         The values unit is percent of the
 203         <member scope="com::sun::star::formula">FormulaProperties::BaseFontHeight</member>
 204      */
 205     [property] short    RelativeFontHeightLimits;
 206     //-------------------------------------------------------------------------
 207
 208     /** contains the relative height of the font for operators.
 209
 210         The values unit is percent of the
 211         <member scope="com::sun::star::formula">FormulaProperties::BaseFontHeight</member>
 212      */
 213     [property] short    RelativeFontHeightOperators;
 214     //-------------------------------------------------------------------------
 215
 216     /** contains the relative height of the font for text.
 217
 218         The values unit is percent of the
 219         <member scope="com::sun::star::formula">FormulaProperties::BaseFontHeight</member>
 220      */
 221     [property] short    RelativeFontHeightText;
 222     //-------------------------------------------------------------------------
 223
 224     /** contains the relative distance of brackets.
 225      */
 226     [property] short    RelativeBracketDistance;
 227     //-------------------------------------------------------------------------
 228
 229     /** contains the relative excess size of brackets.
 230      */
 231     [property] short    RelativeBracketExcessSize;
 232     //-------------------------------------------------------------------------
 233
 234     /** contains the relative excess length of a fraction bar.
 235      */
 236     [property] short    RelativeFractionBarExcessLength;
 237     //-------------------------------------------------------------------------
 238
 239     /** contains the relative line weight of a fraction bar.
 240      */
 241     [property] short    RelativeFractionBarLineWeight;
 242     //-------------------------------------------------------------------------
 243
 244     /** contains the relative depth of the denominator of a fraction
 245      */
 246     [property] short    RelativeFractionDenominatorDepth;
 247     //-------------------------------------------------------------------------
 248
 249     /** contains the relative height of the numerator of a fraction.
 250      */
 251     [property] short    RelativeFractionNumeratorHeight;
 252     //-------------------------------------------------------------------------
 253
 254     /** contains the relative superscript of indices.
 255      */
 256     [property] short    RelativeIndexSubscript;
 257     //-------------------------------------------------------------------------
 258
 259     /** contains the relative subscript of indices.
 260      */
 261     [property] short    RelativeIndexSuperscript;
 262     //-------------------------------------------------------------------------
 263
 264     /** contains the relative line spacing.
 265      */
 266     [property] short    RelativeLineSpacing;
 267     //-------------------------------------------------------------------------
 268
 269     /** contains the relative distance of lower limits.
 270      */
 271     [property] short    RelativeLowerLimitDistance;
 272     //-------------------------------------------------------------------------
 273
 274     /** contains the relative column spacing of matrices.
 275      */
 276     [property] short    RelativeMatrixColumnSpacing;
 277     //-------------------------------------------------------------------------
 278
 279     /** contains the relative line spacing of matrices.
 280      */
 281     [property] short    RelativeMatrixLineSpacing;
 282     //-------------------------------------------------------------------------
 283
 284     /** contains the relative excess of operators.
 285      */
 286     [property] short    RelativeOperatorExcessSize;
 287     //-------------------------------------------------------------------------
 288
 289     /** contains the relative spacing of operators.
 290      */
 291     [property] short    RelativeOperatorSpacing;
 292     //-------------------------------------------------------------------------
 293
 294     /** contains the relative root spacing
 295      */
 296     [property] short    RelativeRootSpacing;
 297     //-------------------------------------------------------------------------
 298
 299     /** contains the relative scaling of the bracket excess.
 300      */
 301     [property] short    RelativeScaleBracketExcessSize;
 302     //-------------------------------------------------------------------------
 303
 304     /** contains the relative spacing.
 305      */
 306     [property] short    RelativeSpacing;
 307     //-------------------------------------------------------------------------
 308
 309     /** contains the relative minimum height of the formula.
 310      */
 311     [property] short    RelativeSymbolMinimumHeight;
 312     //-------------------------------------------------------------------------
 313
 314     /** contains the relative primary height of symbols.
 315      */
 316     [property] short    RelativeSymbolPrimaryHeight;
 317     //-------------------------------------------------------------------------
 318
 319     /** contains the relative distance of upper limits
 320      */
 321     [property] short    RelativeUpperLimitDistance;
 322     //-------------------------------------------------------------------------
 323
 324     /** contains the metric value of the top margin of the formula.
 325      */
 326     [property] short    TopMargin;
 327     //-------------------------------------------------------------------------
 328
 329     /** contains the metric value of the bottom margin of the formula.
 330      */
 331     [property] short    BottomMargin;
 332     //-------------------------------------------------------------------------
 333
 334     /** contains the metric value of the left margin of the formula.
 335      */
 336     [property] short    LeftMargin;
 337     //-------------------------------------------------------------------------
 338
 339     /** contains the metric value of the right margin of the formula.
 340      */
 341     [property] short    RightMargin;
 342
 343     //-------------------------------------------------------------------------
 344
 345     /** contains the baselines offset in respect to the top of the formula rectangle
 346
 347     @since OOo 3.4
 348      */
 349     [property, optional] short    BaseLine;
 350 };
 351
 352 //=============================================================================
 353
 354 }; }; }; };
 355
 356 #endif
 357
 358 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */