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
|
/* -*- 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_FMTMETA_HXX
#define INCLUDED_SW_INC_FMTMETA_HXX
#include "calbck.hxx"
#include <unotools/weakref.hxx>
#include <svl/poolitem.hxx>
#include <sfx2/Metadatable.hxx>
#include <memory>
#include <vector>
namespace com::sun::star {
namespace document {
class XDocumentProperties;
}
namespace text {
class XTextField;
}
}
/**
* The classes that make up a meta entity are:
* <dl>
* <dt>SwTextMeta</dt><dd>the text hint</dd>
* <dt>SwFormatMeta</dt><dd>the pool item</dd>
* <dt>sw::Meta</dt><dd>the metadatable entity itself</dd>
* <dt>SwXMeta</dt><dd>the UNO wrapper object</dd>
* </dl>
*
* The text hint contains the pool item (as usual) and has a pointer to the
* text node at which it is attached.
* The pool item has a shared pointer to the metadatable entity, and a reverse
* pointer to the text attribute at which it is attached.
* The pool item is non-poolable; it may only be attached to one text
* attribute.
* Of all the pool items that refer to a metadatable entity, only one may be
* in the document content at any time. Others may be in the undo array, or in
* undo objects.
* The metadatable entity has a reverse pointer to the pool item that is
* currently in the document. It also registers as a client at the text node
* at which it is attached via this pool item and its text attribute.
* The UNO wrapper object registers as a client at the metadatable entity.
*
* Copying the metadatable entity proceeds in the following way:
* <ol>
* <li>The pool item is cloned (because it is non-poolable); the clone
* points to the same metadatable entity, but the metadatable entity's
* reverse pointer is unchanged.</li>
* <li>The DoCopy() method is called at the new pool item:
* it will clone the metadatable entity (using RegisterAsCopyOf).
* This is necessary, because first, a metadatable entity may
* only be inserted once into a document, and second, the copy may be
* inserted into a different document than the source document!</li>
* <li>A new text hint is created, taking over the new pool item.</li>
* <li>The text hint is inserted into the hints array of some text node.</li>
* </ol>
*/
class SwTextMeta;
class SwXMeta;
class SwXMetaField;
class SwTextNode;
class SwDoc;
namespace sw {
class Meta;
class MetaFieldManager;
}
/// SwFormatMeta is a pool item subclass that owns a Meta.
class SwFormatMeta final
: public SfxPoolItem
{
private:
friend class SwTextMeta; ///< needs SetTextAttr, DoCopy
friend class ::sw::Meta; ///< needs m_pTextAttr
std::shared_ptr< ::sw::Meta > m_pMeta;
SwTextMeta * m_pTextAttr;
SwTextMeta * GetTextAttr() { return m_pTextAttr; }
void SetTextAttr(SwTextMeta * const i_pTextAttr);
/// this method <em>must</em> be called when the hint is actually copied
void DoCopy(::sw::MetaFieldManager & i_rTargetDocManager,
SwTextNode & i_rTargetTextNode);
explicit SwFormatMeta( const sal_uInt16 i_nWhich );
public:
/// takes ownership
explicit SwFormatMeta( std::shared_ptr< ::sw::Meta > i_pMeta,
const sal_uInt16 i_nWhich );
virtual ~SwFormatMeta() override;
/// SfxPoolItem
virtual bool operator==( const SfxPoolItem & ) const override;
virtual SwFormatMeta* Clone( SfxItemPool *pPool = nullptr ) const override;
/// notify clients registered at m_pMeta that this meta is being (re-)moved
void NotifyChangeTextNode(SwTextNode *const pTextNode);
static SwFormatMeta * CreatePoolDefault( const sal_uInt16 i_nWhich );
::sw::Meta * GetMeta() { return m_pMeta.get(); }
};
namespace sw {
/// Meta is an annotation on a range of text. There is no UI to insert such annotations, but the UNO
/// API can do so.
///
/// See
/// <https://wiki.documentfoundation.org/Documentation/DevGuide/Office_Development#Annotated_text_range>
/// for more details.
class Meta
: public ::sfx2::Metadatable
, public sw::BroadcastingModify
{
friend class ::SwFormatMeta; ///< SetFormatMeta, NotifyChangeTextNode
friend class ::SwXMeta; ///< GetTextNode, GetTextAttr, Get/SetXMeta
unotools::WeakReference<SwXMeta> m_wXMeta;
SwFormatMeta * m_pFormat;
SwTextNode * m_pTextNode;
protected:
SwTextMeta * GetTextAttr() const;
SwTextNode * GetTextNode() const { return m_pTextNode;} ///< @return 0 if not in document (undo)
SwFormatMeta * GetFormatMeta() const { return m_pFormat; }
void SetFormatMeta( SwFormatMeta * const i_pFormat ) { m_pFormat = i_pFormat; };
void NotifyChangeTextNode(SwTextNode *const pTextNode);
unotools::WeakReference<SwXMeta> const& GetXMeta() const
{ return m_wXMeta; }
void SetXMeta(rtl::Reference<SwXMeta> const& xMeta);
virtual void SwClientNotify(const SwModify&, const SfxHint&) override;
public:
explicit Meta(SwFormatMeta * const i_pFormat);
virtual ~Meta() override;
/// sfx2::Metadatable
virtual ::sfx2::IXmlIdRegistry& GetRegistry() override;
virtual bool IsInClipboard() const override;
virtual bool IsInUndo() const override;
virtual bool IsInContent() const override;
virtual css::uno::Reference< css::rdf::XMetadatable > MakeUnoObject() override;
};
class MetaField final
: public Meta
{
private:
friend class ::SwFormatMeta;
friend class ::SwXMetaField;
friend class ::sw::MetaFieldManager;
sal_uInt32 m_nNumberFormat;
bool m_bIsFixedLanguage;
sal_uInt32 GetNumberFormat(const OUString& aContent) const;
void SetNumberFormat(sal_uInt32 nNumberFormat);
bool IsFixedLanguage() const { return m_bIsFixedLanguage; }
void SetIsFixedLanguage(bool b) { m_bIsFixedLanguage = b; }
explicit MetaField(SwFormatMeta * const i_pFormat,
const sal_uInt32 nNumberFormat,
const bool bIsFixedLanguage );
public:
/// get prefix/suffix from the RDF repository. @throws RuntimeException
void GetPrefixAndSuffix(
OUString *const o_pPrefix, OUString *const o_pSuffix, OUString *const o_pShadingColor);
};
/// knows all meta-fields in the document.
class SW_DLLPUBLIC MetaFieldManager
{
private:
typedef std::vector< std::weak_ptr<MetaField> > MetaFieldList_t;
MetaFieldList_t m_MetaFields;
/// Document properties of a clipboard document, empty for non-clipboard documents.
css::uno::Reference<css::document::XDocumentProperties> m_xDocumentProperties;
MetaFieldManager(MetaFieldManager const&) = delete;
MetaFieldManager& operator=(MetaFieldManager const&) = delete;
public:
MetaFieldManager();
std::shared_ptr<MetaField> makeMetaField(
SwFormatMeta * const i_pFormat = nullptr,
const sal_uInt32 nNumberFormat = SAL_MAX_UINT32,
const bool bIsFixedLanguage = false );
/// get all meta fields
std::vector< css::uno::Reference<css::text::XTextField> > getMetaFields();
/// Copy document properties from rSource to m_xDocumentProperties.
void copyDocumentProperties(const SwDoc& rSource);
const css::uno::Reference<css::document::XDocumentProperties>& getDocumentProperties() const;
};
} // namespace sw
#endif // INCLUDED_SW_INC_FMTMETA_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
