XclFunctionInfo Struct Reference

Represents information for a spreadsheet function for import and export. More...

#include <xlformula.hxx>

Collaboration diagram for XclFunctionInfo:

Public Member Functions
bool	IsVolatile () const
	Function name, if simulated by a macro call (UTF-8) EXC_FUNCFLAG_ADDINEQUIV is 0; or programmatical add-in name if stored as such and EXC_FUNCFLAG_ADDINEQUIV is set. More...
bool	IsParamPairs () const
	Returns true, if optional parameters are expected to appear in pairs. More...
bool	IsFixedParamCount () const
	Returns true, if the function parameter count is fixed. More...
bool	IsMacroFunc () const
	Returns true, if the function is simulated by a macro call. More...
bool	IsAddInEquivalent () const
	Returns true, if the function is stored as an add-in call. More...
OUString	GetMacroFuncName () const
	Returns the name of the external function as string. More...
OUString	GetAddInEquivalentFuncName () const
	Returns the programmatical name of the Add-In function as string. More...

Public Attributes
OpCode	meOpCode
sal_uInt16	mnXclFunc
	Calc function opcode. More...
sal_uInt8	mnMinParamCount
	Excel function index. More...
sal_uInt8	mnMaxParamCount
	Minimum number of parameters. More...
sal_uInt8	mnRetClass
	Maximum number of parameters. More...
XclFuncParamInfo	mpParamInfos [EXC_FUNCINFO_PARAMINFO_COUNT]
	Token class of the return value. More...
sal_uInt8	mnFlags
	Information for all parameters. More...
const char *	mpcMacroName
	Additional flags (EXC_FUNCFLAG_* constants). More...

Detailed Description

Represents information for a spreadsheet function for import and export.

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

Definition at line 310 of file xlformula.hxx.

Member Function Documentation

GetAddInEquivalentFuncName()

OUString XclFunctionInfo::GetAddInEquivalentFuncName

(

)

const

Returns the programmatical name of the Add-In function as string.

Definition at line 42 of file xlformula.cxx.

References IsAddInEquivalent(), and mpcMacroName.

Referenced by XclExpFmlaCompImpl::ProcessFunction().

GetMacroFuncName()

OUString XclFunctionInfo::GetMacroFuncName

(

)

const

Returns the name of the external function as string.

Definition at line 35 of file xlformula.cxx.

References IsMacroFunc(), and mpcMacroName.

Referenced by XclExpFmlaCompImpl::ProcessFunction().

IsAddInEquivalent()

bool XclFunctionInfo::IsAddInEquivalent ( ) const

inline

Returns true, if the function is stored as an add-in call.

Definition at line 334 of file xlformula.hxx.

References EXC_FUNCFLAG_ADDINEQUIV, mnFlags, and mpcMacroName.

Referenced by GetAddInEquivalentFuncName(), and XclExpFmlaCompImpl::ProcessFunction().

IsFixedParamCount()

bool XclFunctionInfo::IsFixedParamCount ( ) const

inline

Returns true, if the function parameter count is fixed.

Definition at line 330 of file xlformula.hxx.

References EXC_FUNCID_EXTERNCALL, mnMaxParamCount, mnMinParamCount, and mnXclFunc.

IsMacroFunc()

bool XclFunctionInfo::IsMacroFunc ( ) const

inline

Returns true, if the function is simulated by a macro call.

Definition at line 332 of file xlformula.hxx.

References EXC_FUNCFLAG_ADDINEQUIV, mnFlags, and mpcMacroName.

Referenced by GetMacroFuncName(), and XclExpFmlaCompImpl::ProcessFunction().

IsParamPairs()

bool XclFunctionInfo::IsParamPairs ( ) const

inline

Returns true, if optional parameters are expected to appear in pairs.

Definition at line 328 of file xlformula.hxx.

References EXC_FUNCFLAG_PARAMPAIRS, get_flag(), and mnFlags.

IsVolatile()

bool XclFunctionInfo::IsVolatile ( ) const

inline

Function name, if simulated by a macro call (UTF-8) EXC_FUNCFLAG_ADDINEQUIV is 0; or programmatical add-in name if stored as such and EXC_FUNCFLAG_ADDINEQUIV is set.

Returns true, if the function is volatile.

Definition at line 326 of file xlformula.hxx.

References EXC_FUNCFLAG_VOLATILE, get_flag(), and mnFlags.

Member Data Documentation

meOpCode

OpCode XclFunctionInfo::meOpCode

Definition at line 312 of file xlformula.hxx.

mnFlags

sal_uInt8 XclFunctionInfo::mnFlags

Information for all parameters.

Definition at line 318 of file xlformula.hxx.

Referenced by IsAddInEquivalent(), IsMacroFunc(), IsParamPairs(), and IsVolatile().

mnMaxParamCount

sal_uInt8 XclFunctionInfo::mnMaxParamCount

Minimum number of parameters.

Definition at line 315 of file xlformula.hxx.

Referenced by IsFixedParamCount().

mnMinParamCount

sal_uInt8 XclFunctionInfo::mnMinParamCount

Excel function index.

Definition at line 314 of file xlformula.hxx.

Referenced by IsFixedParamCount().

mnRetClass

sal_uInt8 XclFunctionInfo::mnRetClass

Maximum number of parameters.

Definition at line 316 of file xlformula.hxx.

mnXclFunc

sal_uInt16 XclFunctionInfo::mnXclFunc

Calc function opcode.

Definition at line 313 of file xlformula.hxx.

Referenced by IsFixedParamCount().

mpcMacroName

const char* XclFunctionInfo::mpcMacroName

Additional flags (EXC_FUNCFLAG_* constants).

Definition at line 319 of file xlformula.hxx.

Referenced by GetAddInEquivalentFuncName(), GetMacroFuncName(), IsAddInEquivalent(), and IsMacroFunc().

mpParamInfos

XclFuncParamInfo XclFunctionInfo::mpParamInfos[EXC_FUNCINFO_PARAMINFO_COUNT]

Token class of the return value.

Definition at line 317 of file xlformula.hxx.

---

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

• xlformula.hxx
• xlformula.cxx