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
|
/* This file is part of the KDE project
Copyright (C) 2007 Thorsten Zachmann <zachmann@kde.org>
Copyright (C) 2011 Inge Wallin <inge@lysator.liu.se>
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 KOEMBEDDEDDOCUMENTSAVER_H
#define KOEMBEDDEDDOCUMENTSAVER_H
#include "KoDocumentBase.h"
#include "koodf_export.h"
#include <QString>
class KoXmlWriter;
/**
* This class is used to save embedded objects in ODF documents.
*
* @see KoEmbeddedFileSaver
*/
class KOODF_EXPORT KoEmbeddedDocumentSaver
{
public:
KoEmbeddedDocumentSaver();
~KoEmbeddedDocumentSaver();
/**
* Get a unique file name with the given prefix, to be used as a name for an embedded file in the ODF store.
* @param the prefix of the filename to be created.
* return a unique file name for use in the odf store.
*/
QString getFilename(const QString &prefix);
/**
* Adds the object specific attributes to the tag, but does NOT
* write the content of the embedded document. Saving of the
* embedded documents themselves is done in @ref save. This
* function should be called from within KoDocumentBase::saveOdf.
*/
void embedDocument(KoXmlWriter &writer, KoDocumentBase *doc);
/**
* Adds the object specific attributes to the tag, and queues the
* file for saving into the store.
*
* However, it does NOT write the content of the embedded document
* to the store. Saving of the embedded files themselves is done
* in @ref saveEmbeddedFiles. This function should be called from
* within saveOdf in a shape or a document.
*/
void embedFile(KoXmlWriter &writer, const char *element,
const QString &path, const QByteArray &mimeType,
const QByteArray &contents);
/**
* Queues the file for saving into the store.
*
* Saving of the embedded files themselves is done in @ref
* saveEmbeddedFiles. This function should be called from within
* saveOdf in a shape or a document if you don't wish to have a
* reference to the file within content.xml, e.g. when the file is
* part of an embedded object with embedded files within it.
*/
void saveFile(const QString &path, const QByteArray &mimeType,
const QByteArray &contents);
/**
*
*/
void saveManifestEntry(const QString &fullPath, const QString &mediaType,
const QString &version = QString());
/**
* Save all embedded documents to the store.
*/
bool saveEmbeddedDocuments(KoDocumentBase::SavingContext &documentContext);
private:
class Private;
Private * const d;
Q_DISABLE_COPY(KoEmbeddedDocumentSaver)
};
#endif /* KOEMBEDDEDDOCUMENTSAVER_H */
|
