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
24#ifndef __com_sun_star_sheet_FormulaParser_idl__
25#define __com_sun_star_sheet_FormulaParser_idl__
26
27#ifndef __com_sun_star_beans_PropertySet_idl__
28#include <com/sun/star/beans/PropertySet.idl>
29#endif
30#ifndef __com_sun_star_sheet_XFormulaParser_idl__
31#include <com/sun/star/sheet/XFormulaParser.idl>
32#endif
33#ifndef __com_sun_star_sheet_FormulaOpCodeMapEntry_idl__
34#include <com/sun/star/sheet/FormulaOpCodeMapEntry.idl>
35#endif
36#ifndef __com_sun_star_sheet_ExternalLinkInfo_idl__
37#include <com/sun/star/sheet/ExternalLinkInfo.idl>
38#endif
39
40//=============================================================================
41
42module com {  module sun {  module star {  module sheet {
43
44//=============================================================================
45
46service FormulaParser
47{
48    // ------------------------------------------------------------------------
49
50    service com::sun::star::beans::PropertySet;
51
52    // ------------------------------------------------------------------------
53
54    interface XFormulaParser;
55
56    // ------------------------------------------------------------------------
57
58    /** specifies whether to use English parser and formatter.
59
60        <p>Note: When changing this, an already existing <member>OpCodeMap
61        </member> needs to be recreated internally, so for performance reasons
62        set this <em>before</em> setting the <member>OpCodeMap</member>.
63     */
64    [property] boolean CompileEnglish;
65
66    // ------------------------------------------------------------------------
67
68    /** specifies which address reference style convention to use when
69        parsing a formula string.
70
71        @see AddressConvention
72      */
73    [property] short FormulaConvention;
74
75    // ------------------------------------------------------------------------
76
77    [property] boolean IgnoreLeadingSpaces;
78
79    // ------------------------------------------------------------------------
80
81    [property] string ParameterSeparator;
82
83    // ------------------------------------------------------------------------
84
85    /** contains the complete mapping of names to op-codes.
86
87        <p>Names and symbols not defined here lead to a parser/print error.</p>
88     */
89    [property] sequence< FormulaOpCodeMapEntry > OpCodeMap;
90
91    // ------------------------------------------------------------------------
92
93    /** contains a list of external links referenced in formulas.
94
95        <p>Use of this property depends on the <member>FormulaConvention
96        </member> in use. It is relevant only for <const>
97        AddressConvention::XL_OOX</const> to map indices to external
98        documents. The sequence must be in the order of indices used. Note
99        that indices are 1-based, the sequence must start with an empty
100        element.</p>
101
102        @since OOo 3.1
103     */
104    [property] sequence< ExternalLinkInfo > ExternalLinks;
105
106    // ------------------------------------------------------------------------
107};
108
109//=============================================================================
110
111}; }; }; };
112
113#endif
114
115