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
  21 module com {  module sun {  module star {  module sheet {
  22
  23
  24 service FormulaParser
  25 {
  26
  27     service com::sun::star::beans::PropertySet;
  28
  29
  30     interface XFormulaParser;
  31
  32
  33     /** specifies whether to use English parser and formatter.
  34
  35         <p>Note: When changing this, an already existing #OpCodeMap
  36         needs to be recreated internally, so for performance reasons
  37         set this <em>before</em> setting the #OpCodeMap.
  38      */
  39     [property] boolean CompileEnglish;
  40
  41
  42     /** specifies which address reference style convention to use when
  43         parsing a formula string.
  44
  45         @see AddressConvention
  46       */
  47     [property] short FormulaConvention;
  48
  49
  50     [property] boolean IgnoreLeadingSpaces;
  51
  52
  53     [property] string ParameterSeparator;
  54
  55
  56     /** contains the complete mapping of names to op-codes.
  57
  58         <p>Names and symbols not defined here lead to a parser/print error.</p>
  59      */
  60     [property] sequence< FormulaOpCodeMapEntry > OpCodeMap;
  61
  62
  63     /** contains a list of external links referenced in formulas.
  64
  65         <p>Use of this property depends on the FormulaConvention
  66         in use. It is relevant only for
  67         AddressConvention::XL_OOX to map indices to external
  68         documents. The sequence must be in the order of indices used. Note
  69         that indices are 1-based, the sequence must start with an empty
  70         element.</p>
  71
  72         @since OOo 3.1
  73      */
  74     [property] sequence< ExternalLinkInfo > ExternalLinks;
  75
  76
  77     /** specifies that use special ooxml chart syntax in case of OOXML reference
  78         convention, when parsing a formula string.
  79
  80         <p>Special syntax like: [0]!GlobalNamedRange, LocalSheet!LocalNamedRange</p>
  81
  82         @since LibreOffice 7.3
  83      */
  84     [property] boolean RefConventionChartOOXML;
  85
  86 };
  87
  88
  89 }; }; }; };
  90
  91 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */