RVNGTextTextGenerator.h Source File documentation

RVNGTextTextGenerator.h
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: t; c-basic-offset: 4 -*- */
2/* librevenge
3 * Version: MPL 2.0 / LGPLv2.1+
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * Major Contributor(s):
10* Copyright (C) 2002 William Lachance (wrlach@gmail.com)
11* Copyright (C) 2002-2003 Marc Maurer (uwog@uwog.net)
12 *
13 * For minor contributions see the git repository.
14 *
15 * Alternatively, the contents of this file may be used under the terms
16 * of the GNU Lesser General Public License Version 2.1 or later
17 * (LGPLv2.1+), in which case the provisions of the LGPLv2.1+ are
18 * applicable instead of those above.
19*/
20
21#ifndef RVNGTEXTTEXTGENERATOR_H
22#define RVNGTEXTTEXTGENERATOR_H
23
24#include "librevenge-generators-api.h"
25
26#include <librevenge/librevenge.h>
27#include <librevenge-stream/librevenge-stream.h>
28
29namespace librevenge
30{
31
32struct RVNGTextTextGeneratorImpl;
33
34 class REVENGE_GENERATORS_API RVNGTextTextGenerator : public RVNGTextInterface
35{
36 // disable copying
37 RVNGTextTextGenerator(const RVNGTextTextGenerator &other);
38 RVNGTextTextGenerator &operator=(const RVNGTextTextGenerator &other);
39
40public:
41 explicit RVNGTextTextGenerator(RVNGString &document, const bool isInfo=false);
42 ~RVNGTextTextGenerator();
43
44 void setDocumentMetaData(const RVNGPropertyList &propList);
45
46 void startDocument(const RVNGPropertyList &propList);
47 void endDocument();
48
49 void defineEmbeddedFont(const RVNGPropertyList &propList);
50
51 void definePageStyle(const RVNGPropertyList &);
52 void openPageSpan(const RVNGPropertyList &propList);
53 void closePageSpan();
54 void openHeader(const RVNGPropertyList &propList);
55 void closeHeader();
56 void openFooter(const RVNGPropertyList &propList);
57 void closeFooter();
58
59 void defineSectionStyle(const RVNGPropertyList &);
60 void openSection(const RVNGPropertyList &propList);
61 void closeSection();
62
63 void defineParagraphStyle(const RVNGPropertyList &);
64 void openParagraph(const RVNGPropertyList &propList);
65 void closeParagraph();
66
67 void defineCharacterStyle(const RVNGPropertyList &);
68 void openSpan(const RVNGPropertyList &propList);
69 void closeSpan();
70
71 void openLink(const RVNGPropertyList &propList);
72 void closeLink();
73
74 void insertTab();
75 void insertText(const RVNGString &text);
76 void insertSpace();
77 void insertLineBreak();
78 void insertField(const RVNGPropertyList &propList);
79
80 void openOrderedListLevel(const RVNGPropertyList &propList);
81 void openUnorderedListLevel(const RVNGPropertyList &propList);
82 void closeOrderedListLevel();
83 void closeUnorderedListLevel();
84 void openListElement(const RVNGPropertyList &propList);
85 void closeListElement();
86
87 void openFootnote(const RVNGPropertyList &propList);
88 void closeFootnote();
89 void openEndnote(const RVNGPropertyList &propList);
90 void closeEndnote();
91 void openComment(const RVNGPropertyList &propList);
92 void closeComment();
93 void openTextBox(const RVNGPropertyList &propList);
94 void closeTextBox();
95
96 void openTable(const RVNGPropertyList &propList);
97 void openTableRow(const RVNGPropertyList &propList);
98 void closeTableRow();
99 void openTableCell(const RVNGPropertyList &propList);
100 void closeTableCell();
101 void insertCoveredTableCell(const RVNGPropertyList &propList);
102 void closeTable();
103
104 void openFrame(const RVNGPropertyList &propList);
105 void closeFrame();
106
107 void openGroup(const librevenge::RVNGPropertyList &propList);
108 void closeGroup();
109
110 void defineGraphicStyle(const librevenge::RVNGPropertyList &propList);
111 void drawRectangle(const librevenge::RVNGPropertyList &propList);
112 void drawEllipse(const librevenge::RVNGPropertyList &propList);
113 void drawPolygon(const librevenge::RVNGPropertyList &propList);
114 void drawPolyline(const librevenge::RVNGPropertyList &propList);
115 void drawPath(const librevenge::RVNGPropertyList &propList);
116 void drawConnector(const RVNGPropertyList &propList);
117
118 void insertBinaryObject(const RVNGPropertyList &propList);
119 void insertEquation(const RVNGPropertyList &propList);
120
121private:
122 RVNGTextTextGeneratorImpl *m_impl;
123};
124
125}
126
127#endif /* RVNGTEXTTEXTGENERATOR_H */
128
129/* vim:set shiftwidth=4 softtabstop=4 noexpandtab: */
librevenge::RVNGPropertyList
Definition RVNGPropertyList.h:39
librevenge::RVNGString
UTF-8 string.
Definition RVNGString.h:34
librevenge::RVNGTextInterface
Definition RVNGTextInterface.h:40
librevenge::RVNGTextTextGenerator::closeParagraph
void closeParagraph()
Called when a paragraph is closed.
Definition RVNGTextTextGenerator.cpp:147
librevenge::RVNGTextTextGenerator::drawPath
void drawPath(const librevenge::RVNGPropertyList &propList)
Definition RVNGTextTextGenerator.cpp:261
librevenge::RVNGTextTextGenerator::openTableRow
void openTableRow(const RVNGPropertyList &propList)
Called when a new table row is opened.
Definition RVNGTextTextGenerator.cpp:243
librevenge::RVNGTextTextGenerator::RVNGTextTextGenerator
RVNGTextTextGenerator(const RVNGTextTextGenerator &other)
librevenge::RVNGTextTextGenerator::drawConnector
void drawConnector(const RVNGPropertyList &propList)
Draw a connector.
Definition RVNGTextTextGenerator.cpp:262
librevenge::RVNGTextTextGenerator::defineSectionStyle
void defineSectionStyle(const RVNGPropertyList &)
Definition RVNGTextTextGenerator.cpp:140
librevenge::RVNGTextTextGenerator::insertEquation
void insertEquation(const RVNGPropertyList &propList)
Called when a mathml object should be inserted.
Definition RVNGTextTextGenerator.cpp:265
librevenge::RVNGTextTextGenerator::closeComment
void closeComment()
Called when a comment or annotation should be closed.
Definition RVNGTextTextGenerator.cpp:238
librevenge::RVNGTextTextGenerator::openSection
void openSection(const RVNGPropertyList &propList)
Called when a new section is opened.
Definition RVNGTextTextGenerator.cpp:141
librevenge::RVNGTextTextGenerator::openUnorderedListLevel
void openUnorderedListLevel(const RVNGPropertyList &propList)
Called when a new unordered list level should be opened.
Definition RVNGTextTextGenerator.cpp:199
librevenge::RVNGTextTextGenerator::closeEndnote
void closeEndnote()
Called when a endnote should be closed.
Definition RVNGTextTextGenerator.cpp:232
librevenge::RVNGTextTextGenerator::openFootnote
void openFootnote(const RVNGPropertyList &propList)
Called when a footnote should be opened (a sub-document will be placed inside of it).
Definition RVNGTextTextGenerator.cpp:205
librevenge::RVNGTextTextGenerator::operator=
RVNGTextTextGenerator & operator=(const RVNGTextTextGenerator &other)
librevenge::RVNGTextTextGenerator::insertLineBreak
void insertLineBreak()
Called when a line break should be inserted.
Definition RVNGTextTextGenerator.cpp:189
librevenge::RVNGTextTextGenerator::defineEmbeddedFont
void defineEmbeddedFont(const RVNGPropertyList &propList)
Called when an embedded font should be defined.
Definition RVNGTextTextGenerator.cpp:132
librevenge::RVNGTextTextGenerator::closeTextBox
void closeTextBox()
Called when a text box should be closed.
Definition RVNGTextTextGenerator.cpp:240
librevenge::RVNGTextTextGenerator::openEndnote
void openEndnote(const RVNGPropertyList &propList)
Called when a endnote should be opened (a sub-document will be placed inside of it).
Definition RVNGTextTextGenerator.cpp:223
librevenge::RVNGTextTextGenerator::openTextBox
void openTextBox(const RVNGPropertyList &propList)
Called when a text box should be opened (a sub-document will be placed inside of it).
Definition RVNGTextTextGenerator.cpp:239
librevenge::RVNGTextTextGenerator::closeFooter
void closeFooter()
Called when a footer should be closed.
Definition RVNGTextTextGenerator.cpp:138
librevenge::RVNGTextTextGenerator::openLink
void openLink(const RVNGPropertyList &propList)
Called when a link should be opened.
Definition RVNGTextTextGenerator.cpp:165
librevenge::RVNGTextTextGenerator::closeHeader
void closeHeader()
Called when a header should be closed.
Definition RVNGTextTextGenerator.cpp:136
librevenge::RVNGTextTextGenerator::openOrderedListLevel
void openOrderedListLevel(const RVNGPropertyList &propList)
Called when a new ordered list level should be opened.
Definition RVNGTextTextGenerator.cpp:198
librevenge::RVNGTextTextGenerator::openListElement
void openListElement(const RVNGPropertyList &propList)
Called when a list element should be opened.
Definition RVNGTextTextGenerator.cpp:202
librevenge::RVNGTextTextGenerator::openComment
void openComment(const RVNGPropertyList &propList)
Called when a comment or annotation should be opened (a sub-document will be placed inside of it).
Definition RVNGTextTextGenerator.cpp:237
librevenge::RVNGTextTextGenerator::insertField
void insertField(const RVNGPropertyList &propList)
Called when a field should be inserted.
Definition RVNGTextTextGenerator.cpp:196
librevenge::RVNGTextTextGenerator::openFooter
void openFooter(const RVNGPropertyList &propList)
Called when a footer should be opened (a sub-document will be placed inside of it).
Definition RVNGTextTextGenerator.cpp:137
librevenge::RVNGTextTextGenerator::closeFrame
void closeFrame()
Called when the current positioned box is closed.
Definition RVNGTextTextGenerator.cpp:251
librevenge::RVNGTextTextGenerator::closeOrderedListLevel
void closeOrderedListLevel()
Called when an unordered list level should be closed.
Definition RVNGTextTextGenerator.cpp:200
librevenge::RVNGTextTextGenerator::startDocument
void startDocument(const RVNGPropertyList &propList)
Called at the start of the parsing process.
Definition RVNGTextTextGenerator.cpp:120
librevenge::RVNGTextTextGenerator::defineCharacterStyle
void defineCharacterStyle(const RVNGPropertyList &)
Definition RVNGTextTextGenerator.cpp:161
librevenge::RVNGTextTextGenerator::drawRectangle
void drawRectangle(const librevenge::RVNGPropertyList &propList)
Definition RVNGTextTextGenerator.cpp:257
librevenge::RVNGTextTextGenerator::closeTableCell
void closeTableCell()
Called when the current table cell is closed.
Definition RVNGTextTextGenerator.cpp:246
librevenge::RVNGTextTextGenerator::closeFootnote
void closeFootnote()
Called when a footnote should be closed.
Definition RVNGTextTextGenerator.cpp:216
librevenge::RVNGTextTextGenerator::openFrame
void openFrame(const RVNGPropertyList &propList)
Called when a positioned box should be opened.
Definition RVNGTextTextGenerator.cpp:250
librevenge::RVNGTextTextGenerator::insertSpace
void insertSpace()
Called when an explicit space should be inserted.
Definition RVNGTextTextGenerator.cpp:182
librevenge::RVNGTextTextGenerator::closeGroup
void closeGroup()
Definition RVNGTextTextGenerator.cpp:254
librevenge::RVNGTextTextGenerator::closePageSpan
void closePageSpan()
Called when a page span is closed.
Definition RVNGTextTextGenerator.cpp:134
librevenge::RVNGTextTextGenerator::drawPolyline
void drawPolyline(const librevenge::RVNGPropertyList &propList)
Definition RVNGTextTextGenerator.cpp:260
librevenge::RVNGTextTextGenerator::openPageSpan
void openPageSpan(const RVNGPropertyList &propList)
Called when a new page span is opened.
Definition RVNGTextTextGenerator.cpp:133
librevenge::RVNGTextTextGenerator::openGroup
void openGroup(const librevenge::RVNGPropertyList &propList)
Definition RVNGTextTextGenerator.cpp:253
librevenge::RVNGTextTextGenerator::setDocumentMetaData
void setDocumentMetaData(const RVNGPropertyList &propList)
Called when all document metadata should be set.
Definition RVNGTextTextGenerator.cpp:109
librevenge::RVNGTextTextGenerator::closeUnorderedListLevel
void closeUnorderedListLevel()
Called when an ununordered list level should be closed.
Definition RVNGTextTextGenerator.cpp:201
librevenge::RVNGTextTextGenerator::drawEllipse
void drawEllipse(const librevenge::RVNGPropertyList &propList)
Definition RVNGTextTextGenerator.cpp:258
librevenge::RVNGTextTextGenerator::drawPolygon
void drawPolygon(const librevenge::RVNGPropertyList &propList)
Definition RVNGTextTextGenerator.cpp:259
librevenge::RVNGTextTextGenerator::closeTable
void closeTable()
Called when the current table is closed.
Definition RVNGTextTextGenerator.cpp:248
librevenge::RVNGTextTextGenerator::openSpan
void openSpan(const RVNGPropertyList &propList)
Called when a text span is opened.
Definition RVNGTextTextGenerator.cpp:162
librevenge::RVNGTextTextGenerator::closeLink
void closeLink()
Called when the current link is closed.
Definition RVNGTextTextGenerator.cpp:166
librevenge::RVNGTextTextGenerator::insertCoveredTableCell
void insertCoveredTableCell(const RVNGPropertyList &propList)
Called when a covered (spanned by another cell in the table) table cell is opened.
Definition RVNGTextTextGenerator.cpp:247
librevenge::RVNGTextTextGenerator::closeSpan
void closeSpan()
Called when a text span is closed.
Definition RVNGTextTextGenerator.cpp:163
librevenge::RVNGTextTextGenerator::definePageStyle
void definePageStyle(const RVNGPropertyList &)
Definition RVNGTextTextGenerator.cpp:131
librevenge::RVNGTextTextGenerator::endDocument
void endDocument()
Called at the end of the parsing process.
Definition RVNGTextTextGenerator.cpp:121
librevenge::RVNGTextTextGenerator::openTableCell
void openTableCell(const RVNGPropertyList &propList)
Called when a new table cell is opened.
Definition RVNGTextTextGenerator.cpp:245
librevenge::RVNGTextTextGenerator::closeTableRow
void closeTableRow()
Called when the current table row is closed.
Definition RVNGTextTextGenerator.cpp:244
librevenge::RVNGTextTextGenerator::defineGraphicStyle
void defineGraphicStyle(const librevenge::RVNGPropertyList &propList)
Definition RVNGTextTextGenerator.cpp:256
librevenge::RVNGTextTextGenerator::m_impl
RVNGTextTextGeneratorImpl * m_impl
Definition RVNGTextTextGenerator.h:122
librevenge::RVNGTextTextGenerator::openTable
void openTable(const RVNGPropertyList &propList)
Called when a table should be opened.
Definition RVNGTextTextGenerator.cpp:242
librevenge::RVNGTextTextGenerator::closeListElement
void closeListElement()
Called when a list element should be closed.
Definition RVNGTextTextGenerator.cpp:203
librevenge::RVNGTextTextGenerator::openParagraph
void openParagraph(const RVNGPropertyList &propList)
Called when a new paragraph is opened.
Definition RVNGTextTextGenerator.cpp:145
librevenge::RVNGTextTextGenerator::closeSection
void closeSection()
Called when a section is closed.
Definition RVNGTextTextGenerator.cpp:142
librevenge::RVNGTextTextGenerator::defineParagraphStyle
void defineParagraphStyle(const RVNGPropertyList &)
Definition RVNGTextTextGenerator.cpp:144
librevenge::RVNGTextTextGenerator::insertTab
void insertTab()
Called when a TAB character should be inserted.
Definition RVNGTextTextGenerator.cpp:168
librevenge::RVNGTextTextGenerator::insertBinaryObject
void insertBinaryObject(const RVNGPropertyList &propList)
Called when a binary object should be inserted.
Definition RVNGTextTextGenerator.cpp:264
librevenge::RVNGTextTextGenerator::insertText
void insertText(const RVNGString &text)
Called when a string of text should be inserted.
Definition RVNGTextTextGenerator.cpp:175
librevenge::RVNGTextTextGenerator::openHeader
void openHeader(const RVNGPropertyList &propList)
Called when a header should be opened (a sub-document will be placed inside of it).
Definition RVNGTextTextGenerator.cpp:135
librevenge-generators-api.h
REVENGE_GENERATORS_API
#define REVENGE_GENERATORS_API
Definition librevenge-generators-api.h:34
librevenge-stream.h
librevenge.h
librevenge
Definition RVNGBinaryData.cpp:40
librevenge::RVNGTextTextGeneratorImpl
Definition RVNGTextTextGenerator.cpp:68