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
|
/* -*- 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 <rtl/ustring.hxx>
#include <svl/itemset.hxx>
#include <rtl/ref.hxx>
#include "address.hxx"
#include "scdllapi.h"
#include <memory>
#include <string_view>
class EditTextObject;
class OutlinerParaObject;
class SdrCaptionObj;
class SdrPage;
class ScDocument;
namespace tools { class Rectangle; }
struct ScCaptionInitData;
/** Internal data for a cell annotation. */
struct ScNoteData
{
typedef std::shared_ptr< ScCaptionInitData > ScCaptionInitDataRef;
OUString maDate; /// Creation date of the note.
OUString maAuthor; /// Author of the note.
ScCaptionInitDataRef mxInitData; /// Initial data for invisible notes without SdrObject.
rtl::Reference<SdrCaptionObj> mxCaption; /// Drawing object representing the cell note.
bool mbShown; /// True = note is visible.
explicit ScNoteData( bool bShown = false );
};
/**
* Additional class containing cell annotation data.
*/
class SC_DLLPUBLIC ScPostIt
{
public:
static sal_uInt32 mnLastPostItId;
/** Creates an empty note and its caption object and places it according to
the passed cell position. */
explicit ScPostIt( ScDocument& rDoc, const ScAddress& rPos, sal_uInt32 nPostItId = 0 );
/** Copy constructor. Clones the note and its caption to a new document. */
explicit ScPostIt( ScDocument& rDoc, const ScAddress& rPos, const ScPostIt& rNote, sal_uInt32 nPostItId = 0 );
/** Creates a note from the passed note data with existing caption object.
@param bAlwaysCreateCaption Instead of a pointer to an existing
caption object, the passed note data structure may contain a
reference to an ScCaptionInitData structure containing information
about how to construct a missing caption object. If sal_True is passed,
the caption drawing object will be created immediately from that
data. If sal_False is passed and the note is not visible, it will
continue to cache that data until the caption object is requested.
*/
explicit ScPostIt(
ScDocument& rDoc, const ScAddress& rPos,
ScNoteData aNoteData, bool bAlwaysCreateCaption, sal_uInt32 nPostItId = 0 );
/** Removes the caption object from drawing layer, if this note is its owner. */
~ScPostIt();
/** Clones this note and its caption object, if specified.
@param bCloneCaption If sal_True is passed, clones the caption object and
inserts it into the drawing layer of the destination document. If
sal_False is passed, the cloned note will refer to the old caption
object (used e.g. in Undo documents to restore the pointer to the
existing caption object).
*/
std::unique_ptr<ScPostIt> Clone(
const ScAddress& rOwnPos,
ScDocument& rDestDoc, const ScAddress& rDestPos,
bool bCloneCaption ) const;
/** Returns the note id. */
sal_uInt32 GetId() const { return mnPostItId; }
/** Returns the data struct containing all note settings. */
const ScNoteData& GetNoteData() const { return maNoteData;}
/** Returns the creation date of this note. */
const OUString& GetDate() const { return maNoteData.maDate;}
/** Sets a new creation date for this note. */
void SetDate( const OUString& rDate );
/** Returns the author date of this note. */
const OUString& GetAuthor() const { return maNoteData.maAuthor;}
/** Sets a new author date for this note. */
void SetAuthor( const OUString& rAuthor );
/** Sets date and author from system settings. */
void AutoStamp();
/** Returns the pointer to the current outliner object, or null. */
const OutlinerParaObject* GetOutlinerObject() const;
/** Returns the pointer to the current edit text object, or null. */
const EditTextObject* GetEditTextObject() const;
/** Returns the caption text of this note. */
OUString GetText() const;
/** Returns true, if the caption text of this note contains line breaks. */
bool HasMultiLineText() const;
/** Changes the caption text of this note. All text formatting will be lost. */
void SetText( const ScAddress& rPos, const OUString& rText );
/** Returns an existing note caption object. returns null, if the note
contains initial caption data needed to construct a caption object.
The SdrCaptionObj* returned is still managed by the underlying
ScNoteData::ScCaptionPtr and must not be stored elsewhere. */
SdrCaptionObj* GetCaption() const { return maNoteData.mxCaption.get();}
/** Returns the caption object of this note. Creates the caption object, if
the note contains initial caption data instead of the caption.
The SdrCaptionObj* returned is still managed by the underlying
ScNoteData::ScCaptionPtr and must not be stored elsewhere. */
SdrCaptionObj* GetOrCreateCaption( const ScAddress& rPos ) const;
/** Forgets the pointer to the note caption object.
@param bPreserveData
If true then the note text is remembered in maNoteData to be able
to later reconstruct a caption from it.
*/
void ForgetCaption( bool bPreserveData = false );
/** Shows or hides the note caption object. */
void ShowCaption( const ScAddress& rPos, bool bShow );
/** Returns true, if the caption object is visible. */
bool IsCaptionShown() const { return maNoteData.mbShown;}
/** Shows or hides the caption temporarily (does not change internal visibility state). */
void ShowCaptionTemp( const ScAddress& rPos, bool bShow = true );
/** Updates caption position according to position of the passed cell. */
void UpdateCaptionPos( const ScAddress& rPos );
private:
ScPostIt( const ScPostIt& ) = delete;
ScPostIt& operator=( const ScPostIt& ) = delete;
/** Creates the caption object from initial caption data if existing. */
void CreateCaptionFromInitData( const ScAddress& rPos ) const;
/** Creates a new caption object at the passed cell position, clones passed existing caption. */
void CreateCaption( const ScAddress& rPos, const SdrCaptionObj* pCaption = nullptr );
/** Removes the caption object from the drawing layer, if this note is its owner. */
void RemoveCaption();
private:
ScDocument& mrDoc; /// Parent document containing the note.
mutable ScNoteData maNoteData; /// Note data with pointer to caption object.
sal_uInt32 mnPostItId;
};
class SC_DLLPUBLIC ScNoteUtil
{
public:
/** Creates and returns a caption object for a temporary caption. */
static rtl::Reference<SdrCaptionObj> CreateTempCaption( ScDocument& rDoc, const ScAddress& rPos,
SdrPage& rDrawPage, std::u16string_view rUserText,
const tools::Rectangle& rVisRect, bool bTailFront );
/** Creates a cell note using the passed caption drawing object.
This function is used in import filters to reuse the imported drawing
object as note caption object.
@param pCaption The drawing object for the cell note. This object MUST
be inserted into the document at the correct drawing page already.
The underlying ScPostIt::ScNoteData::ScCaptionPtr takes managing
ownership of the pointer.
@return Pointer to the new cell note object if insertion was
successful (i.e. the passed cell position was valid), null
otherwise. The Calc document is the owner of the note object. The
passed item set and outliner object are deleted automatically if
creation of the note was not successful.
*/
static ScPostIt* CreateNoteFromCaption(
ScDocument& rDoc, const ScAddress& rPos,
SdrCaptionObj* pCaption );
/** Creates a cell note based on the passed caption object data.
This function is used in import filters to use an existing imported
item set and outliner object to create a note caption object. For
performance reasons, it is possible to specify that the caption drawing
object for the cell note is not created yet but the note caches the
passed data needed to create the caption object on demand (see
parameter bAlwaysCreateCaption).
@param pItemSet Pointer to an item set on heap memory containing all
formatting attributes of the caption object. This function takes
ownership of the passed item set.
@param rOutlinerObj An outliner object containing (formatted) text
for the caption object.
@param rCaptionRect The absolute position and size of the caption
object. The rectangle may be empty, in this case the default
position and size is used.
@return Pointer to the new cell note object if insertion was
successful (i.e. the passed cell position was valid), null
otherwise. The Calc document is the owner of the note object.
*/
static ScPostIt* CreateNoteFromObjectData(
ScDocument& rDoc, const ScAddress& rPos,
SfxItemSet&& oItemSet,
const OutlinerParaObject& rOutlinerObj,
const tools::Rectangle& rCaptionRect, bool bShown );
/** Creates a cell note based on the passed string and inserts it into the
document.
@param rNoteText The text used to create the note caption object. Must
not be empty.
@param bAlwaysCreateCaption If sal_True is passed, the caption drawing
object will be created immediately. If sal_False is passed, the caption
drawing object will not be created if the note is not visible
(bShown = sal_False), but the cell note will cache the passed data.
MUST be set to sal_False outside of import filter implementations!
@return Pointer to the new cell note object if insertion was
successful (i.e. the passed cell position was valid), null
otherwise. The Calc document is the owner of the note object.
*/
static ScPostIt* CreateNoteFromString(
ScDocument& rDoc, const ScAddress& rPos,
const OUString& rNoteText, bool bShown,
bool bAlwaysCreateCaption, sal_uInt32 nPostItId = 0 );
};
namespace sc {
struct NoteEntry
{
ScAddress maPos;
const ScPostIt* mpNote;
NoteEntry( const ScAddress& rPos, const ScPostIt* pNote );
};
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
