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
|
/* This file is part of the KDE project
Copyright (C) 2005 David Faure <faure@kde.org>
Copyright (C) 2007 Thorsten Zachmann <zachmann@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 KOODFREADSTORE_H
#define KOODFREADSTORE_H
#include "KoXmlReaderForward.h"
#include "koodf_export.h"
class QString;
class QIODevice;
class KoStore;
class KoOdfStylesReader;
/**
* Helper class around KoStore for reading out ODF files.
*
* The class loads and parses files from the KoStore.
*
* @author: David Faure <faure@kde.org>
*/
class KOODF_EXPORT KoOdfReadStore
{
public:
/// @param store recontents the property of the caller
explicit KoOdfReadStore(KoStore* store);
~KoOdfReadStore();
/**
* Get the store
*/
KoStore* store() const;
/**
* Get the styles
*
* To get a usable result loadAndParse( QString ) has to be called first.
*
* @return styles
*/
KoOdfStylesReader &styles();
/**
* Get the content document
*
* To get a usable result loadAndParse( QString ) has to be called first.
*
* This gives you the content of the content.xml file
*/
KoXmlDocument contentDoc() const;
/**
* Get the settings document
*
* To get a usable result loadAndParse( QString ) has to be called first.
*
* This gives you the content of the settings.xml file
*/
KoXmlDocument settingsDoc() const;
/**
* Load and parse
*
* This function loads and parses the content.xml, styles.xml and the settings.xml
* file in the store. The sytles are already parsed.
*
* After this function is called you can access the data via
* styles()
* contentDoc()
* settingsDoc()
*
* @param errorMessage The errorMessage is set in case an error is encounted.
* @return true if loading and parsing was successful, false otherwise. In case of an error
* the errorMessage is updated accordingly.
*/
bool loadAndParse(QString &errorMessage);
/**
* Load a file from an odf store
*/
bool loadAndParse(const QString &fileName, KoXmlDocument &doc, QString &errorMessage);
/**
* Load a file and parse from a QIODevice
* filename argument is just used for debug message
*/
static bool loadAndParse(QIODevice *fileDevice, KoXmlDocument &doc, QString &errorMessage, const QString& fileName);
private:
class Private;
Private * const d;
};
#endif /* KOODFREADSTORE_H */
|
