1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
|
/* -*- 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 .
*/
#pragma once
#include "conditio.hxx"
#include "scdllapi.h"
namespace weld { class Window; }
namespace sc {
struct RefUpdateContext;
}
namespace vcl { class ILibreOfficeKitNotifier; }
class ScPatternAttr;
class ScTokenArray;
class ScTypedStrData;
struct ScValidationDataIsNumeric;
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
};
// Entry for validation (only one condition exists)
class SAL_DLLPUBLIC_RTTI ScValidationData final : public ScConditionEntry
{
private:
sal_uInt32 nKey; // index in attributes
ScValidationMode eDataMode;
bool bShowInput;
bool bShowError;
ScValidErrorStyle eErrorStyle;
sal_Int16 mnListType; // selection list type: none, unsorted, sorted.
OUString aInputTitle;
OUString aInputMessage;
OUString aErrorTitle;
OUString aErrorMessage;
bool DoMacro( const ScAddress& rPos, const OUString& rInput,
ScFormulaCell* pCell, weld::Window* pParent ) const;
bool DoScript( const ScAddress& rPos, const OUString& rInput,
ScFormulaCell* pCell, weld::Window* pParent ) const;
using ScConditionEntry::operator==;
DECL_STATIC_LINK(ScValidationData, InstallLOKNotifierHdl, void*, vcl::ILibreOfficeKitNotifier*);
public:
SC_DLLPUBLIC ScValidationData( ScValidationMode eMode, ScConditionMode eOper,
const OUString& rExpr1, const OUString& rExpr2,
ScDocument& rDocument, const ScAddress& rPos,
const OUString& rExprNmsp1 = OUString(), const OUString& rExprNmsp2 = OUString(),
formula::FormulaGrammar::Grammar eGrammar1 = formula::FormulaGrammar::GRAM_DEFAULT,
formula::FormulaGrammar::Grammar eGrammar2 = formula::FormulaGrammar::GRAM_DEFAULT );
SC_DLLPUBLIC ScValidationData( ScValidationMode eMode, ScConditionMode eOper,
const ScTokenArray* pArr1, const ScTokenArray* pArr2,
ScDocument& rDocument, const ScAddress& rPos );
SC_DLLPUBLIC ScValidationData( const ScValidationData& r );
ScValidationData( ScDocument& rDocument, const ScValidationData& r );
SC_DLLPUBLIC virtual ~ScValidationData() override;
ScValidationData* Clone() const // real copy
{ return new ScValidationData( *GetDocument(), *this ); }
ScValidationData* Clone(ScDocument* pNew) const override
{ return new ScValidationData( *pNew, *this ); }
SC_DLLPUBLIC void ResetInput();
SC_DLLPUBLIC void ResetError();
SC_DLLPUBLIC void SetInput( const OUString& rTitle, const OUString& rMsg );
SC_DLLPUBLIC void SetError( const OUString& rTitle, const OUString& rMsg,
ScValidErrorStyle eStyle );
bool GetInput( OUString& rTitle, OUString& rMsg ) const
{ rTitle = aInputTitle; rMsg = aInputMessage; return bShowInput; }
SC_DLLPUBLIC bool GetErrMsg( OUString& rTitle, OUString& rMsg, ScValidErrorStyle& rStyle ) const;
ScValidationMode GetDataMode() const { return eDataMode; }
sal_Int16 GetListType() const { return mnListType; }
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 entries.
@return true = rStrings has been filled with at least one entry. */
SC_DLLPUBLIC bool FillSelectionList(std::vector<ScTypedStrData>& rStrings, const ScAddress& rPos) const;
// with string: during input, with cell: for detective / RC_FORCED
bool IsDataValid(
const OUString& rTest, const ScPatternAttr& rPattern, const ScAddress& rPos ) const;
// Custom validations (SC_VALID_CUSTOM) should be validated using this specific method.
// Take care that internally this method commits to the to be validated cell the new input,
// in order to be able to interpret the validating boolean formula on the new input.
// After the formula has been evaluated the original cell content is restored.
// At present is only used in ScInputHandler::EnterHandler: handling this case in the
// regular IsDataValid method would have been unsafe since it can be invoked
// by ScFormulaCell::InterpretTail.
struct CustomValidationPrivateAccess
{
// so IsDataValidCustom can be invoked only by ScInputHandler methods
friend class ScInputHandler;
private:
CustomValidationPrivateAccess() {}
};
bool IsDataValidCustom(
const OUString& rTest, const ScPatternAttr& rPattern,
const ScAddress& rPos, const CustomValidationPrivateAccess& ) const;
SC_DLLPUBLIC bool IsDataValid( ScRefCellValue& rCell, const ScAddress& rPos ) const;
/** Test, if formula is valid. */
bool isFormulaResultsValidatable(const OUString& rTest, const ScAddress& rPos, SvNumberFormatter* pFormatter,
OUString& rStrResult, double& nVal, sal_uInt32& nFormat, bool& bIsVal) const;
// TRUE -> break
bool DoError(weld::Window* pParent, const OUString& 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; } // only if not inserted!
SC_DLLPUBLIC bool EqualEntries( const ScValidationData& r ) const; // for undo
// sort (using std::set) by index
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 entries.
@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(
std::vector<ScTypedStrData>* pStrings, ScRefCellValue& rCell, const ScAddress& rPos,
const ScTokenArray& rTokArr, int& rMatch) const;
/** Tests, if pCell is equal to what the passed token array represents. */
bool IsEqualToTokenArray( ScRefCellValue& rCell, 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( ScRefCellValue& rCell, const ScAddress& rPos ) const;
/** Tests, if string or numeric data has valid text length.
@param pDataNumeric
nullptr if string data to be tested, else for numeric data a
properly initialized ScValidationDataIsNumeric struct, see
implementation.
*/
bool IsDataValidTextLen( std::u16string_view rTest, const ScAddress& rPos,
ScValidationDataIsNumeric* pDataNumeric ) const;
};
// list of conditions:
struct CompareScValidationDataPtr
{
bool operator()( std::unique_ptr<ScValidationData> const& lhs, std::unique_ptr<ScValidationData> const& rhs ) const { return (*lhs)<(*rhs); }
};
class ScValidationDataList
{
private:
typedef std::set<std::unique_ptr<ScValidationData>, CompareScValidationDataPtr> ScValidationDataListDataType;
ScValidationDataListDataType maData;
public:
ScValidationDataList() {}
ScValidationDataList(const ScValidationDataList& rList);
ScValidationDataList(ScDocument& rNewDoc, const ScValidationDataList& rList);
typedef ScValidationDataListDataType::iterator iterator;
typedef ScValidationDataListDataType::const_iterator const_iterator;
iterator begin();
const_iterator begin() const;
iterator end();
const_iterator end() const;
void InsertNew( std::unique_ptr<ScValidationData> pNew )
{ maData.insert(std::move(pNew)); }
ScValidationData* GetData( sal_uInt32 nKey );
void CompileXML();
void UpdateReference( sc::RefUpdateContext& rCxt );
void UpdateInsertTab( sc::RefUpdateInsertTabContext& rCxt );
void UpdateDeleteTab( sc::RefUpdateDeleteTabContext& rCxt );
void UpdateMoveTab( sc::RefUpdateMoveTabContext& rCxt );
};
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
