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