<html> <head> <title>Interface XFormulaOpCodeMapper</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XFormulaOpCodeMapper-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub"><a href="#AttributesSummary" class="navisub">Attributes' Summary</a></td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub"><a href="#AttributesDetails" class="navisub">Attributes' Details</a></td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">sheet</a> :: </p> </td> </tr> <tr> <td class="title"><table class="title-table" width="99%"> <tr> <td width="25%" class="title2">unpublished </td> <td width="50%" class="title">interface XFormulaOpCodeMapper</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>not published</i></dd> <dt><b>Description</b></dt> <dd>gives access to spreadsheet compiler token interns. </dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#getMappings">getMappings</a></td> <td class="imsum_right">returns a sequence of tokens matching the input sequence of strings in order. </td> </tr> <tr> <td class="imsum_left"><a href="#getAvailableMappings">getAvailableMappings</a></td> <td class="imsum_right">returns a sequence of map entries for all available elements of a given formula language. </td> </tr> </table> <a name="AttributesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Attributes' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#OpCodeExternal">OpCodeExternal</a></td> <td class="imsum_right">OpCode value used for external Add-In functions. </td> </tr> <tr> <td class="imsum_left"><a href="#OpCodeUnknown">OpCodeUnknown</a></td> <td class="imsum_right">OpCode value used for unknown functions. </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="getMappings" class="membertitle">getMappings</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">sequence< <a href="FormulaToken.html">FormulaToken</a> ></td> </tr> <tr> <td valign="top"><b>getMappings</b>(</td> <td valign="top">[in] sequence< string ></td> <td valign="bottom"> Names,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> Language )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns a sequence of tokens matching the input sequence of strings in order. </dd> <dt><b>Parameter Names</b></dt> <dd>Sequence of names to be mapped. These can be function names, operators, separators and other symbols the formula compiler knows. </dd> <dt><b>Parameter Language</b></dt> <dd>Formula language to be used, one of <a href="FormulaLanguage.html">FormulaLanguage</a> constants. If a constant unknown to the implementation is passed, ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> is thrown. </dd> <dt><b>Returns</b></dt> <dd>a sequence of <a href="FormulaToken.html">FormulaToken</a> 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 <a href="FormulaToken.html">FormulaToken</a> containing the internal OpCode used by the spreadsheet application in <a href="FormulaToken.html">FormulaToken</a>::<a href="FormulaToken.html#OpCode">OpCode</a> and by contract maybe additional information in <a href="FormulaToken.html">FormulaToken</a>::<a href="FormulaToken.html#Data">Data</a>.</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 <a href="#OpCodeUnknown">OpCodeUnknown</a> assigned.</p> <p>Additional information in <a href="FormulaToken.html">FormulaToken</a>::<a href="FormulaToken.html#Data">Data</a> is returned for: <ul> <li>Add-in names: the programmatic name. The OpCode value used for add-ins can be queried with the <a href="#OpCodeExternal">OpCodeExternal</a> getter method.</li> </ul></p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getAvailableMappings" class="membertitle">getAvailableMappings</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">sequence< <a href="FormulaOpCodeMapEntry.html">FormulaOpCodeMapEntry</a> ></td> </tr> <tr> <td valign="top"><b>getAvailableMappings</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> Language,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> Groups )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns a sequence of map entries for all available elements of a given formula language. </dd> <dt><b>Parameter Language</b></dt> <dd>Formula language to be used, one of <a href="FormulaLanguage.html">FormulaLanguage</a> constants. If a constant unknown to the implementation is passed, ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> is thrown. </dd> <dt><b>Parameter Groups</b></dt> <dd>Group of mappings to be returned, a bit mask of <a href="FormulaMapGroup.html">FormulaMapGroup</a> constants. </dd> <dt><b>Returns</b></dt> <dd>Sequence of <a href="FormulaOpCodeMapEntry.html">FormulaOpCodeMapEntry</a>. <p>Each element of the formula language in parameter Language is mapped to a <a href="FormulaToken.html">FormulaToken</a> containing the internal OpCode used by the spreadsheet application in <a href="FormulaToken.html">FormulaToken</a>::<a href="FormulaToken.html#OpCode">OpCode</a> and by contract maybe additional information in <a href="FormulaToken.html">FormulaToken</a>::<a href="FormulaToken.html#Data">Data</a>. See <a href="#getMappings">getMappings</a> for more details.</p> </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a name="AttributesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Attributes' Details</td> </tr> <tr> <td class="imdetail"><a name="OpCodeExternal" class="membertitle">OpCodeExternal</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] long <b>OpCodeExternal</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>OpCode value used for external Add-In functions. </dd> <dd><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> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="OpCodeUnknown" class="membertitle">OpCodeUnknown</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] long <b>OpCodeUnknown</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>OpCode value used for unknown functions. </dd> <dd><p>Used to identify which of the function names queried with <a href="#getMappings">getMappings</a> are unknown to the implementation.</p> </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2000, 2012 LibreOffice contributors and/or their affiliates. All rights reserved.</p><p class="copyright" align="center">LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.</p><p class="copyright" align="center">The Document Foundation acknowledges all community members, please find more info <a href="http://www.libreoffice.org/about-us/credits/" target="_blank">at our website</a>.<p> </p><p class="copyright" align="center"><a href="http://www.libreoffice.org/privacy" target="_blank">Privacy Policy</a> | <a href="http://www.libreoffice.org/imprint" target="_blank">Impressum (Legal Info)</a> | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (<a href="http://www.libreoffice.org/download/license/" target="_blank">LGPLv3</a>). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our <a href="http://wiki.documentfoundation.org/TradeMark_Policy" target="_blank">trademark policy</a>.</p> </div> <!-- id="adc-idlref" --> </body> </html>
