1 files changed, 132 insertions, 0 deletions
diff --git a/offapi/com/sun/star/sheet/XFormulaOpCodeMapper.idl b/offapi/com/sun/star/sheet/XFormulaOpCodeMapper.idl
new file mode 100644
index 000000000..90fe048dd
--- /dev/null
+++ b/offapi/com/sun/star/sheet/XFormulaOpCodeMapper.idl
@@ -0,0 +1,132 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ *   Licensed to the Apache Software Foundation (ASF) under one or more
+ *   contributor license agreements. See the NOTICE file distributed
+ *   with this work for additional information regarding copyright
+ *   ownership. The ASF licenses this file to you under the Apache
+ *   License, Version 2.0 (the "License"); you may not use this file
+ *   except in compliance with the License. You may obtain a copy of
+ *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+
+#ifndef __com_sun_star_sheet_XFormulaOpCodeMapper_idl__
+#define __com_sun_star_sheet_XFormulaOpCodeMapper_idl__
+
+#include <com/sun/star/sheet/FormulaOpCodeMapEntry.idl>
+#include <com/sun/star/lang/IllegalArgumentException.idl>
+
+
+module com {  module sun {  module star {  module sheet {
+
+
+/** gives access to spreadsheet compiler token interns.
+ */
+interface XFormulaOpCodeMapper
+{
+
+    /** OpCode value used for external Add-In functions.
+
+        <p>Needed to be able to identify which of the function names map to an
+        Add-In implementation where this OpCode is used in the returned
+        mapping and the programmatic name is available as additional
+        information.</p>
+     */
+    [attribute, readonly] long OpCodeExternal;
+
+
+    /** OpCode value used for unknown functions.
+
+        <p>Used to identify which of the function names queried with
+        getMappings() are unknown to the implementation.</p>
+     */
+    [attribute, readonly] long OpCodeUnknown;
+
+
+    /** returns a sequence of tokens matching the input sequence of
+        strings in order.
+
+        @param Names
+            Sequence of names to be mapped. These can be function names,
+            operators, separators and other symbols the formula compiler
+            knows.
+
+        @param Language
+            Formula language to be used, one of FormulaLanguage
+            constants. If a constant unknown to the implementation is passed,
+            com::sun::star::lang::IllegalArgumentException
+            is thrown.
+
+        @returns
+            a sequence of FormulaToken matching the input
+            sequence in order.
+
+            <p>Each string element in parameter Names according to the formula
+            language in parameter Language is mapped to a FormulaToken
+            containing the internal OpCode used by the spreadsheet
+            application in FormulaToken::OpCode and by
+            contract maybe additional information in
+            FormulaToken::Data.</p>
+
+            <p>The order of the FormulaToken sequence returned matches the
+            input order of the string sequence.</p>
+
+            <p>An unknown Name string gets the OpCode value of
+            #OpCodeUnknown assigned.</p>
+
+            <p>Additional information in FormulaToken::Data
+            is returned for:
+            <ul>
+            <li>Add-in names: the programmatic name. The OpCode value used
+            for add-ins can be queried with the #OpCodeExternal
+            getter method.</li>
+            </ul></p>
+     */
+    sequence< FormulaToken > getMappings(
+            [in] sequence< string > Names,
+            [in] long Language )
+        raises( com::sun::star::lang::IllegalArgumentException );
+
+
+    /** returns a sequence of map entries for all available elements of
+        a given formula language.
+
+        @param Language
+            Formula language to be used, one of FormulaLanguage
+            constants. If a constant unknown to the implementation is passed,
+            com::sun::star::lang::IllegalArgumentException
+            is thrown.
+
+        @param Groups
+            Group of mappings to be returned, a bit mask of
+            FormulaMapGroup constants.
+
+        @returns
+            Sequence of FormulaOpCodeMapEntry.
+
+            <p>Each element of the formula language in parameter Language is
+            mapped to a FormulaToken containing the internal
+            OpCode used by the spreadsheet application in
+            FormulaToken::OpCode and by contract maybe additional
+            information in FormulaToken::Data. See
+            getMappings() for more details.</p>
+     */
+    sequence< FormulaOpCodeMapEntry > getAvailableMappings(
+            [in] long Language, [in] long Groups )
+        raises( com::sun::star::lang::IllegalArgumentException );
+
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */