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
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef METADATABLE_HXX
#define METADATABLE_HXX
#include <sal/config.h>
#include <sfx2/dllapi.h>
#include <cppuhelper/implbase1.hxx>
#include <com/sun/star/rdf/XMetadatable.hpp>
#include <boost/utility.hpp>
#include <boost/shared_ptr.hpp>
namespace com { namespace sun { namespace star {
namespace frame { class XModel; }
} } }
namespace sfx2 {
class IXmlIdRegistry;
}
namespace sfx2 {
class XmlIdRegistry;
class MetadatableUndo;
// XML ID handling ---------------------------------------------------
/// create a sfx2::XmlIdRegistryDocument or a sfx2::XmlIdRegistryClipboard
SFX2_DLLPUBLIC ::sfx2::IXmlIdRegistry *
createXmlIdRegistry(const bool i_DocIsClipboard);
/** base class for core objects that may have xml:id.
<p>The interface of this class consists of 3 parts:
<ul><li>implementations that are used by the <type>MetadatableMixin</type>
below</li>
<li>hooks to be called by the sw core whenever actions that are
relevant to the uniqueness of xml:ids are taken (copying,
splitting, merging, deletion, undo, etc.)</li>
<li>abstract methods that are called by the implementation of the
previous hooks</li></ul>
</p>
*/
class SFX2_DLLPUBLIC Metadatable : private boost::noncopyable
{
public:
Metadatable() : m_pReg(0) {}
// destructor calls RemoveMetadataReference
virtual ~Metadatable();
// for MetadatableMixin ----------------------------------------------
::com::sun::star::beans::StringPair GetMetadataReference() const;
void SetMetadataReference(
const ::com::sun::star::beans::StringPair & i_rReference);
void EnsureMetadataReference();
// hooks -------------------------------------------------------------
// called from dtor!
void RemoveMetadataReference();
/** register this as a copy of i_rSource */
void RegisterAsCopyOf(Metadatable const & i_rSource,
const bool i_bCopyPrecedesSource = false);
/** create an Undo Metadatable, which remembers this' reference */
::boost::shared_ptr<MetadatableUndo> CreateUndo(
const bool i_isDelete = false);
/** restore this from Undo Metadatable */
void RestoreMetadata(::boost::shared_ptr<MetadatableUndo> const& i_pUndo);
/** merge this and i_rOther into this */
void JoinMetadatable(Metadatable const & i_rOther,
const bool i_isMergedEmpty, const bool i_isOtherEmpty);
// abstract methods --------------------------------------------------
/** get the registry from the SwDoc */
virtual ::sfx2::IXmlIdRegistry& GetRegistry() = 0;
/** is this in a clipboard document? */
virtual bool IsInClipboard() const = 0;
/** is this in undo array? */
virtual bool IsInUndo() const = 0;
/** which stream is this in? true: content.xml; false: styles.xml */
virtual bool IsInContent() const = 0;
/** create XMetadatable from this.
note: if IsInUndo or IsInClipboard return true,
MakeUnoObject <em>must not</em> be called!
*/
virtual ::com::sun::star::uno::Reference<
::com::sun::star::rdf::XMetadatable > MakeUnoObject() = 0;
private:
friend class MetadatableClipboard;
friend class MetadatableUndo;
// note that Reg may be a XmlIdRegistryDocument or a XmlIdRegistryClipboard
XmlIdRegistry* m_pReg; // null => no XmlId
};
/** base class for UNO objects that implement <type>XMetadatable</type>.
<p>An instance of this base class is associated with an instance of
<type>Metadatable</type>.</p>
*/
class SFX2_DLLPUBLIC MetadatableMixin :
public ::cppu::WeakImplHelper1<
::com::sun::star::rdf::XMetadatable>
{
public:
MetadatableMixin() {};
virtual ~MetadatableMixin() {}
// ::com::sun::star::rdf::XNode:
virtual ::rtl::OUString SAL_CALL getStringValue()
throw (::com::sun::star::uno::RuntimeException);
// ::com::sun::star::rdf::XURI:
virtual ::rtl::OUString SAL_CALL getLocalName()
throw (::com::sun::star::uno::RuntimeException);
virtual ::rtl::OUString SAL_CALL getNamespace()
throw (::com::sun::star::uno::RuntimeException);
// ::com::sun::star::rdf::XMetadatable:
virtual ::com::sun::star::beans::StringPair SAL_CALL getMetadataReference()
throw (::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL setMetadataReference(
const ::com::sun::star::beans::StringPair & i_rReference)
throw (::com::sun::star::uno::RuntimeException,
::com::sun::star::lang::IllegalArgumentException);
virtual void SAL_CALL ensureMetadataReference()
throw (::com::sun::star::uno::RuntimeException);
protected:
/// get the core object corresponding to this UNO object.
virtual Metadatable * GetCoreObject() = 0;
/// get the <type>XModel</type> for the document
virtual ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel >
GetModel() = 0;
};
} // namespace sfx2
#endif // METADATABLE_HXX
|
