rptui::FunctionDescription Class Reference

#include <FunctionHelper.hxx>

Inheritance diagram for rptui::FunctionDescription:

Collaboration diagram for rptui::FunctionDescription:

Public Member Functions
	FunctionDescription (const formula::IFunctionCategory *_pFunctionCategory, css::uno::Reference< css::report::meta::XFunctionDescription > _xFunctionDescription)
virtual	~FunctionDescription ()
virtual OUString	getFunctionName () const override
virtual const formula::IFunctionCategory *	getCategory () const override
virtual OUString	getDescription () const override
virtual sal_Int32	getSuppressedArgumentCount () const override
virtual OUString	getFormula (const ::std::vector< OUString > &_aArguments) const override
virtual void	fillVisibleArgumentMapping (::std::vector< sal_uInt16 > &_rArguments) const override
virtual void	initArgumentInfo () const override
virtual OUString	getSignature () const override
virtual OUString	getHelpId () const override
virtual bool	isHidden () const override
virtual sal_uInt32	getParameterCount () const override
virtual sal_uInt32	getVarArgsStart () const override
virtual sal_uInt32	getVarArgsLimit () const override
virtual OUString	getParameterName (sal_uInt32 _nPos) const override
virtual OUString	getParameterDescription (sal_uInt32 _nPos) const override
virtual bool	isParameterOptional (sal_uInt32 _nPos) const override
virtual OUString	getFunctionName () const=0
virtual const IFunctionCategory *	getCategory () const=0
virtual OUString	getDescription () const=0
virtual sal_Int32	getSuppressedArgumentCount () const=0
virtual OUString	getFormula (const ::std::vector< OUString > &_aArguments) const=0
virtual void	fillVisibleArgumentMapping (::std::vector< sal_uInt16 > &_rArguments) const=0
virtual void	initArgumentInfo () const=0
virtual OUString	getSignature () const=0
virtual OUString	getHelpId () const=0
virtual bool	isHidden () const=0
virtual sal_uInt32	getParameterCount () const=0
virtual sal_uInt32	getVarArgsStart () const=0
virtual sal_uInt32	getVarArgsLimit () const=0
virtual OUString	getParameterName (sal_uInt32 _nPos) const=0
virtual OUString	getParameterDescription (sal_uInt32 _nPos) const=0
virtual bool	isParameterOptional (sal_uInt32 _nPos) const=0

Private Attributes
css::uno::Sequence< css::sheet::FunctionArgument >	m_aParameter
css::uno::Reference< css::report::meta::XFunctionDescription >	m_xFunctionDescription
const formula::IFunctionCategory *	m_pFunctionCategory

Additional Inherited Members
Protected Member Functions inherited from formula::IFunctionDescription
	~IFunctionDescription ()

Detailed Description

Definition at line 56 of file FunctionHelper.hxx.

Constructor & Destructor Documentation

FunctionDescription()

rptui::FunctionDescription::FunctionDescription	(	const formula::IFunctionCategory *	_pFunctionCategory,
		css::uno::Reference< css::report::meta::XFunctionDescription >	_xFunctionDescription
	)

Definition at line 136 of file FunctionHelper.cxx.

References m_aParameter, and m_xFunctionDescription.

~FunctionDescription()

virtual rptui::FunctionDescription::~FunctionDescription ( )

inlinevirtual

Definition at line 63 of file FunctionHelper.hxx.

Member Function Documentation

fillVisibleArgumentMapping()

void rptui::FunctionDescription::fillVisibleArgumentMapping ( ::std::vector< sal_uInt16 > &  _rArguments ) const

overridevirtual

Implements formula::IFunctionDescription.

Definition at line 176 of file FunctionHelper.cxx.

References i, m_aParameter, and nCount.

getCategory()

const formula::IFunctionCategory * rptui::FunctionDescription::getCategory ( ) const

overridevirtual

Implements formula::IFunctionDescription.

Definition at line 147 of file FunctionHelper.cxx.

References m_pFunctionCategory.

getDescription()

OUString rptui::FunctionDescription::getDescription ( ) const

overridevirtual

Implements formula::IFunctionDescription.

Definition at line 152 of file FunctionHelper.cxx.

References m_xFunctionDescription.

getFormula()

OUString rptui::FunctionDescription::getFormula ( const ::std::vector< OUString > &  _aArguments ) const

overridevirtual

Implements formula::IFunctionDescription.

Definition at line 162 of file FunctionHelper.cxx.

References m_xFunctionDescription, sFormula, and TOOLS_WARN_EXCEPTION.

getFunctionName()

OUString rptui::FunctionDescription::getFunctionName ( ) const

overridevirtual

Implements formula::IFunctionDescription.

Definition at line 142 of file FunctionHelper.cxx.

References m_xFunctionDescription.

getHelpId()

OUString rptui::FunctionDescription::getHelpId ( ) const

overridevirtual

Implements formula::IFunctionDescription.

Definition at line 194 of file FunctionHelper.cxx.

getParameterCount()

sal_uInt32 rptui::FunctionDescription::getParameterCount ( ) const

overridevirtual

Implements formula::IFunctionDescription.

Definition at line 204 of file FunctionHelper.cxx.

References m_aParameter.

getParameterDescription()

OUString rptui::FunctionDescription::getParameterDescription ( sal_uInt32  _nPos ) const

overridevirtual

Implements formula::IFunctionDescription.

Definition at line 251 of file FunctionHelper.cxx.

References _nPos, m_aParameter, and o3tl::make_unsigned().

getParameterName()

OUString rptui::FunctionDescription::getParameterName ( sal_uInt32  _nPos ) const

overridevirtual

Implements formula::IFunctionDescription.

Definition at line 244 of file FunctionHelper.cxx.

References _nPos, m_aParameter, and o3tl::make_unsigned().

getSignature()

OUString rptui::FunctionDescription::getSignature ( ) const

overridevirtual

Implements formula::IFunctionDescription.

Definition at line 189 of file FunctionHelper.cxx.

References m_xFunctionDescription.

getSuppressedArgumentCount()

sal_Int32 rptui::FunctionDescription::getSuppressedArgumentCount ( ) const

overridevirtual

Implements formula::IFunctionDescription.

Definition at line 157 of file FunctionHelper.cxx.

References m_aParameter.

getVarArgsLimit()

sal_uInt32 rptui::FunctionDescription::getVarArgsLimit ( ) const

overridevirtual

Implements formula::IFunctionDescription.

Definition at line 239 of file FunctionHelper.cxx.

getVarArgsStart()

sal_uInt32 rptui::FunctionDescription::getVarArgsStart ( ) const

overridevirtual

Implements formula::IFunctionDescription.

Definition at line 209 of file FunctionHelper.cxx.

References m_aParameter, PAIRED_VAR_ARGS, and VAR_ARGS.

initArgumentInfo()

void rptui::FunctionDescription::initArgumentInfo ( ) const

overridevirtual

Implements formula::IFunctionDescription.

Definition at line 185 of file FunctionHelper.cxx.

isHidden()

bool rptui::FunctionDescription::isHidden ( ) const

overridevirtual

Implements formula::IFunctionDescription.

Definition at line 199 of file FunctionHelper.cxx.

isParameterOptional()

bool rptui::FunctionDescription::isParameterOptional ( sal_uInt32  _nPos ) const

overridevirtual

Implements formula::IFunctionDescription.

Definition at line 258 of file FunctionHelper.cxx.

References _nPos, m_aParameter, and o3tl::make_unsigned().

Member Data Documentation

m_aParameter

css::uno::Sequence< css::sheet::FunctionArgument > rptui::FunctionDescription::m_aParameter

private

Definition at line 58 of file FunctionHelper.hxx.

Referenced by fillVisibleArgumentMapping(), FunctionDescription(), getParameterCount(), getParameterDescription(), getParameterName(), getSuppressedArgumentCount(), getVarArgsStart(), and isParameterOptional().

m_pFunctionCategory

const formula::IFunctionCategory* rptui::FunctionDescription::m_pFunctionCategory

private

Definition at line 60 of file FunctionHelper.hxx.

Referenced by getCategory().

m_xFunctionDescription

css::uno::Reference< css::report::meta::XFunctionDescription> rptui::FunctionDescription::m_xFunctionDescription

private

Definition at line 59 of file FunctionHelper.hxx.

Referenced by FunctionDescription(), getDescription(), getFormula(), getFunctionName(), and getSignature().

---

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

• FunctionHelper.hxx
• FunctionHelper.cxx