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
|
/* -*- 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_SC_INC_EDITUTIL_HXX
#define INCLUDED_SC_INC_EDITUTIL_HXX
#include <memory>
#include "scdllapi.h"
#include "types.hxx"
#include <editeng/editeng.hxx>
#include <svx/pageitem.hxx>
#include <tools/datetime.hxx>
#include <tools/gen.hxx>
#include <tools/fract.hxx>
#include <vcl/outdev.hxx>
class ScDocument;
class ScPatternAttr;
class ScEditEngineDefaulter;
class ScEditUtil
{
ScDocument* pDoc;
SCCOL const nCol;
SCROW const nRow;
SCTAB const nTab;
Point const aScrPos;
VclPtr<OutputDevice> pDev; // MapMode has to be set
double const nPPTX;
double const nPPTY;
Fraction const aZoomX;
Fraction aZoomY;
public:
static OUString ModifyDelimiters( const OUString& rOld );
/// Retrieves string with paragraphs delimited by spaces
static OUString GetSpaceDelimitedString( const EditEngine& rEngine );
/// Retrieves string with paragraphs delimited by new lines ('\n').
static OUString GetMultilineString( const EditEngine& rEngine );
static OUString GetMultilineString( const EditTextObject& rEdit );
/** Retrieves string with paragraphs delimited by new lines ('\n').
@param pDoc
If not NULL, use pDoc->GetEditEngine() to retrieve field content.
If NULL, a static mutex-guarded ScFieldEditEngine is used that
is not capable of resolving document specific fields; avoid.
*/
SC_DLLPUBLIC static OUString GetString( const EditTextObject& rEditText, const ScDocument* pDoc );
static std::unique_ptr<EditTextObject> CreateURLObjectFromURL(
ScDocument& rDoc, const OUString& rURL, const OUString& rText );
static void RemoveCharAttribs( EditTextObject& rEditText, const ScPatternAttr& rAttr );
static std::unique_ptr<EditTextObject> Clone( const EditTextObject& rSrc, ScDocument& rDestDoc );
static OUString GetCellFieldValue(
const SvxFieldData& rFieldData, const ScDocument* pDoc, o3tl::optional<Color>* ppTextColor );
public:
ScEditUtil( ScDocument* pDocument, SCCOL nX, SCROW nY, SCTAB nZ,
const Point& rScrPosPixel,
OutputDevice* pDevice, double nScaleX, double nScaleY,
const Fraction& rX, const Fraction& rY );
tools::Rectangle GetEditArea( const ScPatternAttr* pPattern, bool bForceToTop );
};
class ScEditAttrTester
{
ScEditEngineDefaulter* pEngine;
std::unique_ptr<SfxItemSet> pEditAttrs;
bool bNeedsObject;
bool bNeedsCellAttr;
public:
ScEditAttrTester( ScEditEngineDefaulter* pEng );
~ScEditAttrTester();
bool NeedsObject() const { return bNeedsObject; }
bool NeedsCellAttr() const { return bNeedsCellAttr; }
const SfxItemSet& GetAttribs() const { return *pEditAttrs; }
};
// construct pool before constructing EditEngine, destroy pool after EditEngine
class ScEnginePoolHelper
{
protected:
SfxItemPool* const pEnginePool;
SfxItemSet* pDefaults;
bool const bDeleteEnginePool;
bool bDeleteDefaults;
ScEnginePoolHelper( SfxItemPool* pEnginePool, bool bDeleteEnginePool );
ScEnginePoolHelper( const ScEnginePoolHelper& rOrg );
virtual ~ScEnginePoolHelper();
};
class SC_DLLPUBLIC ScEditEngineDefaulter : public ScEnginePoolHelper, public EditEngine
{
private:
using EditEngine::SetText;
public:
/// bDeleteEnginePool: Engine becomes the owner of the pool
/// and deletes it on destruction
ScEditEngineDefaulter( SfxItemPool* pEnginePool,
bool bDeleteEnginePool = false );
/// If rOrg.bDeleteEnginePool: pool gets cloned and will be
/// deleted on destruction. Defaults are not set.
ScEditEngineDefaulter( const ScEditEngineDefaulter& rOrg );
virtual ~ScEditEngineDefaulter() override;
/// Creates a copy of SfxItemSet if bRememberCopy set
void SetDefaults( const SfxItemSet& rDefaults, bool bRememberCopy = true );
/// Becomes the owner of the SfxItemSet
void SetDefaults( std::unique_ptr<SfxItemSet> pDefaults );
/// Set the item in the default ItemSet which is created
/// if it doesn't exist yet.
/// The default ItemSet is then applied to each paragraph.
void SetDefaultItem( const SfxPoolItem& rItem );
/// Returns the stored defaults, used to find non-default character attributes
const SfxItemSet& GetDefaults();
/// SetText and apply defaults already set
void SetTextCurrentDefaults( const EditTextObject& rTextObject );
/// Current defaults are not applied, new defaults are applied
void SetTextNewDefaults( const EditTextObject& rTextObject,
const SfxItemSet& rDefaults, bool bRememberCopy = true );
/// Current defaults are not applied, new defaults are applied
void SetTextNewDefaults( const EditTextObject& rTextObject,
std::unique_ptr<SfxItemSet> pDefaults );
/// SetText and apply defaults already set
void SetTextCurrentDefaults( const OUString& rText );
/// Current defaults are not applied, new defaults are applied
void SetTextNewDefaults( const OUString& rText,
const SfxItemSet& rDefaults );
/// Current defaults are not applied, new defaults are applied
void SetTextNewDefaults( const OUString& rText,
std::unique_ptr<SfxItemSet> pDefaults );
/// Paragraph attributes that are not defaults are copied to
/// character attributes and all paragraph attributes reset
void RemoveParaAttribs();
/// Re-apply existing defaults if set, same as in SetText,
/// but without EnableUndo/SetUpdateMode.
void RepeatDefaults();
};
// for field commands (or just fields?) in a table
class SC_DLLPUBLIC ScFieldEditEngine : public ScEditEngineDefaulter
{
private:
ScDocument* const mpDoc;
bool bExecuteURL;
public:
ScFieldEditEngine(
ScDocument* pDoc, SfxItemPool* pEnginePool, SfxItemPool* pTextObjectPool = nullptr,
bool bDeleteEnginePool = false);
void SetExecuteURL(bool bSet) { bExecuteURL = bSet; }
virtual void FieldClicked( const SvxFieldItem& rField ) override;
virtual OUString CalcFieldValue( const SvxFieldItem& rField, sal_Int32 nPara, sal_Int32 nPos, o3tl::optional<Color>& rTxtColor, o3tl::optional<Color>& rFldColor ) override;
};
// 1/100 mm
class SC_DLLPUBLIC ScTabEditEngine final : public ScFieldEditEngine
{
private:
void Init(const ScPatternAttr& rPattern);
public:
ScTabEditEngine( ScDocument* pDoc ); // Default
ScTabEditEngine(const ScPatternAttr& rPattern,
SfxItemPool *pEngineItemPool, ScDocument *pDoc,
SfxItemPool* pTextObjectPool = nullptr );
};
struct ScHeaderFieldData
{
OUString aTitle; // title or file name (if no title)
OUString aLongDocName; // path and file name
OUString aShortDocName; // pure file name
OUString aTabName;
DateTime aDateTime;
long nPageNo;
long nTotalPages;
SvxNumType eNumType;
ScHeaderFieldData();
};
// for headers/footers with fields
class SC_DLLPUBLIC ScHeaderEditEngine final : public ScEditEngineDefaulter
{
private:
ScHeaderFieldData aData;
public:
ScHeaderEditEngine( SfxItemPool* pEnginePool );
virtual OUString CalcFieldValue( const SvxFieldItem& rField, sal_Int32 nPara, sal_Int32 nPos, o3tl::optional<Color>& rTxtColor, o3tl::optional<Color>& rFldColor ) override;
void SetNumType(SvxNumType eNew) { aData.eNumType = eNew; }
void SetData(const ScHeaderFieldData& rNew) { aData = rNew; }
};
// for Note text objects.
class ScNoteEditEngine final : public ScEditEngineDefaulter
{
public:
ScNoteEditEngine( SfxItemPool* pEnginePool, SfxItemPool* pTextObjectPool );
};
// SvxFieldData derivations were moved to Svx (comment can be deleted?)
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
