LibreOffice
LibreOffice 5.3 SDK API Reference
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Variables
com::sun::star::sheet::FormulaMapGroupSpecialOffset Constant Group Reference

Constants designating the offsets within the sequence returned by XFormulaOpCodeMapper::getAvailableMappings() when called for group FormulaMapGroup::SPECIAL. More...

Variables

const long PUSH = 0
 Formula tokens containing the op-code obtained from this offset describe a formula operand token that will be pushed onto the formula stack while the formula is interpreted. More...
 
const long CALL = 1
 
const long STOP = 2
 Formula tokens containing the op-code obtained from this offset instruct the formula interpreter to immediately stop interpreting the formula. More...
 
const long EXTERNAL = 3
 Formula tokens containing the op-code obtained from this offset describe the reference to an external function (e.g. More...
 
const long NAME = 4
 Formula tokens containing the op-code obtained from this offset describe the reference to a defined name (also known as named range) used in formulas. More...
 
const long NO_NAME = 5
 Formula tokens containing the op-code obtained from this offset describe an invalid name that resolves to the NAME? error in formulas. More...
 
const long MISSING = 6
 Formula tokens containing the op-code obtained from this offset describe an empty function parameter. More...
 
const long BAD = 7
 Formula tokens containing the op-code obtained from this offset describe "bad" data in a formula, e.g. More...
 
const long SPACES = 8
 Formula tokens containing the op-code obtained from this offset describe whitespace characters within the string representation of a formula. More...
 
const long MAT_REF = 9
 
const long DB_AREA = 10
 Formula tokens containing the op-code obtained from this offset describe the reference to a database range used in formulas. More...
 
const long MACRO = 11
 Formula tokens containing the op-code obtained from this offset describe the reference to a macro function called in a formula. More...
 
const long COL_ROW_NAME = 12
 

Detailed Description

Constants designating the offsets within the sequence returned by XFormulaOpCodeMapper::getAvailableMappings() when called for group FormulaMapGroup::SPECIAL.

The number of constants may grow in future versions!

Variable Documentation

const long BAD = 7

Formula tokens containing the op-code obtained from this offset describe "bad" data in a formula, e.g.

data the formula parser was not able to parse.

The FormulaToken::Data member shall contain a string with the bad data. This string will be displayed literally in the formula.

const long CALL = 1
const long COL_ROW_NAME = 12
const long DB_AREA = 10

Formula tokens containing the op-code obtained from this offset describe the reference to a database range used in formulas.

The FormulaToken::Data member shall contain an integer value of type long specifying the index of the database range. This index can be obtained from the database range using its DatabaseRange::TokenIndex property.

See Also
DatabaseRange
const long EXTERNAL = 3

Formula tokens containing the op-code obtained from this offset describe the reference to an external function (e.g.

add-in function) used in formulas.

The FormulaToken::Data member shall contain a string with the programmatic name of the function, e.g. "com.sun.star.sheet.addin.Analysis.getEomonth" for the EOMONTH function from the Analysis add-in.

const long MACRO = 11

Formula tokens containing the op-code obtained from this offset describe the reference to a macro function called in a formula.

The FormulaToken::Data member shall contain a string specifying the name of the macro function.

const long MAT_REF = 9
const long MISSING = 6

Formula tokens containing the op-code obtained from this offset describe an empty function parameter.

Example: In the formula =SUM(1;;2) the second parameter is empty and represented by a formula token containing the "missing" op-code.

The FormulaToken::Data member is not used and should be empty.

const long NAME = 4

Formula tokens containing the op-code obtained from this offset describe the reference to a defined name (also known as named range) used in formulas.

The FormulaToken::Data member shall contain an integer value of type long specifying the index of the defined name. This index can be obtained from the defined name using its NamedRange::TokenIndex property.

See Also
NamedRange
const long NO_NAME = 5

Formula tokens containing the op-code obtained from this offset describe an invalid name that resolves to the NAME? error in formulas.

The FormulaToken::Data member is not used and should be empty.

const long PUSH = 0

Formula tokens containing the op-code obtained from this offset describe a formula operand token that will be pushed onto the formula stack while the formula is interpreted.

The FormulaToken::Data member shall contain one of the following values:

  • A value of type double for literal floating-point constants.
  • A string for literal text.
  • A any[][] for a literal array. The contained values shall be of type double or string. Floating-point values and strings may occur together in an array.
  • A struct of type SingleReference for a reference to a single cell in the own document.
  • A struct of type ComplexReference for a reference to a range of cells in the own document.
  • A struct of type ExternalReference for a reference to a cell, a range of cells, or a defined name in an external document.
const long SPACES = 8

Formula tokens containing the op-code obtained from this offset describe whitespace characters within the string representation of a formula.

Whitespace characters in formulas are used for readability and do not affect the result of the formula.

The FormulaToken::Data member shall contain a positive integer value of type long specifying the number of space characters.

Attention: This may change in next versions to support other characters than simple space characters (e.g. line feeds, horizontal tabulators, non-breakable spaces).

const long STOP = 2

Formula tokens containing the op-code obtained from this offset instruct the formula interpreter to immediately stop interpreting the formula.

The FormulaToken::Data member is not used and should be empty.