offapi/com/sun/star/report/meta/XFormulaParser.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 #ifndef __com_sun_star_report_meta_XFormulaParser_idl__
  20 #define __com_sun_star_report_meta_XFormulaParser_idl__
  21
  22 #include <com/sun/star/lang/XComponent.idl>
  23 #include <com/sun/star/lang/DisposedException.idl>
  24 #include <com/sun/star/sheet/XFormulaParser.idl>
  25 #include <com/sun/star/sheet/FormulaOpCodeMapEntry.idl>
  26 #include <com/sun/star/sheet/XFormulaOpCodeMapper.idl>
  27 #include <com/sun/star/beans/XPropertySet.idl>
  28 module com {  module sun {  module star {  module report { module meta {
  29 /** identifies a XFormulaParser which allows to retrieve the meta data of all supported functions.
  30
  31 */
  32 interface XFormulaParser
  33 {
  34     /** allows life-time control of report engine.
  35      */
  36     interface com::sun::star::lang::XComponent;
  37
  38     interface com::sun::star::sheet::XFormulaParser;
  39
  40     /** gives access to the properties.
  41     */
  42     interface com::sun::star::beans::XPropertySet;
  43
  44     /** The complete mapping of Names to OpCodes.
  45
  46         Names and symbols not defined here lead to a parser/print error.
  47      */
  48     [attribute] sequence< com::sun::star::sheet::FormulaOpCodeMapEntry > OpCodeMap;
  49
  50     /** return the mapper for op codes.
  51     */
  52     [attribute,readonly] com::sun::star::sheet::XFormulaOpCodeMapper FormulaOpCodeMapper;
  53 };
  54
  55
  56 }; }; }; }; };
  57
  58 #endif
  59
  60 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */