summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/formula/FormulaProperties.idl
blob: ecb839d277ef6ecd577dd46a6547673bfeb68fe3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
/*************************************************************************
 *
 *  $RCSfile: FormulaProperties.idl,v $
 *
 *  $Revision: 1.1 $
 *
 *  last change: $Author: mi $ $Date: 2000-11-06 09:21:43 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#ifndef __com_sun_star_formula_FormulaProperties_idl__
#define __com_sun_star_formula_FormulaProperties_idl__

//=============================================================================

 module com {  module sun {  module star {  module formula {

//=============================================================================

// DocMerge from xml: service com::sun::star::formula::FormulaProperties
/** The formula properties provide access to the properties of a formula
    in a formula generator
 */
service FormulaProperties
{
    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::formula::FormulaProperties::Alignment
    /** contains the alignment of the formula.@see HorizontalAlignment
     */
    [property] short    Alignment                          ;
    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::formula::FormulaProperties::BaseFontHeight
    /** contains the base font height in point the formula will be
        formatted in.


        <p> All properties containing relative values are related to this value.
        </p>
     */
    [property] short    BaseFontHeight                     ;
    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::formula::FormulaProperties::CustomFontNameFixed
    /** customized name for fixed font.
     */
    [property] string   CustomFontNameFixed                ;
    //-------------------------------------------------------------------------

    // DocMerge from idl: property com::sun::star::formula::FormulaProperties::FontFixedIsItalic
    /** determins if the customized fixed font italic.
     */
    [property] boolean FontFixedIsItalic;
    //-------------------------------------------------------------------------

    // DocMerge from idl: property com::sun::star::formula::FormulaProperties::FontFixedIsBold
    /** determins if the customized fixed font is bold.
     */
    [property] boolean FontFixedIsBold;
    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::formula::FormulaProperties::CustomFontNameSans
    /** customized name for sans serif font
     */
    [property] string   CustomFontNameSans                 ;
    //-------------------------------------------------------------------------

    // DocMerge from idl: property com::sun::star::formula::FormulaProperties::FontSansIsItalic
    /** determins if the customized sans serif font is italic.
     */
    [property] boolean FontSansIsItalic;
    //-------------------------------------------------------------------------

    // DocMerge from idl: property com::sun::star::formula::FormulaProperties::FontSansIsBold
    /** determins if the customized sans serif font is bold.
     */
    [property] boolean FontSansIsBold;
    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::formula::FormulaProperties::CustomFontNameSerif
    /** customized name for serif font
     */
    [property] string   CustomFontNameSerif                ;
    //-------------------------------------------------------------------------

    // DocMerge from idl: property com::sun::star::formula::FormulaProperties::FontSerifIsItalic
    /** determins if the customized serif is italic.
     */
    [property] boolean FontSerifIsItalic;
    //-------------------------------------------------------------------------

    // DocMerge from idl: property com::sun::star::formula::FormulaProperties::FontSerifIsBold
    /** determins if the customized serif is bold.
     */
    [property] boolean FontSerifIsBold;
    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::formula::FormulaProperties::FontNameFunctions
    /** contains the name of the font that is used to
        display functions contained in the formula.
     */
    [property] string FontNameFunctions                  ;
    //-------------------------------------------------------------------------

    // DocMerge from idl: property com::sun::star::formula::FormulaProperties::FontFunctionsIsItalic
    /** determins if the font that is used to
                 display functions is italic.
     */
    [property] boolean FontFunctionsIsItalic;
    //-------------------------------------------------------------------------

    // DocMerge from idl: property com::sun::star::formula::FormulaProperties::FontFunctionsIsBold
    /** determins if the font that is used to
                 display functions is bold.
     */
    [property] boolean FontFunctionsIsBold;
    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::formula::FormulaProperties::FontNameNumbers
    /** contains the name of the font that is used to
        display numbers contained in the formula.
     */
    [property] string   FontNameNumbers                    ;
    //-------------------------------------------------------------------------

    // DocMerge from idl: property com::sun::star::formula::FormulaProperties::FontNumbersIsItalic
    /** determins if the font that is used to
                 display numbers is italic.
     */
    [property] boolean FontNumbersIsItalic;
    //-------------------------------------------------------------------------

    // DocMerge from idl: property com::sun::star::formula::FormulaProperties::FontNumbersIsBold
    /** determins if the font that is used to
                 display numbers is bold.
     */
    [property] boolean FontNumbersIsBold;
    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::formula::FormulaProperties::FontNameText
    /** contains the name of the font that is used to
        display text contained in the formula.
     */
    [property] string   FontNameText                       ;
    //-------------------------------------------------------------------------

    // DocMerge from idl: property com::sun::star::formula::FormulaProperties::FontTextIsItalic
    /** determins if the font that is used to
                 display text is italic.
     */
    [property] boolean FontTextIsItalic;
    //-------------------------------------------------------------------------

    // DocMerge from idl: property com::sun::star::formula::FormulaProperties::FontTextIsBold
    /** determins if the font that is used to
                 display text is bold.
     */
    [property] boolean FontTextIsBold;
    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::formula::FormulaProperties::FontNameVariables
    /** contains the name of the font that is used to
        display variables contained in the formula.
     */
    [property] string   FontNameVariables                  ;
    //-------------------------------------------------------------------------

    // DocMerge from idl: property com::sun::star::formula::FormulaProperties::FontVariablesIsItalic
    /** determins if the font that is used to
                 display variables is italic.
     */
    [property] boolean FontVariablesIsItalic;
    //-------------------------------------------------------------------------

    // DocMerge from idl: property com::sun::star::formula::FormulaProperties::FontVariablesIsBold
    /** determins if the font that is used to
                 display variables is bold.
     */
    [property] boolean FontVariablesIsBold;
    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::formula::FormulaProperties::Formula
    /** contains the command string of the formula
     */
    [property] string   Formula                            ;
    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::formula::FormulaProperties::IsScaleAllBrackets
    /** decides if all brackets are scaled
     */
    [property] boolean  IsScaleAllBrackets                 ;
    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::formula::FormulaProperties::IsTextMode
    /** switches into text mode.
     */
    [property] boolean  IsTextMode                         ;
    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::formula::FormulaProperties::RelativeFontHeightFunctions
    /** contains the relative height of the font for functions.
     */
    [property] short    RelativeFontHeightFunctions        ;
    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::formula::FormulaProperties::RelativeFontHeightIndices
    /** contains the relative height of the font for indices.
     */
    [property] short    RelativeFontHeightIndices          ;
    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::formula::FormulaProperties::RelativeFontHeightLimits
    /** contains the relative height of the font for limits.
     */
    [property] short    RelativeFontHeightLimits           ;
    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::formula::FormulaProperties::RelativeFontHeightOperators
    /** contains the relative height of the font for operators.
     */
    [property] short    RelativeFontHeightOperators        ;
    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::formula::FormulaProperties::RelativeFontHeightText
    /** contains the relative height of the font for text.
     */
    [property] short    RelativeFontHeightText             ;
    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::formula::FormulaProperties::RelativeBracketDistance
    /** contains the relative distance of brackets.
     */
    [property] short    RelativeBracketDistance            ;
    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::formula::FormulaProperties::RelativeBracketExcessSize
    /** contains the relative excess size of brackets.
     */
    [property] short    RelativeBracketExcessSize          ;
    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::formula::FormulaProperties::RelativeFractionBarExcessLength
    /** contains the relative excess length of a fraction bar.
     */
    [property] short    RelativeFractionBarExcessLength    ;
    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::formula::FormulaProperties::RelativeFractionBarLineWeight
    /** contains the relative line weight of a fraction bar.
     */
    [property] short    RelativeFractionBarLineWeight      ;
    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::formula::FormulaProperties::RelativeFractionDenominatorDepth
    /** contains the relative depth of the denominator of a fraction
     */
    [property] short    RelativeFractionDenominatorDepth   ;
    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::formula::FormulaProperties::RelativeFractionNumeratorHeight
    /** contains the relative height of the numerator of a fraction.
     */
    [property] short    RelativeFractionNumeratorHeight    ;
    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::formula::FormulaProperties::RelativeIndexSubscript
    /** contains the relative superscript of indices.
     */
    [property] short    RelativeIndexSubscript             ;
    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::formula::FormulaProperties::RelativeIndexSuperscript
    /** contains the relative subscript of indices.
     */
    [property] short    RelativeIndexSuperscript           ;
    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::formula::FormulaProperties::RelativeLineSpacing
    /** contains the relative line spacing.
     */
    [property] short    RelativeLineSpacing                ;
    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::formula::FormulaProperties::RelativeLowerLimitDistance
    /** contains the relative distance of lower limits.
     */
    [property] short    RelativeLowerLimitDistance         ;
    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::formula::FormulaProperties::RelativeMatrixColumnSpacing
    /** contains the relative column spacing of matrices.
     */
    [property] short    RelativeMatrixColumnSpacing        ;
    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::formula::FormulaProperties::RelativeMatrixLineSpacing
    /** contains the relative line spacing of matrices.
     */
    [property] short    RelativeMatrixLineSpacing          ;
    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::formula::FormulaProperties::RelativeOperatorExcessSize
    /** contains the relative excess of operators.
     */
    [property] short    RelativeOperatorExcessSize         ;
    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::formula::FormulaProperties::RelativeOperatorSpacing
    /** contains the relative spacing of operators.
     */
    [property] short    RelativeOperatorSpacing            ;
    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::formula::FormulaProperties::RelativeRootSpacing
    /** contains the relative root spacing
     */
    [property] short    RelativeRootSpacing                ;
    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::formula::FormulaProperties::RelativeScaleBracketExcessSize
    /** contains the relative scaling of the bracket excess.
     */
    [property] short    RelativeScaleBracketExcessSize     ;
    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::formula::FormulaProperties::RelativeSpacing
    /** contains the relative spacing.
     */
    [property] short    RelativeSpacing                    ;
    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::formula::FormulaProperties::RelativeSymbolMinimumHeight
    /** contains the relative minimum height of the formula.
     */
    [property] short    RelativeSymbolMinimumHeight        ;
    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::formula::FormulaProperties::RelativeSymbolPrimaryHeight
    /** contains the relative primary height of symbols.
     */
    [property] short    RelativeSymbolPrimaryHeight        ;
    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::formula::FormulaProperties::RelativeUpperLimitDistance
    /** contains the relative distance of upper limits
     */
    [property] short    RelativeUpperLimitDistance         ;
    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::formula::FormulaProperties::TopMargin
    /** contains the metric value of the top margin of the formula.
     */
    [property] short    TopMargin                          ;
    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::formula::FormulaProperties::BottomMargin
    /** contains the metric value of the bottom margin of the formula.
     */
    [property] short    BottomMargin                       ;
    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::formula::FormulaProperties::LeftMargin
    /** contains the metric value of the left margin of the formula.
     */
    [property] short    LeftMargin                         ;
    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::formula::FormulaProperties::RightMargin
    /** contains the metric value of the right margin of the formula.
     */
    [property] short    RightMargin                        ;
};

//=============================================================================

}; }; }; };

/*=============================================================================

    $Log: not supported by cvs2svn $
    Revision 1.1.1.1  2000/09/18 23:35:20  hjs
    initial import

    Revision 1.4  2000/09/11 11:52:27  mi
    documentation merged from XML

    Revision 1.2  2000/08/11 11:22:41  os
    #76632# IsBold/IsItalic properties

    Revision 1.1  2000/01/12 08:58:01  os
    #71637# new: FormulaProperties

=============================================================================*/
#endif