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
|
/* This file is part of the KDE project
SPDX-FileCopyrightText: 2013 Inge Wallin <inge@lysator.liu.se>
SPDX-License-Identifier: LGPL-2.0-or-later
*/
#ifndef ODFREADERCONTEXT_H
#define ODFREADERCONTEXT_H
// Qt
#include <QHash>
// Calligra
#include <KoFilter.h>
// this library
#include "koodfreader_export.h"
class QSizeF;
class KoStore;
class KoOdfStyleManager;
/** @brief The OdfReaderContext contains data that is usable while reading an ODF file.
*
* In the process of reading content.xml of an ODF file, it is often
* necessary to access other parts of the ODF files. In particular,
* the styles (both named and automatic), the manifest and the
* metadata are such resources. The OdfReaderContext provides a
* storage for this type of data.
*
* At the beginning of the traverse process, the Reader class is
* supposed to call analyzeOdfFile() in this class. This initializes
* the style, metadata and manifest store of the context. This data is
* not changed during the traverse and can be considered const.
*
* Another use of the OdfReaderContext class is to collect data
* during the traversal that can be used afterwards. One such example
* is that a list of all images that are accessed in the content is
* created. This list can be accessed afterwards by calling images().
*
* When you create a file format filter using a reader
* (e.g. OdtReader or OdsReader), you should inherit this class
* to create your own context class and extend it with storage of all
* data that is relevant for you during the conversion. Such data
* could be data about internal links, current list level, etc.
*
* @Note: At the time of writing there is only an OdtReader, no other readers.
*
* @see OdtReader
* @see OdtReaderBackend
*/
class KOODFREADER_EXPORT OdfReaderContext
{
public:
explicit OdfReaderContext(KoStore *store);
virtual ~OdfReaderContext();
/** Analyze (parse) the data in an ODF file other than the content
* and store it internally. This data can later be accessed by
* the getters such as metadata() and manifest().
*/
KoFilter::ConversionStatus analyzeOdfFile();
/** Return the store that is used during the parsing.
*/
KoStore *odfStore() const;
/** Return the styles of the ODF file.
*/
KoOdfStyleManager *styleManager() const;
/** Return the metadata of an ODF file.
*
* Format is QHash<name, value>
* where
* name is the name of the metadata tag
* value is its value
*
* This data is created before the traversal starts and can be
* accessed during the traversal.
*/
QHash<QString, QString> metadata() const;
/*** Return the manifest of an ODF file.
*
* Format is QHash<path, type>
* where
* path is the full path of the file stored in the manifest
* type is the mimetype of the file.
*
* This data is created before the traversal starts and can be
* accessed during the traversal.
*/
QHash<QString, QString> manifest() const;
// This data changes while the parsing proceeds.
bool isInsideParagraph() const;
void setIsInsideParagraph(bool isInside);
// This data below is created during the traversal and can be
// accessed after the traversal is finished.
/** Return a list of images and their sizes. This list is
* collected during the traversal of an ODF file.
*
* The format is QHash<name, size>
* where
* name is the name of the picture inside the ODT file
* size is the size in points.
*/
QHash<QString, QSizeF> images() const;
// QHash<QString, QString> mediaFiles() const;
private:
class Private;
Private *const d;
};
#endif // ODFREADERCONTEXT_H
|
