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
|
/* This file is part of the KDE project
Copyright (C) 2007 Thorsten Zachmann <zachmann@kde.org>
Copyright (C) 2009 Jarosław Staniek <staniek@kde.org>
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 KOODFEXPORTER_H
#define KOODFEXPORTER_H
#include "komsooxml_export.h"
#include <KoFilter.h>
class KoXmlWriter;
class KoStore;
class KoGenStyles;
/**
* @brief Convenience structure encapsulating XML writers used when writing ODF document.
*/
struct KOMSOOXML_EXPORT KoOdfWriters {
/**
* Creates structure encapsulating XML writers. All members are set initially to 0.
*/
KoOdfWriters();
KoXmlWriter *content;
KoXmlWriter *body;
KoXmlWriter *meta;
KoXmlWriter *manifest;
KoGenStyles *mainStyles;
};
/**
* @brief The base class for filters exporting to ODF.
*
* @todo Move to libs, e.g. komain
*
* @author Jarosław Staniek <staniek@kde.org>
*/
class KOMSOOXML_EXPORT KoOdfExporter : public KoFilter
{
Q_OBJECT
public:
virtual ~KoOdfExporter();
virtual KoFilter::ConversionStatus convert(const QByteArray& from, const QByteArray& to);
protected:
/**
* This is the constructor your filter has to call, obviously.
* @param bodyContentElement element name for the content:
* "text" for ODT format, "presentation" for ODP,
* "spreadsheet" for ODS, "drawing" for ODG.
* office:text element will be created within office:body, etc.
* @param parent parent object.
*/
KoOdfExporter(const QString& bodyContentElement, QObject* parent = 0);
/**
* @return true if @a mime is accepted source mime type.
* Implement it for your filter.
*/
virtual bool acceptsSourceMimeType(const QByteArray& mime) const = 0;
/**
* @return true if @a mime is accepted destination mime type.
* Implement it for your filter.
*/
virtual bool acceptsDestinationMimeType(const QByteArray& mime) const = 0;
/**
* This method is called in convert() after creating @a outputStore, @a writers and @a mainStyles.
* Implement it for your filter with code that fills the ODF structures with converted data.
*/
virtual KoFilter::ConversionStatus createDocument(KoStore *outputStore,
KoOdfWriters *writers) = 0;
/**
* This method is called when writing the xml-settings to the ODF document.
*/
virtual void writeConfigurationSettings(KoXmlWriter* settings) const = 0;
private:
class Private;
Private* d;
};
#endif /* KOODFEXPORTER_H */
|
