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

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