1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27
28#ifndef __com_sun_star_sheet_FormulaParser_idl__
29#define __com_sun_star_sheet_FormulaParser_idl__
30
31#ifndef __com_sun_star_beans_PropertySet_idl__
32#include <com/sun/star/beans/PropertySet.idl>
33#endif
34#ifndef __com_sun_star_sheet_XFormulaParser_idl__
35#include <com/sun/star/sheet/XFormulaParser.idl>
36#endif
37#ifndef __com_sun_star_sheet_FormulaOpCodeMapEntry_idl__
38#include <com/sun/star/sheet/FormulaOpCodeMapEntry.idl>
39#endif
40#ifndef __com_sun_star_sheet_ExternalLinkInfo_idl__
41#include <com/sun/star/sheet/ExternalLinkInfo.idl>
42#endif
43
44//=============================================================================
45
46module com {  module sun {  module star {  module sheet {
47
48//=============================================================================
49
50service FormulaParser
51{
52    // ------------------------------------------------------------------------
53
54    service com::sun::star::beans::PropertySet;
55
56    // ------------------------------------------------------------------------
57
58    interface XFormulaParser;
59
60    // ------------------------------------------------------------------------
61
62    /** specifies whether to use English parser and formatter.
63
64        <p>Note: When changing this, an already existing <member>OpCodeMap
65        </member> needs to be recreated internally, so for performance reasons
66        set this <em>before</em> setting the <member>OpCodeMap</member>.
67     */
68    [property] boolean CompileEnglish;
69
70    // ------------------------------------------------------------------------
71
72    /** specifies which address reference style convention to use when
73        parsing a formula string.
74
75        @see AddressConvention
76      */
77    [property] short FormulaConvention;
78
79    // ------------------------------------------------------------------------
80
81    [property] boolean IgnoreLeadingSpaces;
82
83    // ------------------------------------------------------------------------
84
85    [property] string ParameterSeparator;
86
87    // ------------------------------------------------------------------------
88
89    /** contains the complete mapping of names to op-codes.
90
91        <p>Names and symbols not defined here lead to a parser/print error.</p>
92     */
93    [property] sequence< FormulaOpCodeMapEntry > OpCodeMap;
94
95    // ------------------------------------------------------------------------
96
97    /** contains a list of external links referenced in formulas.
98
99        <p>Use of this property depends on the <member>FormulaConvention
100        </member> in use. It is relevant only for <const>
101        AddressConvention::XL_OOX</const> to map indices to external
102        documents. The sequence must be in the order of indices used. Note
103        that indices are 1-based, the sequence must start with an empty
104        element.</p>
105
106        @since OOo 3.1
107     */
108    [property] sequence< ExternalLinkInfo > ExternalLinks;
109
110    // ------------------------------------------------------------------------
111};
112
113//=============================================================================
114
115}; }; }; };
116
117#endif
118
119