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
|
/* -*- 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_IDOCUMENTFIELDSACCESS_HXX
#define INCLUDED_SW_INC_IDOCUMENTFIELDSACCESS_HXX
#include <sal/types.h>
#include <tools/solar.h>
class SwFldTypes;
class SwFieldType;
class SfxPoolItem;
struct SwPosition;
class SwDocUpdtFld;
class SwCalc;
class SwTxtFld;
class SwField;
class SwMsgPoolItem;
class DateTime;
class _SetGetExpFld;
struct SwHash;
class SwNode;
namespace rtl { class OUString; }
using rtl::OUString;
namespace com { namespace sun { namespace star { namespace uno { class Any; } } } }
/** Document fields related interfaces
*/
class IDocumentFieldsAccess
{
public:
virtual const SwFldTypes *GetFldTypes() const = 0;
virtual SwFieldType *InsertFldType(const SwFieldType &) = 0;
virtual SwFieldType *GetSysFldType( const sal_uInt16 eWhich ) const = 0;
virtual SwFieldType* GetFldType(sal_uInt16 nResId, const OUString& rName, bool bDbFieldMatching) const = 0;
virtual void RemoveFldType(sal_uInt16 nFld) = 0;
virtual void UpdateFlds( SfxPoolItem* pNewHt, bool bCloseDB) = 0;
virtual void InsDeletedFldType(SwFieldType &) = 0;
/**
Puts a value into a field at a certain position.
A missing field at the given position leads to a failure.
@param rPosition position of the field
@param rVal the value
@param nMId
@retval true putting of value was successful
@retval false else
*/
virtual bool PutValueToField(const SwPosition & rPos, const com::sun::star::uno::Any& rVal, sal_uInt16 nWhich) = 0;
// Call update of expression fields. All expressions are re-evaluated.
/** Updates a field.
@param rDstFmtFld field to update
@param rSrcFld field containing the new values
@param pMsgHnt
@param bUpdateTblFlds TRUE: update table fields, too.
@retval true update was successful
@retval false else
*/
virtual bool UpdateFld(SwTxtFld * rDstFmtFld, SwField & rSrcFld, SwMsgPoolItem * pMsgHnt, bool bUpdateTblFlds) = 0;
virtual void UpdateRefFlds(SfxPoolItem* pHt) = 0;
virtual void UpdateTblFlds(SfxPoolItem* pHt) = 0;
virtual void UpdateExpFlds(SwTxtFld* pFld, bool bUpdateRefFlds) = 0;
virtual void UpdateUsrFlds() = 0;
virtual void UpdatePageFlds(SfxPoolItem*) = 0;
virtual void LockExpFlds() = 0;
virtual void UnlockExpFlds() = 0;
virtual bool IsExpFldsLocked() const = 0;
virtual SwDocUpdtFld& GetUpdtFlds() const = 0;
/* @@@MAINTAINABILITY-HORROR@@@
SwNode (see parameter pChk) is (?) part of the private
data structure of SwDoc and should not be exposed
*/
virtual bool SetFieldsDirty(bool b, const SwNode* pChk, sal_uLong nLen) = 0;
virtual void SetFixFields(bool bOnlyTimeDate, const DateTime* pNewDateTime) = 0;
// In Calculator set all SetExpression fields that are valid up to the indicated position
// (Node [ + ::com::sun::star::ucb::Content]).
// A generated list of all fields may be passed along too
// (if the addreess != 0 and the pointer == 0 a new list will be returned).
virtual void FldsToCalc(SwCalc& rCalc, sal_uLong nLastNd, sal_uInt16 nLastCnt) = 0;
virtual void FldsToCalc(SwCalc& rCalc, const _SetGetExpFld& rToThisFld) = 0;
virtual void FldsToExpand(SwHash**& ppTbl, sal_uInt16& rTblSize, const _SetGetExpFld& rToThisFld) = 0;
virtual bool IsNewFldLst() const = 0;
virtual void SetNewFldLst( bool bFlag) = 0;
virtual void InsDelFldInFldLst(bool bIns, const SwTxtFld& rFld) = 0;
protected:
virtual ~IDocumentFieldsAccess() {};
};
#endif // INCLUDED_SW_INC_IDOCUMENTFIELDSACCESS_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
