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