offapi/com/sun/star/sheet/FormulaParser.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_sheet_FormulaParser_idl__
  21 #define __com_sun_star_sheet_FormulaParser_idl__
  22
  23 #include <com/sun/star/beans/PropertySet.idl>
  24 #include <com/sun/star/sheet/XFormulaParser.idl>
  25 #include <com/sun/star/sheet/FormulaOpCodeMapEntry.idl>
  26 #include <com/sun/star/sheet/ExternalLinkInfo.idl>
  27
  28
  29 module com {  module sun {  module star {  module sheet {
  30
  31
  32 service FormulaParser
  33 {
  34
  35     service com::sun::star::beans::PropertySet;
  36
  37
  38     interface XFormulaParser;
  39
  40
  41     /** specifies whether to use English parser and formatter.
  42
  43         <p>Note: When changing this, an already existing #OpCodeMap
  44         needs to be recreated internally, so for performance reasons
  45         set this <em>before</em> setting the #OpCodeMap.
  46      */
  47     [property] boolean CompileEnglish;
  48
  49
  50     /** specifies which address reference style convention to use when
  51         parsing a formula string.
  52
  53         @see AddressConvention
  54       */
  55     [property] short FormulaConvention;
  56
  57
  58     [property] boolean IgnoreLeadingSpaces;
  59
  60
  61     [property] string ParameterSeparator;
  62
  63
  64     /** contains the complete mapping of names to op-codes.
  65
  66         <p>Names and symbols not defined here lead to a parser/print error.</p>
  67      */
  68     [property] sequence< FormulaOpCodeMapEntry > OpCodeMap;
  69
  70
  71     /** contains a list of external links referenced in formulas.
  72
  73         <p>Use of this property depends on the FormulaConvention
  74         in use. It is relevant only for
  75         AddressConvention::XL_OOX to map indices to external
  76         documents. The sequence must be in the order of indices used. Note
  77         that indices are 1-based, the sequence must start with an empty
  78         element.</p>
  79
  80         @since OOo 3.1
  81      */
  82     [property] sequence< ExternalLinkInfo > ExternalLinks;
  83
  84 };
  85
  86
  87 }; }; }; };
  88
  89 #endif
  90
  91 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */