diff options
Diffstat (limited to 'include/formula/IFunctionDescription.hxx')
| -rw-r--r-- | include/formula/IFunctionDescription.hxx | 170 |
1 files changed, 170 insertions, 0 deletions
diff --git a/include/formula/IFunctionDescription.hxx b/include/formula/IFunctionDescription.hxx new file mode 100644 index 000000000000..1747c2f2ddce --- /dev/null +++ b/include/formula/IFunctionDescription.hxx @@ -0,0 +1,170 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ + +#ifndef INCLUDE_FUNCTION_DESCRIPTION +#define INCLUDE_FUNCTION_DESCRIPTION + +#include <vector> +#include <memory> +#include "formula/formuladllapi.h" +#include <rtl/ustring.hxx> +#include <tools/string.hxx> +#include <com/sun/star/sheet/XFormulaParser.hpp> +#include <com/sun/star/sheet/XFormulaOpCodeMapper.hpp> + +class SvTreeListEntry; + +namespace formula +{ + class IFunctionCategory; + class IFunctionDescription; + class FormEditData; + class FormulaTokenArray; + + class SAL_NO_VTABLE IFunctionManager + { + public: + IFunctionManager(){} + enum EToken + { + eOk, + eClose, + eSep, + eArrayOpen, + eArrayClose + }; + virtual sal_uInt32 getCount() const = 0; + virtual const IFunctionCategory* getCategory(sal_uInt32 nPos) const = 0; + virtual void fillLastRecentlyUsedFunctions(::std::vector< const IFunctionDescription*>& _rLastRUFunctions) const = 0; + virtual const IFunctionDescription* getFunctionByName(const OUString& _sFunctionName) const = 0; + + virtual sal_Unicode getSingleToken(const EToken _eToken) const = 0; + + protected: + ~IFunctionManager() {} + }; + + class SAL_NO_VTABLE IFunctionCategory + { + public: + IFunctionCategory(){} + virtual const IFunctionManager* getFunctionManager() const = 0; + virtual sal_uInt32 getCount() const = 0; + virtual const IFunctionDescription* getFunction(sal_uInt32 _nPos) const = 0; + virtual sal_uInt32 getNumber() const = 0; + virtual OUString getName() const = 0; + + protected: + ~IFunctionCategory() {} + }; + + class SAL_NO_VTABLE IFunctionDescription + { + public: + IFunctionDescription(){} + virtual OUString getFunctionName() const = 0; + virtual const IFunctionCategory* getCategory() const = 0; + virtual OUString getDescription() const = 0; + // GetSuppressedArgCount + virtual xub_StrLen getSuppressedArgumentCount() const = 0; + // GetFormulaString + virtual OUString getFormula(const ::std::vector< OUString >& _aArguments) const = 0; + // GetVisibleArgMapping + virtual void fillVisibleArgumentMapping(::std::vector<sal_uInt16>& _rArguments) const = 0; + virtual void initArgumentInfo() const = 0; + virtual OUString getSignature() const = 0; + virtual OString getHelpId() const = 0; + + // parameter + virtual sal_uInt32 getParameterCount() 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; + + protected: + ~IFunctionDescription() {} + }; + + class SAL_NO_VTABLE IFormulaToken + { + public: + virtual bool isFunction() const = 0; + virtual sal_uInt32 getArgumentCount() const = 0; + + protected: + ~IFormulaToken() {} + }; + + class SAL_NO_VTABLE IStructHelper + { + public: + IStructHelper(){} + virtual SvTreeListEntry* InsertEntry(const XubString& rText, SvTreeListEntry* pParent, + sal_uInt16 nFlag,sal_uLong nPos=0,IFormulaToken* pScToken=NULL) = 0; + + virtual String GetEntryText(SvTreeListEntry* pEntry) const = 0; + virtual SvTreeListEntry* GetParent(SvTreeListEntry* pEntry) const = 0; + + protected: + ~IStructHelper() {} + }; + + class SAL_NO_VTABLE IFormulaEditorHelper + { + public: + IFormulaEditorHelper(){} + virtual void notifyChange() = 0; + virtual void fill() = 0; + + virtual String getCurrentFormula() const = 0; + virtual void setCurrentFormula(const String& _sReplacement) = 0; + + virtual void getSelection(xub_StrLen& _nStart,xub_StrLen& _nEnd) const = 0; + virtual void setSelection(xub_StrLen _nStart,xub_StrLen _nEnd) = 0; + + virtual FormEditData* getFormEditData() const = 0; + virtual bool calculateValue(const String& _sExpression,String& _rResult) = 0; + + virtual void switchBack() = 0; + + virtual void clear() = 0; + virtual void deleteFormData() = 0; + virtual void setReferenceInput(const FormEditData* _pData) = 0; + + virtual IFunctionManager* getFunctionManager() = 0; + virtual ::std::auto_ptr<FormulaTokenArray> convertToTokenArray(const ::com::sun::star::uno::Sequence< ::com::sun::star::sheet::FormulaToken >& _aTokenList) = 0; + + virtual ::com::sun::star::uno::Reference< ::com::sun::star::sheet::XFormulaParser> getFormulaParser() const = 0; + virtual ::com::sun::star::uno::Reference< ::com::sun::star::sheet::XFormulaOpCodeMapper> getFormulaOpCodeMapper() const = 0; + virtual ::com::sun::star::table::CellAddress getReferencePosition() const = 0; + + virtual void setDispatcherLock( sal_Bool bLock ) = 0; + virtual void dispatch(sal_Bool _bOK,sal_Bool _bMartixChecked) = 0; + virtual void doClose(sal_Bool _bOk) = 0; + virtual void insertEntryToLRUList(const IFunctionDescription* pDesc) = 0; + virtual void showReference(const String& _sFormula) = 0; + + protected: + ~IFormulaEditorHelper() {} + }; + +} +#endif //INCLUDE_FUNCTION_DESCRIPTION + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |