LibreOffice Module sc (master)  1
Public Member Functions | Public Attributes | List of all members
XclFunctionInfo Struct Reference

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

#include <xlformula.hxx>

Collaboration diagram for XclFunctionInfo:
[legend]

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 311 of file xlformula.hxx.

Member Function Documentation

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().

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().

bool XclFunctionInfo::IsAddInEquivalent ( ) const
inline

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

Definition at line 335 of file xlformula.hxx.

References EXC_FUNCFLAG_ADDINEQUIV.

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

bool XclFunctionInfo::IsFixedParamCount ( ) const
inline

Returns true, if the function parameter count is fixed.

Definition at line 331 of file xlformula.hxx.

References EXC_FUNCID_EXTERNCALL, and mnMaxParamCount.

bool XclFunctionInfo::IsMacroFunc ( ) const
inline

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

Definition at line 333 of file xlformula.hxx.

References EXC_FUNCFLAG_ADDINEQUIV.

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

bool XclFunctionInfo::IsParamPairs ( ) const
inline

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

Definition at line 329 of file xlformula.hxx.

References EXC_FUNCFLAG_PARAMPAIRS, and get_flag().

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 327 of file xlformula.hxx.

References EXC_FUNCFLAG_VOLATILE, and get_flag().

Member Data Documentation

OpCode XclFunctionInfo::meOpCode

Definition at line 313 of file xlformula.hxx.

sal_uInt8 XclFunctionInfo::mnFlags

Information for all parameters.

Definition at line 319 of file xlformula.hxx.

sal_uInt8 XclFunctionInfo::mnMaxParamCount

Minimum number of parameters.

Definition at line 316 of file xlformula.hxx.

Referenced by IsFixedParamCount().

sal_uInt8 XclFunctionInfo::mnMinParamCount

Excel function index.

Definition at line 315 of file xlformula.hxx.

sal_uInt8 XclFunctionInfo::mnRetClass

Maximum number of parameters.

Definition at line 317 of file xlformula.hxx.

sal_uInt16 XclFunctionInfo::mnXclFunc

Calc function opcode.

Definition at line 314 of file xlformula.hxx.

const char* XclFunctionInfo::mpcMacroName

Additional flags (EXC_FUNCFLAG_* constants).

Definition at line 320 of file xlformula.hxx.

Referenced by GetAddInEquivalentFuncName(), and GetMacroFuncName().

XclFuncParamInfo XclFunctionInfo::mpParamInfos[EXC_FUNCINFO_PARAMINFO_COUNT]

Token class of the return value.

Definition at line 318 of file xlformula.hxx.


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