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
|
/* This file is part of the KDE project
Copyright (C) 2013 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 ODFTEXTREADERBACKEND_H
#define ODFTEXTREADERBACKEND_H
// Calligra
#include <KoXmlStreamReader.h>
#include <KoFilter.h>
// this library
#include "koodfreader_export.h"
#include "OdfTextReader.h"
class OdfReaderContext;
/** @brief A default backend for the OdfTextReader class.
*
* This class defines an interface and the default behaviour for the
* backend to the ODF text reader (@see OdfTextReader). When the
* reader is called upon to traverse a certain XML tree, there will
* be two parameters to the root traverse function: a pointer to a
* backend object and a pointer to a context object.
*
* The reader will traverse (read) the XML tree and for every element
* it comes across it will call a specific function in the backend and
* every call will pass the pointer to the context object.
*
* Each supported XML tag has a corresponding callback function. This
* callback function will be called twice: once when the tag is first
* encountered anc once when the tag is closed. This means that an
* element with no child elements will be called twice in succession.
*/
class KOODFREADER_EXPORT OdfTextReaderBackend
{
public:
explicit OdfTextReaderBackend();
virtual ~OdfTextReaderBackend();
// ----------------------------------------------------------------
// Text level functions: paragraphs, headings, sections, frames, objects, etc
virtual void elementOfficeAnnotation(KoXmlStreamReader &reader, OdfReaderContext *context);
virtual void elementOfficeAnnotationEnd(KoXmlStreamReader &reader, OdfReaderContext *context);
virtual void elementDcCreator(KoXmlStreamReader &reader, OdfReaderContext *context);
virtual void elementDcDate(KoXmlStreamReader &reader, OdfReaderContext *context);
virtual void elementTextH(KoXmlStreamReader &reader, OdfReaderContext *context);
virtual void elementTextP(KoXmlStreamReader &reader, OdfReaderContext *context);
virtual void elementTextList(KoXmlStreamReader &reader, OdfReaderContext *context);
virtual void elementTableTable(KoXmlStreamReader &reader, OdfReaderContext *context);
virtual void elementTableTableColumn(KoXmlStreamReader &reader, OdfReaderContext *context);
virtual void elementTableTableHeaderRows(KoXmlStreamReader &reader, OdfReaderContext *context);
virtual void elementTableTableRow(KoXmlStreamReader &reader, OdfReaderContext *context);
virtual void elementTableTableCell(KoXmlStreamReader &reader, OdfReaderContext *context);
virtual void elementTableCoveredTableCell(KoXmlStreamReader &reader, OdfReaderContext *context);
// ----------------------------------------------------------------
// Paragraph level functions: spans, annotations, notes, etc.
// This includes text content itself.
virtual void elementTextA(KoXmlStreamReader &reader, OdfReaderContext *context);
virtual void elementTextLineBreak(KoXmlStreamReader &reader, OdfReaderContext *context);
virtual void elementTextSpan(KoXmlStreamReader &reader, OdfReaderContext *context);
virtual void elementTextS(KoXmlStreamReader &reader, OdfReaderContext *context);
// ----------------------------------------------------------------
// List level functions: list-header and list-item.
virtual void elementTextListHeader(KoXmlStreamReader &reader, OdfReaderContext *context);
virtual void elementTextListItem(KoXmlStreamReader &reader, OdfReaderContext *context);
virtual void elementTextSoftPageBreak(KoXmlStreamReader &reader, OdfReaderContext *context);
virtual void characterData(KoXmlStreamReader &reader, OdfReaderContext *context);
private:
class Private;
Private * const d;
};
#endif // ODFTEXTREADERBACKEND_H
|
