Represents information for a spreadsheet function. More...

#include <formulabase.hxx>

Collaboration diagram for oox::xls::FunctionInfo:

Public Attributes
OUString	maOdfFuncName

OUString	maOoxFuncName
	ODF function name. More...

OUString	maBiffMacroName
	OOXML function name. More...

OUString	maExtProgName
	Expected macro name in EXTERN.CALL function. More...

FunctionLibraryType	meFuncLibType
	Programmatic function name for external functions. More...

sal_Int32	mnApiOpCode
	The external library this function is part of. More...

sal_uInt16	mnBiff12FuncId
	API function opcode. More...

sal_uInt16	mnBiffFuncId
	BIFF12 function identifier. More...

sal_uInt8	mnMinParamCount
	BIFF2-BIFF8 function identifier. More...

sal_uInt8	mnMaxParamCount
	Minimum number of parameters. More...

sal_uInt8	mnRetClass
	Maximum number of parameters. More...

const FunctionParamInfo *	mpParamInfos
	BIFF token class of the return value. More...

bool	mbParamPairs
	Information about all parameters. More...

bool	mbVolatile
	True = optional parameters are expected to appear in pairs. More...

bool	mbExternal
	True = volatile function. More...

bool	mbInternal
	True = external function in Calc. More...

bool	mbMacroFunc
	True = internal function in Calc. (Both can be true!) More...

bool	mbVarParam
	True = macro sheet function or command. More...

Detailed Description

Represents information for a spreadsheet function.

The member mpParamInfos points to a C-array of type information structures for all parameters of the function. The last initialized structure describing a regular parameter (member meValid == FuncParamValidity::Regular) in this array is used repeatedly for all following parameters supported by a function.

Definition at line 478 of file formulabase.hxx.

Member Data Documentation

◆ maBiffMacroName

OUString oox::xls::FunctionInfo::maBiffMacroName

OOXML function name.

Definition at line 482 of file formulabase.hxx.

◆ maExtProgName

OUString oox::xls::FunctionInfo::maExtProgName

Expected macro name in EXTERN.CALL function.

Definition at line 483 of file formulabase.hxx.

Referenced by oox::xls::OpCodeProviderImpl::initFuncOpCode(), oox::xls::FormulaParserImpl::pushExternalFuncOperand(), and oox::xls::FormulaParserImpl::pushFunctionOperatorToken().

◆ maOdfFuncName

OUString oox::xls::FunctionInfo::maOdfFuncName

Definition at line 480 of file formulabase.hxx.

Referenced by oox::xls::OpCodeProviderImpl::initFuncOpCode().

◆ maOoxFuncName

OUString oox::xls::FunctionInfo::maOoxFuncName

ODF function name.

Definition at line 481 of file formulabase.hxx.

Referenced by oox::xls::OpCodeProviderImpl::initFuncOpCode(), and oox::xls::FormulaParserImpl::pushFunctionOperatorToken().

◆ mbExternal

bool oox::xls::FunctionInfo::mbExternal

True = volatile function.

Definition at line 494 of file formulabase.hxx.

◆ mbInternal

bool oox::xls::FunctionInfo::mbInternal

True = external function in Calc.

Definition at line 495 of file formulabase.hxx.

◆ mbMacroFunc

bool oox::xls::FunctionInfo::mbMacroFunc

True = internal function in Calc. (Both can be true!)

Definition at line 496 of file formulabase.hxx.

◆ mbParamPairs

bool oox::xls::FunctionInfo::mbParamPairs

Information about all parameters.

Definition at line 492 of file formulabase.hxx.

◆ mbVarParam

bool oox::xls::FunctionInfo::mbVarParam

True = macro sheet function or command.

Definition at line 497 of file formulabase.hxx.

◆ mbVolatile

bool oox::xls::FunctionInfo::mbVolatile

True = optional parameters are expected to appear in pairs.

Definition at line 493 of file formulabase.hxx.

◆ meFuncLibType

FunctionLibraryType oox::xls::FunctionInfo::meFuncLibType

Programmatic function name for external functions.

Definition at line 484 of file formulabase.hxx.

Referenced by oox::xls::OOXMLFormulaParserImpl::resolveBadFuncName().

◆ mnApiOpCode

sal_Int32 oox::xls::FunctionInfo::mnApiOpCode

The external library this function is part of.

Definition at line 485 of file formulabase.hxx.

Referenced by oox::xls::FormulaFinalizer::getExternCallInfo(), oox::xls::FormulaFinalizer::getFunctionInfo(), oox::xls::OpCodeProviderImpl::initFuncOpCode(), oox::xls::FormulaParserImpl::pushExternalFuncOperand(), and oox::xls::FormulaParserImpl::pushFunctionOperatorToken().

◆ mnBiff12FuncId

sal_uInt16 oox::xls::FunctionInfo::mnBiff12FuncId

API function opcode.

Definition at line 486 of file formulabase.hxx.

Referenced by oox::xls::FormulaFinalizer::appendCalcOnlyParameter(), oox::xls::FormulaFinalizer::appendEmptyParameter(), and oox::xls::FormulaFinalizer::appendRequiredParameters().

◆ mnBiffFuncId

sal_uInt16 oox::xls::FunctionInfo::mnBiffFuncId

BIFF12 function identifier.

Definition at line 487 of file formulabase.hxx.

Referenced by oox::xls::OpCodeProviderImpl::initFuncOpCode(), and oox::xls::FormulaFinalizer::processParameters().

◆ mnMaxParamCount

sal_uInt8 oox::xls::FunctionInfo::mnMaxParamCount

Minimum number of parameters.

Definition at line 489 of file formulabase.hxx.

◆ mnMinParamCount

sal_uInt8 oox::xls::FunctionInfo::mnMinParamCount

BIFF2-BIFF8 function identifier.

Definition at line 488 of file formulabase.hxx.

◆ mnRetClass

sal_uInt8 oox::xls::FunctionInfo::mnRetClass

Maximum number of parameters.

Definition at line 490 of file formulabase.hxx.

◆ mpParamInfos

const FunctionParamInfo* oox::xls::FunctionInfo::mpParamInfos

BIFF token class of the return value.

Definition at line 491 of file formulabase.hxx.

The documentation for this struct was generated from the following file:

formulabase.hxx

Public Attributes