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
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
|
/* -*- 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 INCLUDED_SW_INC_FLDBAS_HXX
#define INCLUDED_SW_INC_FLDBAS_HXX
#include <i18nlangtag/lang.h>
#include "swdllapi.h"
#include "calbck.hxx"
#include <cppuhelper/weakref.hxx>
#include <editeng/svxenum.hxx>
#include <tools/solar.h>
#include <vector>
#include <climits>
class SwDoc;
class SwField;
class SwFormatField;
class SwDDETable;
class SwRootFrame;
class SvNumberFormatter;
class IDocumentRedlineAccess;
class SwGetRefField;
namespace com::sun::star::beans { class XPropertySet; }
namespace com::sun::star::uno { class Any; }
typedef struct _xmlTextWriter* xmlTextWriterPtr;
enum class SwFieldIds : sal_uInt16 {
/// For old documents the Field-Which IDs must be preserved !!!
Database,
User,
Filename,
DatabaseName,
Date,
Time,
PageNumber,
Author,
Chapter,
DocStat,
GetExp, // 10
SetExp,
GetRef,
HiddenText,
Postit,
FixDate,
FixTime,
Reg,
VarReg,
SetRef,
Input, // 20
Macro,
Dde,
Table,
HiddenPara,
DocInfo,
TemplateName,
DbNextSet,
DbNumSet,
DbSetNumber,
ExtUser, // 30
RefPageSet,
RefPageGet,
Internet,
JumpEdit,
Script,
DateTime,
TableOfAuthorities,
CombinedChars,
Dropdown,
ParagraphSignature, // 40
LAST = ParagraphSignature,
Unknown = USHRT_MAX, // used as default value in some method calls
};
/// List of FieldTypes at UI.
enum class SwFieldTypesEnum : sal_uInt16 {
Begin,
Date = Begin, // 0
Time,
Filename,
DatabaseName,
Chapter,
PageNumber,
DocumentStatistics,
Author,
Set,
Get,
Formel, // 10
HiddenText,
SetRef,
GetRef,
DDE,
Macro,
Input,
HiddenParagraph,
DocumentInfo,
Database,
User, // 20
Postit,
TemplateName,
Sequence,
DatabaseNextSet,
DatabaseNumberSet,
DatabaseSetNumber,
ConditionalText,
NextPage,
PreviousPage,
ExtendedUser, // 30
FixedDate,
FixedTime,
SetInput,
UserInput,
SetRefPage,
GetRefPage,
Internet,
JumpEdit,
Script,
Authority, // 40
CombinedChars,
Dropdown,
Custom, // Unused - necessary for alignment with aSwFields in fldmgr.cxx
ParagraphSignature,
LAST,
Unknown = USHRT_MAX // used by SwFieldMgr::GetCurTypeId
};
enum SwAttrFieldType {
ATTR_NONE,
ATTR_DATEFLD,
ATTR_TIMEFLD,
ATTR_PAGENUMBERFLD,
ATTR_PAGECOUNTFLD,
ATTR_BOOKMARKFLD,
ATTR_SETREFATTRFLD
};
enum SwFileNameFormat {
FF_BEGIN,
FF_NAME = FF_BEGIN,
FF_PATHNAME,
FF_PATH,
FF_NAME_NOEXT,
FF_UI_NAME,
FF_UI_RANGE,
FF_END,
FF_FIXED = 0x8000
};
enum SwVarFormat {
VVF_CMD = 0x0010, ///< Show command.
VVF_INVISIBLE = 0x0040, ///< Invisible.
VVF_XXP = 0x0400, ///< 1234%
VVF_XX_XXP = 0x0800, ///< 1.234,56%
VVF_CLEAR = 0x000f,
// From here new formats:
VVF_SYS = 0x2000, ///< Format for numbers from system.
VVF_X = 0x2100, ///< 1234
VVF_X_X = 0x2200, ///< 1234.5
VVF_X_XX = 0x2300, ///< 1245.56
VVF_XX_X = 0x2400, ///< 1.234.5
VVF_XX_XX = 0x2500, ///< 1.234.56
VVF_XX_XXX = 0x2600, ///< 1.234.567
VVF_SYS_CUR = 0x2700, ///< Format for currency from system.
VVF_CUR_X = 0x2800, ///< EUR 1234
VVF_CUR_XX_XX = 0x2900, ///< EUR 1234.56 EUR 1234.00
VVF_CUR_XX_X0 = 0x2a00, ///< EUR 1234.56 EUR 1234.--
VVF_X_CUR = 0x2b00, ///< 1234 EUR
VVF_XX_XX_CUR = 0x2c00, ///< 1234.56 EUR 1234.00 EUR
VVF_XX_X0_CUR = 0x2d00, ///< 1234.56 EUR 1234.-- EUR
/// Compatibility:
VF_CMD = VVF_CMD,
VF_INVISIBLE = VVF_INVISIBLE,
VF_XXP = VVF_XXP,
VF_XX_XXP = VVF_XX_XXP,
VF_VISIBLE = VVF_SYS,
VF_XX = VVF_X,
VF_XX_XX = VVF_XX_XX,
VF_XX_XX_CUR = VVF_SYS_CUR,
VF_CLEAR = VVF_CLEAR
};
typedef sal_uInt16 SwGetSetExpType;
namespace nsSwGetSetExpType
{
const SwGetSetExpType GSE_STRING = 0x0001; ///< String
const SwGetSetExpType GSE_EXPR = 0x0002; ///< Expression
const SwGetSetExpType GSE_SEQ = 0x0008; ///< Sequence
const SwGetSetExpType GSE_FORMULA = 0x0010; ///< Formula
}
typedef sal_uInt16 SwExtendedSubType;
namespace nsSwExtendedSubType
{
const SwExtendedSubType SUB_CMD = 0x0100; ///< Show command.
const SwExtendedSubType SUB_INVISIBLE = 0x0200; ///< Invisible.
const SwExtendedSubType SUB_OWN_FMT = 0x0400; ///< SwDBField: Don't accept formatting from database.
}
enum SwInputFieldSubType {
INP_TXT = 0x01,
INP_USR = 0x02,
INP_VAR = 0x03
};
enum SwUserType {
UF_STRING = 0x01,
UF_EXPR = 0x02
};
enum SwDateTimeSubType {
FIXEDFLD = 1,
DATEFLD = 2,
TIMEFLD = 4
};
/// General tools.
OUString FormatNumber(sal_uInt32 nNum, SvxNumType nFormat, LanguageType nLang = LANGUAGE_NONE);
/** Instances of SwFields and those derived from it occur 0 to n times.
For each class there is one instance of the associated type class.
Base class of all field types is SwFieldType. */
class SW_DLLPUBLIC SwFieldType : public sw::BroadcastingModify
{
css::uno::WeakReference<css::beans::XPropertySet> m_wXFieldMaster;
SwFieldIds m_nWhich;
friend void FinitUI(); ///< In order to delete pointer!
static std::vector<OUString>* s_pFieldNames;
static void GetFieldName_(); ///< Sets up FieldNames; fldmgr.cxx!
protected:
/// Single argument ctors shall be explicit.
explicit SwFieldType( SwFieldIds nWhichId );
public:
SAL_DLLPRIVATE css::uno::WeakReference<css::beans::XPropertySet> const& GetXObject() const {
return m_wXFieldMaster;
}
SAL_DLLPRIVATE void SetXObject(css::uno::Reference<css::beans::XPropertySet> const& xFieldMaster) {
m_wXFieldMaster = xFieldMaster;
}
static const OUString & GetTypeStr( SwFieldTypesEnum nTypeId );
/// Only in derived classes.
virtual OUString GetName() const;
virtual std::unique_ptr<SwFieldType> Copy() const = 0;
virtual void QueryValue( css::uno::Any& rVal, sal_uInt16 nWhich ) const;
virtual void PutValue( const css::uno::Any& rVal, sal_uInt16 nWhich );
SwFieldIds Which() const { return m_nWhich; }
void UpdateFields() const;
void PrintHiddenPara();
virtual void dumpAsXml(xmlTextWriterPtr pWriter) const;
SwFormatField* FindFormatForField(const SwField*) const;
SwFormatField* FindFormatForPostItId(sal_uInt32 nPostItId) const;
void CollectPostIts(std::vector<SwFormatField*>& rvFormatFields, IDocumentRedlineAccess const& rIDRA, bool HideRedlines);
bool HasHiddenInformationNotes() const;
void GatherNodeIndex(std::vector<sal_uLong>& rvNodeIndex);
void GatherRefFields(std::vector<SwGetRefField*>& rvRFields, const sal_uInt16 nTyp);
void GatherFields(std::vector<SwFormatField*>& rvFormatFields, bool bCollectOnlyInDocNodes=true) const;
void GatherDdeTables(std::vector<SwDDETable*>& rvTables) const;
};
/** Base class of all fields.
Type of field is queried via Which.
Expanded content of field is queried via ExpandField(). */
class SW_DLLPUBLIC SwField
{
private:
mutable OUString m_Cache; ///< Cached expansion (for clipboard).
SwFieldType* m_pType;
sal_uInt32 m_nFormat; /// this can be either SvxNumType or SwChapterFormat depending on the subtype
LanguageType m_nLang; ///< Always change via SetLanguage!
bool m_bUseFieldValueCache; /// control the usage of the cached field value
bool m_bIsAutomaticLanguage;
virtual OUString ExpandImpl(SwRootFrame const* pLayout) const = 0;
virtual std::unique_ptr<SwField> Copy() const = 0;
protected:
void SetFormat(sal_uInt32 const nSet) {
m_nFormat = nSet;
}
SwField( SwFieldType* pTyp,
sal_uInt32 nFormat = 0,
LanguageType nLang = LANGUAGE_SYSTEM,
bool m_bUseFieldValueCache = true );
public:
virtual ~SwField();
SwField(SwField const &) = default;
SwField(SwField &&) = default;
SwField & operator =(SwField const &) = default;
SwField & operator =(SwField &&) = default;
inline SwFieldType* GetTyp() const;
/// Set new type (used for copying among documents).
virtual SwFieldType* ChgTyp( SwFieldType* );
/** expand the field.
@param bCached return cached field value.
@remark most callers should use the cached field value.
this is because various fields need special handing
(ChangeExpansion()) to return correct values, and only
SwTextFormatter::NewFieldPortion() sets things up properly.
@param pLayout the layout to use for expansion; there are a few
fields that expand differently via layout mode.
@return the generated text (suitable for display)
*/
OUString ExpandField(bool bCached, SwRootFrame const* pLayout) const;
/// @return name or content.
virtual OUString GetFieldName() const;
std::unique_ptr<SwField> CopyField() const;
/// ResId
SwFieldIds Which() const
#ifdef DBG_UTIL
; // implemented in fldbas.cxx
#else
{
return m_pType->Which();
}
#endif
// TYP_ID
SwFieldTypesEnum GetTypeId() const;
virtual sal_uInt16 GetSubType() const;
virtual void SetSubType(sal_uInt16);
/// Language at field position.
inline LanguageType GetLanguage() const;
virtual void SetLanguage(LanguageType nLng);
/// Query parameters for dialog and for BASIC.
inline sal_uInt32 GetFormat() const;
virtual OUString GetPar1() const;
virtual OUString GetPar2() const;
virtual OUString GetFormula() const;
void ChangeFormat(sal_uInt32 n);
virtual void SetPar1(const OUString& rStr);
virtual void SetPar2(const OUString& rStr);
virtual bool QueryValue( css::uno::Any& rVal, sal_uInt16 nWhichId ) const;
virtual bool PutValue( const css::uno::Any& rVal, sal_uInt16 nWhichId );
/// Does the field possess an action on its ClickHandler? (e.g. INetFields, ...).
bool HasClickHdl() const;
bool IsFixed() const;
bool IsAutomaticLanguage() const {
return m_bIsAutomaticLanguage;
}
void SetAutomaticLanguage(bool const bSet) {
m_bIsAutomaticLanguage = bSet;
}
virtual OUString GetDescription() const;
/// Is this field clickable?
bool IsClickable() const;
virtual void dumpAsXml(xmlTextWriterPtr pWriter) const;
};
inline SwFieldType* SwField::GetTyp() const
{
return m_pType;
}
inline sal_uInt32 SwField::GetFormat() const
{
return m_nFormat;
}
inline LanguageType SwField::GetLanguage() const
{
return m_nLang;
}
/// Fields containing values that have to be formatted via number formatter.
class SwValueFieldType : public SwFieldType
{
private:
SwDoc* m_pDoc;
bool m_bUseFormat; ///< Use number formatter.
protected:
SwValueFieldType( SwDoc* pDocPtr, SwFieldIds nWhichId );
SwValueFieldType( const SwValueFieldType& rTyp );
public:
SwDoc* GetDoc() const {
return m_pDoc;
}
void SetDoc(SwDoc* pNewDoc) {
m_pDoc = pNewDoc;
}
bool UseFormat() const {
return m_bUseFormat;
}
void EnableFormat(bool bFormat = true) {
m_bUseFormat = bFormat;
}
OUString ExpandValue(const double& rVal, sal_uInt32 nFormat, LanguageType nLng) const;
OUString DoubleToString(const double &rVal, LanguageType eLng) const;
OUString DoubleToString(const double &rVal, sal_uInt32 nFormat) const;
};
class SW_DLLPUBLIC SwValueField : public SwField
{
private:
double m_fValue;
protected:
SwValueField( SwValueFieldType* pFieldType, sal_uInt32 nFormat, LanguageType nLang = LANGUAGE_SYSTEM, const double fVal = 0.0 );
SwValueField( const SwValueField& rField );
public:
virtual ~SwValueField() override;
virtual SwFieldType* ChgTyp( SwFieldType* ) override;
virtual void SetLanguage(LanguageType nLng) override;
SwDoc* GetDoc() const {
return static_cast<const SwValueFieldType*>(GetTyp())->GetDoc();
}
virtual double GetValue() const;
virtual void SetValue( const double& rVal );
OUString ExpandValue(const double& rVal, sal_uInt32 nFormat, LanguageType nLng) const {
return static_cast<SwValueFieldType*>(GetTyp())->ExpandValue(rVal, nFormat, nLng);
}
static sal_uInt32 GetSystemFormat(SvNumberFormatter* pFormatter, sal_uInt32 nFormat);
void dumpAsXml(xmlTextWriterPtr pWriter) const override;
};
class SW_DLLPUBLIC SwFormulaField : public SwValueField
{
private:
OUString m_sFormula;
protected:
SwFormulaField( SwValueFieldType* pFieldType, sal_uInt32 nFormat, const double fVal );
SwFormulaField( const SwFormulaField& rField );
public:
virtual OUString GetFormula() const override;
void SetFormula(const OUString& rStr);
void SetExpandedFormula(const OUString& rStr);
OUString GetExpandedFormula() const;
};
#endif // INCLUDED_SW_INC_FLDBAS_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|