diff options
Diffstat (limited to 'sc/inc/validat.hxx')
| -rw-r--r-- | sc/inc/validat.hxx | 213 |
1 files changed, 213 insertions, 0 deletions
diff --git a/sc/inc/validat.hxx b/sc/inc/validat.hxx new file mode 100644 index 000000000000..1bff57055f82 --- /dev/null +++ b/sc/inc/validat.hxx @@ -0,0 +1,213 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef SC_VALIDAT_HXX +#define SC_VALIDAT_HXX + +#include "conditio.hxx" +#include <com/sun/star/sheet/TableValidationVisibility.hpp> +#include "scdllapi.h" + +namespace ValidListType = ::com::sun::star::sheet::TableValidationVisibility; + +class ScPatternAttr; +class ScTokenArray; +class TypedScStrCollection; + +enum ScValidationMode +{ + SC_VALID_ANY, + SC_VALID_WHOLE, + SC_VALID_DECIMAL, + SC_VALID_DATE, + SC_VALID_TIME, + SC_VALID_TEXTLEN, + SC_VALID_LIST, + SC_VALID_CUSTOM +}; + +enum ScValidErrorStyle +{ + SC_VALERR_STOP, + SC_VALERR_WARNING, + SC_VALERR_INFO, + SC_VALERR_MACRO +}; + +// +// Eintrag fuer Gueltigkeit (es gibt nur eine Bedingung) +// + +class SC_DLLPUBLIC ScValidationData : public ScConditionEntry +{ + sal_uInt32 nKey; // Index in Attributen + + ScValidationMode eDataMode; + BOOL bShowInput; + BOOL bShowError; + ScValidErrorStyle eErrorStyle; + sal_Int16 mnListType; // selection list type: none, unsorted, sorted. + String aInputTitle; + String aInputMessage; + String aErrorTitle; + String aErrorMessage; + + BOOL bIsUsed; // temporaer beim Speichern + + BOOL DoMacro( const ScAddress& rPos, const String& rInput, + ScFormulaCell* pCell, Window* pParent ) const; + + BOOL DoScript( const ScAddress& rPos, const String& rInput, + ScFormulaCell* pCell, Window* pParent ) const; + + using ScConditionEntry::operator==; + +public: + ScValidationData( ScValidationMode eMode, ScConditionMode eOper, + const String& rExpr1, const String& rExpr2, + ScDocument* pDocument, const ScAddress& rPos, + const String& rExprNmsp1 = EMPTY_STRING, const String& rExprNmsp2 = EMPTY_STRING, + formula::FormulaGrammar::Grammar eGrammar1 = formula::FormulaGrammar::GRAM_DEFAULT, + formula::FormulaGrammar::Grammar eGrammar2 = formula::FormulaGrammar::GRAM_DEFAULT ); + ScValidationData( ScValidationMode eMode, ScConditionMode eOper, + const ScTokenArray* pArr1, const ScTokenArray* pArr2, + ScDocument* pDocument, const ScAddress& rPos ); + ScValidationData( const ScValidationData& r ); + ScValidationData( ScDocument* pDocument, const ScValidationData& r ); + virtual ~ScValidationData(); + + ScValidationData* Clone() const // echte Kopie + { return new ScValidationData( GetDocument(), *this ); } + ScValidationData* Clone(ScDocument* pNew) const + { return new ScValidationData( pNew, *this ); } + + void ResetInput(); + void ResetError(); + void SetInput( const String& rTitle, const String& rMsg ); + void SetError( const String& rTitle, const String& rMsg, + ScValidErrorStyle eStyle ); + + BOOL GetInput( String& rTitle, String& rMsg ) const + { rTitle = aInputTitle; rMsg = aInputMessage; return bShowInput; } + BOOL GetErrMsg( String& rTitle, String& rMsg, ScValidErrorStyle& rStyle ) const; + + BOOL HasErrMsg() const { return bShowError; } + + ScValidationMode GetDataMode() const { return eDataMode; } + + inline sal_Int16 GetListType() const { return mnListType; } + inline void SetListType( sal_Int16 nListType ) { mnListType = nListType; } + + /** Returns true, if the validation cell will show a selection list. + @descr Use this instead of GetListType() which returns the raw property + regardless of the validation type. */ + bool HasSelectionList() const; + /** Tries to fill the passed collection with list validation entries. + @descr Fills the list only, if this is a list validation and IsShowList() is enabled. + @param rStrings (out-param) The string list to fill with list validation entires. + @return true = rStrings has been filled with at least one entry. */ + bool FillSelectionList( TypedScStrCollection& rStrings, const ScAddress& rPos ) const; + + // mit String: bei Eingabe, mit Zelle: fuer Detektiv / RC_FORCED + BOOL IsDataValid( const String& rTest, const ScPatternAttr& rPattern, + const ScAddress& rPos ) const; + BOOL IsDataValid( ScBaseCell* pCell, const ScAddress& rPos ) const; + + // TRUE -> Abbruch + BOOL DoError( Window* pParent, const String& rInput, const ScAddress& rPos ) const; + void DoCalcError( ScFormulaCell* pCell ) const; + + BOOL IsEmpty() const; + sal_uInt32 GetKey() const { return nKey; } + void SetKey(sal_uInt32 nNew) { nKey = nNew; } // nur wenn nicht eingefuegt! + + void SetUsed(BOOL bSet) { bIsUsed = bSet; } + BOOL IsUsed() const { return bIsUsed; } + + BOOL EqualEntries( const ScValidationData& r ) const; // fuer Undo + + // sortiert (per PTRARR) nach Index + // operator== nur fuer die Sortierung + BOOL operator ==( const ScValidationData& r ) const { return nKey == r.nKey; } + BOOL operator < ( const ScValidationData& r ) const { return nKey < r.nKey; } + +private: + /** Tries to fill the passed collection with list validation entries. + @descr Fills the list only if it is non-NULL, + @param pStrings (out-param) Optionally NULL, string list to fill with list validation entires. + @param pCell can be NULL if it is not necessary to which element in the list is selected. + @param rPos the base address for relative references. + @param rTokArr Formula token array. + @param rMatch (out-param) the index of the first item that matched, -1 if nothing matched. + @return true = Cell range found, rRange is valid, or an error entry stuffed into the list if pCell==NULL. */ + bool GetSelectionFromFormula( TypedScStrCollection* pStrings, + ScBaseCell* pCell, const ScAddress& rPos, + const ScTokenArray& rTokArr, int& rMatch ) const; + + /** Tests, if pCell is equal to what the passed token array represents. */ + bool IsEqualToTokenArray( ScBaseCell* pCell, const ScAddress& rPos, const ScTokenArray& rTokArr ) const; + + /** Tests, if contents of pCell occur in cell range referenced by own formula, or in a string list. */ + bool IsListValid( ScBaseCell* pCell, const ScAddress& rPos ) const; +}; + +// +// Liste der Bedingungen: +// + +typedef ScValidationData* ScValidationDataPtr; + +SV_DECL_PTRARR_SORT(ScValidationEntries_Impl, ScValidationDataPtr, + SC_COND_GROW, SC_COND_GROW) + +class ScValidationDataList : public ScValidationEntries_Impl +{ +public: + ScValidationDataList() {} + ScValidationDataList(const ScValidationDataList& rList); + ScValidationDataList(ScDocument* pNewDoc, const ScValidationDataList& rList); + ~ScValidationDataList() {} + + void InsertNew( ScValidationData* pNew ) + { if (!Insert(pNew)) delete pNew; } + + ScValidationData* GetData( sal_uInt32 nKey ); + + void CompileXML(); + void UpdateReference( UpdateRefMode eUpdateRefMode, + const ScRange& rRange, SCsCOL nDx, SCsROW nDy, SCsTAB nDz ); + void UpdateMoveTab( SCTAB nOldPos, SCTAB nNewPos ); + + /** Temporarily during save, returns RefManager's decision whether ALL + * references are marked now. */ + bool MarkUsedExternalReferences() const; + + BOOL operator==( const ScValidationDataList& r ) const; // fuer Ref-Undo +}; + +#endif + |