Line data Source code
1 : /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 : /*
3 : * This file is part of the LibreOffice project.
4 : *
5 : * This Source Code Form is subject to the terms of the Mozilla Public
6 : * License, v. 2.0. If a copy of the MPL was not distributed with this
7 : * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 : *
9 : * This file incorporates work covered by the following license notice:
10 : *
11 : * Licensed to the Apache Software Foundation (ASF) under one or more
12 : * contributor license agreements. See the NOTICE file distributed
13 : * with this work for additional information regarding copyright
14 : * ownership. The ASF licenses this file to you under the Apache
15 : * License, Version 2.0 (the "License"); you may not use this file
16 : * except in compliance with the License. You may obtain a copy of
17 : * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 : */
19 :
20 : #ifndef SC_VALIDAT_HXX
21 : #define SC_VALIDAT_HXX
22 :
23 : #include "conditio.hxx"
24 : #include <com/sun/star/sheet/TableValidationVisibility.hpp>
25 : #include "scdllapi.h"
26 :
27 : namespace ValidListType = ::com::sun::star::sheet::TableValidationVisibility;
28 :
29 : class ScPatternAttr;
30 : class ScTokenArray;
31 : class ScTypedStrData;
32 :
33 : enum ScValidationMode
34 : {
35 : SC_VALID_ANY,
36 : SC_VALID_WHOLE,
37 : SC_VALID_DECIMAL,
38 : SC_VALID_DATE,
39 : SC_VALID_TIME,
40 : SC_VALID_TEXTLEN,
41 : SC_VALID_LIST,
42 : SC_VALID_CUSTOM
43 : };
44 :
45 : enum ScValidErrorStyle
46 : {
47 : SC_VALERR_STOP,
48 : SC_VALERR_WARNING,
49 : SC_VALERR_INFO,
50 : SC_VALERR_MACRO
51 : };
52 :
53 : //
54 : // Entry for validation (only one condition exists)
55 : //
56 :
57 : class SC_DLLPUBLIC ScValidationData : public ScConditionEntry
58 : {
59 : sal_uInt32 nKey; // index in attributes
60 :
61 : ScValidationMode eDataMode;
62 : sal_Bool bShowInput;
63 : sal_Bool bShowError;
64 : ScValidErrorStyle eErrorStyle;
65 : sal_Int16 mnListType; // selection list type: none, unsorted, sorted.
66 : String aInputTitle;
67 : String aInputMessage;
68 : String aErrorTitle;
69 : String aErrorMessage;
70 :
71 : sal_Bool bIsUsed; // temporary during saving
72 :
73 : sal_Bool DoMacro( const ScAddress& rPos, const String& rInput,
74 : ScFormulaCell* pCell, Window* pParent ) const;
75 :
76 : sal_Bool DoScript( const ScAddress& rPos, const String& rInput,
77 : ScFormulaCell* pCell, Window* pParent ) const;
78 :
79 : using ScConditionEntry::operator==;
80 :
81 : public:
82 : ScValidationData( ScValidationMode eMode, ScConditionMode eOper,
83 : const String& rExpr1, const String& rExpr2,
84 : ScDocument* pDocument, const ScAddress& rPos,
85 15 : const String& rExprNmsp1 = EMPTY_STRING, const String& rExprNmsp2 = EMPTY_STRING,
86 : formula::FormulaGrammar::Grammar eGrammar1 = formula::FormulaGrammar::GRAM_DEFAULT,
87 : formula::FormulaGrammar::Grammar eGrammar2 = formula::FormulaGrammar::GRAM_DEFAULT );
88 : ScValidationData( ScValidationMode eMode, ScConditionMode eOper,
89 : const ScTokenArray* pArr1, const ScTokenArray* pArr2,
90 : ScDocument* pDocument, const ScAddress& rPos );
91 : ScValidationData( const ScValidationData& r );
92 : ScValidationData( ScDocument* pDocument, const ScValidationData& r );
93 : virtual ~ScValidationData();
94 :
95 0 : ScValidationData* Clone() const // real copy
96 0 : { return new ScValidationData( GetDocument(), *this ); }
97 3 : ScValidationData* Clone(ScDocument* pNew) const
98 3 : { return new ScValidationData( pNew, *this ); }
99 :
100 : void ResetInput();
101 : void ResetError();
102 : void SetInput( const String& rTitle, const String& rMsg );
103 : void SetError( const String& rTitle, const String& rMsg,
104 : ScValidErrorStyle eStyle );
105 :
106 0 : sal_Bool GetInput( String& rTitle, String& rMsg ) const
107 0 : { rTitle = aInputTitle; rMsg = aInputMessage; return bShowInput; }
108 : sal_Bool GetErrMsg( String& rTitle, String& rMsg, ScValidErrorStyle& rStyle ) const;
109 :
110 0 : sal_Bool HasErrMsg() const { return bShowError; }
111 :
112 0 : ScValidationMode GetDataMode() const { return eDataMode; }
113 :
114 0 : inline sal_Int16 GetListType() const { return mnListType; }
115 17 : inline void SetListType( sal_Int16 nListType ) { mnListType = nListType; }
116 :
117 : /** Returns true, if the validation cell will show a selection list.
118 : @descr Use this instead of GetListType() which returns the raw property
119 : regardless of the validation type. */
120 : bool HasSelectionList() const;
121 : /** Tries to fill the passed collection with list validation entries.
122 : @descr Fills the list only, if this is a list validation and IsShowList() is enabled.
123 : @param rStrings (out-param) The string list to fill with list validation entires.
124 : @return true = rStrings has been filled with at least one entry. */
125 : bool FillSelectionList(std::vector<ScTypedStrData>& rStrings, const ScAddress& rPos) const;
126 :
127 : // with string: during input, with cell: for detective / RC_FORCED
128 : sal_Bool IsDataValid( const String& rTest, const ScPatternAttr& rPattern,
129 : const ScAddress& rPos ) const;
130 : sal_Bool IsDataValid( ScBaseCell* pCell, const ScAddress& rPos ) const;
131 :
132 : // TRUE -> break
133 : sal_Bool DoError( Window* pParent, const String& rInput, const ScAddress& rPos ) const;
134 : void DoCalcError( ScFormulaCell* pCell ) const;
135 :
136 : sal_Bool IsEmpty() const;
137 143 : sal_uInt32 GetKey() const { return nKey; }
138 3 : void SetKey(sal_uInt32 nNew) { nKey = nNew; } // only if not inserted!
139 :
140 : void SetUsed(sal_Bool bSet) { bIsUsed = bSet; }
141 : sal_Bool IsUsed() const { return bIsUsed; }
142 :
143 : sal_Bool EqualEntries( const ScValidationData& r ) const; // for undo
144 :
145 : // sort (using std::set) by index
146 : // operator== only for sorting
147 : bool operator ==( const ScValidationData& r ) const { return nKey == r.nKey; }
148 3 : bool operator < ( const ScValidationData& r ) const { return nKey < r.nKey; }
149 :
150 : private:
151 : /** Tries to fill the passed collection with list validation entries.
152 : @descr Fills the list only if it is non-NULL,
153 : @param pStrings (out-param) Optionally NULL, string list to fill with list validation entires.
154 : @param pCell can be NULL if it is not necessary to which element in the list is selected.
155 : @param rPos the base address for relative references.
156 : @param rTokArr Formula token array.
157 : @param rMatch (out-param) the index of the first item that matched, -1 if nothing matched.
158 : @return true = Cell range found, rRange is valid, or an error entry stuffed into the list if pCell==NULL. */
159 : bool GetSelectionFromFormula(
160 : std::vector<ScTypedStrData>* pStrings, ScBaseCell* pCell, const ScAddress& rPos,
161 : const ScTokenArray& rTokArr, int& rMatch) const;
162 :
163 : /** Tests, if pCell is equal to what the passed token array represents. */
164 : bool IsEqualToTokenArray( ScBaseCell* pCell, const ScAddress& rPos, const ScTokenArray& rTokArr ) const;
165 :
166 : /** Tests, if contents of pCell occur in cell range referenced by own formula, or in a string list. */
167 : bool IsListValid( ScBaseCell* pCell, const ScAddress& rPos ) const;
168 : };
169 :
170 : //
171 : // list of contitions:
172 : //
173 :
174 : struct CompareScValidationDataPtr
175 : {
176 3 : bool operator()( ScValidationData* const& lhs, ScValidationData* const& rhs ) const { return (*lhs)<(*rhs); }
177 : };
178 :
179 : class ScValidationDataList : public std::set<ScValidationData*, CompareScValidationDataPtr>
180 : {
181 : public:
182 2 : ScValidationDataList() {}
183 : ScValidationDataList(const ScValidationDataList& rList);
184 : ScValidationDataList(ScDocument* pNewDoc, const ScValidationDataList& rList);
185 2 : ~ScValidationDataList() {}
186 :
187 3 : void InsertNew( ScValidationData* pNew )
188 3 : { if (!insert(pNew).second) delete pNew; }
189 :
190 : ScValidationData* GetData( sal_uInt32 nKey );
191 :
192 : void CompileXML();
193 : void UpdateReference( UpdateRefMode eUpdateRefMode,
194 : const ScRange& rRange, SCsCOL nDx, SCsROW nDy, SCsTAB nDz );
195 : void UpdateMoveTab( SCTAB nOldPos, SCTAB nNewPos );
196 :
197 : sal_Bool operator==( const ScValidationDataList& r ) const; // for ref-undo
198 : };
199 :
200 : #endif
201 :
202 : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
