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
|
/* This file is part of the KDE project
Copyright (C) 1998, 1999, 2000 Torben Weis <weis@kde.org>
Copyright (C) 2004 David Faure <faure@kde.org>
Copyright (C) 2006 Martin Pfeiffer <hubipete@gmx.net>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library 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
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#ifndef KO_DOCUMENT_INFO_H
#define KO_DOCUMENT_INFO_H
#include <QObject>
#include <QMap>
#include <QString>
#include <QStringList>
#include "koodf_export.h"
#include <KoXmlReader.h>
class QDomDocument;
class QDomElement;
class KoStore;
class KoXmlWriter;
/**
* @short The class containing all meta information about a document
*
* @author Torben Weis <weis@kde.org>
* @author David Faure <faure@kde.org>
* @author Martin Pfeiffer <hubipete@gmx.net>
* @see KoDocumentInfoDlg
*
* This class contains the meta information for a document. They are
* stored in two QMap and can be accessed through aboutInfo() and authorInfo().
* The about info can be changed with setAboutInfo() and setAuthorInfo()
*/
class KOODF_EXPORT KoDocumentInfo : public QObject
{
Q_OBJECT
public:
/**
* The constructor
* @param parent a pointer to the parent object
*/
explicit KoDocumentInfo(QObject *parent = 0);
/** The destructor */
~KoDocumentInfo() override;
/**
* Load the KoDocumentInfo from an OASIS document
* @param metaDoc the QDomDocument with the metaInformation
* @return true if success
*/
bool loadOasis(const KoXmlDocument& metaDoc);
/**
* Save the KoDocumentInfo to an OASIS document
* @param store a pointer to a KoStore to save in
* @return true if success
*/
bool saveOasis(KoStore* store);
/**
* Load the KoDocumentInfo from an Calligra-1.3 DomDocument
* @param doc the QDomDocument to load from
* @return true if success
*/
bool load(const KoXmlDocument& doc);
/**
* Save the KoDocumentInfo to an Calligra-1.3 DomDocument
* @return the QDomDocument to which was saved
*/
QDomDocument save(QDomDocument &doc);
/**
* Set information about the author.
* This will override any information retrieved from the author profile
* But it does not change the author profile
* Note: authorInfo() will not return the new value until the document has been
* saved by the user.(autosave doesn't count)
* @param info the kind of information to set
* @param data the data to set for this information
*/
void setAuthorInfo(const QString& info, const QString& data);
/**
* Obtain information about the author
* @param info the kind of information to obtain
* @return a QString with the information
*/
QString authorInfo(const QString& info) const;
/**
* Set information about the document
* @param info the kind of information to set
* @param data the data to set for this information
*/
void setAboutInfo(const QString& info, const QString& data);
/**
* Obtain information about the document
* @param info the kind of information to obtain
* @return a QString with the information
*/
QString aboutInfo(const QString& info) const;
/**
* Obtain the generator of the document, as it was loaded from the document
*/
QString originalGenerator() const;
/**
* Sets the original generator of the document. This does not affect what gets
* saved to a document in the meta:generator field, it only changes what
* originalGenerator() will return.
*/
void setOriginalGenerator(const QString& generator);
/** Resets part of the meta data */
void resetMetaData();
/** Takes care of updating the document info from configuration correctly */
void updateParameters();
private:
/// Bumps the editing cycles count and save date, and then calls updateParameters
void updateParametersAndBumpNumCycles();
/**
* Set information about the author
* This sets what is actually saved to file. The public method setAuthorInfo() can be used to set
* values that override what is fetched from the author profile. During saveParameters() author
* profile and any overrides is combined resulting in calls to this method.
* @param info the kind of information to set
* @param data the data to set for this information
*/
void setActiveAuthorInfo(const QString& info, const QString& data);
/**
* Load the information about the document from an OASIS file
* @param metaDoc a reference to the information node
* @return true if success
*/
bool loadOasisAboutInfo(const KoXmlNode& metaDoc);
/**
* Save the information about the document to an OASIS file
* @param xmlWriter a reference to the KoXmlWriter to write in
* @return true if success
*/
bool saveOasisAboutInfo(KoXmlWriter &xmlWriter);
/**
* Load the information about the document from a Calligra-1.3 file
* @param e the element to load from
* @return true if success
*/
bool loadAboutInfo(const KoXmlElement& e);
/**
* Save the information about the document to a Calligra-1.3 file
* @param doc the QDomDocument to save in
* @return the QDomElement to which was saved
*/
QDomElement saveAboutInfo(QDomDocument& doc);
/**
* Load the information about the document from an OASIS file
* @param metaDoc a reference to the information node
* @return true if success
*/
bool loadOasisAuthorInfo(const KoXmlNode& metaDoc);
/**
* Load the information about the document from a Calligra-1.3 file
* @param e the element to load from
* @return true if success
*/
bool loadAuthorInfo(const KoXmlElement& e);
/**
* Save the information about the author to a Calligra-1.3 file
* @param doc the QDomDocument to save in
* @return the QDomElement to which was saved
*/
QDomElement saveAuthorInfo(QDomDocument& doc);
/**
* Save the information about the document to an OASIS file
* @param xmlWriter a reference to the KoXmlWriter to write in
* @return true if success
*/
bool saveOasisAuthorInfo(KoXmlWriter &xmlWriter);
/** A QStringList containing all tags for the document information */
QStringList m_aboutTags;
/** A QStringList containing all tags for the author information */
QStringList m_authorTags;
/** The map containing information about the author */
QMap<QString, QString> m_authorInfo;
/** The map containing information about the author set programatically*/
QMap<QString, QString> m_authorInfoOverride;
/** The map containing information about the document */
QMap<QString, QString> m_aboutInfo;
/** The original meta:generator of the document */
QString m_generator;
const QString m_keywordSeparator = QStringLiteral(";");
Q_SIGNALS:
void infoUpdated(const QString &info, const QString &data);
};
#endif
|
