RVNGHTMLTextGenerator.h Source File documentation

RVNGHTMLTextGenerator.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-2005 William Lachance (wrlach@gmail.com)
11 * Copyright (C) 2002 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 RVNGHTMLTEXTGENERATOR_H
22#define RVNGHTMLTEXTGENERATOR_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 RVNGHTMLTextGeneratorImpl;
33
34 class REVENGE_GENERATORS_API RVNGHTMLTextGenerator : public RVNGTextInterface
35{
36public:
37 explicit RVNGHTMLTextGenerator(RVNGString &document);
38 ~RVNGHTMLTextGenerator();
39
40 void setDocumentMetaData(const RVNGPropertyList &propList);
41
42 void startDocument(const RVNGPropertyList &propList);
43 void endDocument();
44
45 void defineEmbeddedFont(const RVNGPropertyList &propList);
46
47 void definePageStyle(const RVNGPropertyList &);
48 void openPageSpan(const RVNGPropertyList &propList);
49 void closePageSpan();
50 void openHeader(const RVNGPropertyList &propList);
51 void closeHeader();
52 void openFooter(const RVNGPropertyList &propList);
53 void closeFooter();
54
55 void defineSectionStyle(const RVNGPropertyList &);
56 void openSection(const RVNGPropertyList &propList);
57 void closeSection();
58
59 void defineParagraphStyle(const RVNGPropertyList &);
60 void openParagraph(const RVNGPropertyList &propList);
61 void closeParagraph();
62
63 void defineCharacterStyle(const RVNGPropertyList &);
64 void openSpan(const RVNGPropertyList &propList);
65 void closeSpan();
66
67 void openLink(const RVNGPropertyList &propList);
68 void closeLink();
69
70 void insertTab();
71 void insertText(const RVNGString &text);
72 void insertSpace();
73 void insertLineBreak();
74 void insertField(const RVNGPropertyList &propList);
75
76 void openOrderedListLevel(const RVNGPropertyList &propList);
77 void openUnorderedListLevel(const RVNGPropertyList &propList);
78 void closeOrderedListLevel();
79 void closeUnorderedListLevel();
80 void openListElement(const RVNGPropertyList &propList);
81 void closeListElement();
82
83 void openFootnote(const RVNGPropertyList &propList);
84 void closeFootnote();
85 void openEndnote(const RVNGPropertyList &propList);
86 void closeEndnote();
87 void openComment(const RVNGPropertyList &propList);
88 void closeComment();
89 void openTextBox(const RVNGPropertyList &propList);
90 void closeTextBox();
91
92 void openTable(const RVNGPropertyList &propList);
93 void openTableRow(const RVNGPropertyList &propList);
94 void closeTableRow();
95 void openTableCell(const RVNGPropertyList &propList);
96 void closeTableCell();
97 void insertCoveredTableCell(const RVNGPropertyList &propList);
98 void closeTable();
99
100 void openFrame(const RVNGPropertyList &propList);
101 void closeFrame();
102
103 void openGroup(const librevenge::RVNGPropertyList &propList);
104 void closeGroup();
105
106 void defineGraphicStyle(const librevenge::RVNGPropertyList &propList);
107 void drawRectangle(const librevenge::RVNGPropertyList &propList);
108 void drawEllipse(const librevenge::RVNGPropertyList &propList);
109 void drawPolygon(const librevenge::RVNGPropertyList &propList);
110 void drawPolyline(const librevenge::RVNGPropertyList &propList);
111 void drawPath(const librevenge::RVNGPropertyList &propList);
112 void drawConnector(const RVNGPropertyList &propList);
113
114 void insertBinaryObject(const RVNGPropertyList &propList);
115 void insertEquation(const RVNGPropertyList &propList);
116
117private:
118 RVNGHTMLTextGeneratorImpl *m_impl;
119
120 // Unimplemented to prevent compiler from creating crasher ones
121 RVNGHTMLTextGenerator(const RVNGHTMLTextGenerator &);
122 RVNGHTMLTextGenerator &operator=(const RVNGHTMLTextGenerator &);
123};
124
125}
126
127#endif /* RVNGHTMLTEXTGENERATOR_H */
128
129/* vim:set shiftwidth=4 softtabstop=4 noexpandtab: */
librevenge::RVNGHTMLTextGenerator::closeGroup
void closeGroup()
Definition RVNGHTMLTextGenerator.cpp:742
librevenge::RVNGHTMLTextGenerator::openTable
void openTable(const RVNGPropertyList &propList)
Called when a table should be opened.
Definition RVNGHTMLTextGenerator.cpp:680
librevenge::RVNGHTMLTextGenerator::openGroup
void openGroup(const librevenge::RVNGPropertyList &propList)
Definition RVNGHTMLTextGenerator.cpp:741
librevenge::RVNGHTMLTextGenerator::insertSpace
void insertSpace()
Called when an explicit space should be inserted.
Definition RVNGHTMLTextGenerator.cpp:560
librevenge::RVNGHTMLTextGenerator::closeUnorderedListLevel
void closeUnorderedListLevel()
Called when an ununordered list level should be closed.
Definition RVNGHTMLTextGenerator.cpp:593
librevenge::RVNGHTMLTextGenerator::closeTable
void closeTable()
Called when the current table is closed.
Definition RVNGHTMLTextGenerator.cpp:729
librevenge::RVNGHTMLTextGenerator::openOrderedListLevel
void openOrderedListLevel(const RVNGPropertyList &propList)
Called when a new ordered list level should be opened.
Definition RVNGHTMLTextGenerator.cpp:567
librevenge::RVNGHTMLTextGenerator::closeSpan
void closeSpan()
Called when a text span is closed.
Definition RVNGHTMLTextGenerator.cpp:501
librevenge::RVNGHTMLTextGenerator::closeFrame
void closeFrame()
Called when the current positioned box is closed.
Definition RVNGHTMLTextGenerator.cpp:739
librevenge::RVNGHTMLTextGenerator::closeComment
void closeComment()
Called when a comment or annotation should be closed.
Definition RVNGHTMLTextGenerator.cpp:657
librevenge::RVNGHTMLTextGenerator::openHeader
void openHeader(const RVNGPropertyList &propList)
Called when a header should be opened (a sub-document will be placed inside of it).
Definition RVNGHTMLTextGenerator.cpp:427
librevenge::RVNGHTMLTextGenerator::openTextBox
void openTextBox(const RVNGPropertyList &propList)
Called when a text box should be opened (a sub-document will be placed inside of it).
Definition RVNGHTMLTextGenerator.cpp:664
librevenge::RVNGHTMLTextGenerator::defineEmbeddedFont
void defineEmbeddedFont(const RVNGPropertyList &propList)
Called when an embedded font should be defined.
Definition RVNGHTMLTextGenerator.cpp:412
librevenge::RVNGHTMLTextGenerator::openFrame
void openFrame(const RVNGPropertyList &propList)
Called when a positioned box should be opened.
Definition RVNGHTMLTextGenerator.cpp:738
librevenge::RVNGHTMLTextGenerator::RVNGHTMLTextGenerator
RVNGHTMLTextGenerator(RVNGString &document)
Definition RVNGHTMLTextGenerator.cpp:349
librevenge::RVNGHTMLTextGenerator::defineGraphicStyle
void defineGraphicStyle(const librevenge::RVNGPropertyList &propList)
Definition RVNGHTMLTextGenerator.cpp:744
librevenge::RVNGHTMLTextGenerator::drawEllipse
void drawEllipse(const librevenge::RVNGPropertyList &propList)
Definition RVNGHTMLTextGenerator.cpp:746
librevenge::RVNGHTMLTextGenerator::startDocument
void startDocument(const RVNGPropertyList &propList)
Called at the start of the parsing process.
Definition RVNGHTMLTextGenerator.cpp:385
librevenge::RVNGHTMLTextGenerator::insertEquation
void insertEquation(const RVNGPropertyList &propList)
Called when a mathml object should be inserted.
Definition RVNGHTMLTextGenerator.cpp:753
librevenge::RVNGHTMLTextGenerator::closeHeader
void closeHeader()
Called when a header should be closed.
Definition RVNGHTMLTextGenerator.cpp:432
librevenge::RVNGHTMLTextGenerator::setDocumentMetaData
void setDocumentMetaData(const RVNGPropertyList &propList)
Called when all document metadata should be set.
Definition RVNGHTMLTextGenerator.cpp:358
librevenge::RVNGHTMLTextGenerator::drawPolyline
void drawPolyline(const librevenge::RVNGPropertyList &propList)
Definition RVNGHTMLTextGenerator.cpp:748
librevenge::RVNGHTMLTextGenerator::closeTextBox
void closeTextBox()
Called when a text box should be closed.
Definition RVNGHTMLTextGenerator.cpp:673
librevenge::RVNGHTMLTextGenerator::closeTableRow
void closeTableRow()
Called when the current table row is closed.
Definition RVNGHTMLTextGenerator.cpp:699
librevenge::RVNGHTMLTextGenerator::openEndnote
void openEndnote(const RVNGPropertyList &propList)
Called when a endnote should be opened (a sub-document will be placed inside of it).
Definition RVNGHTMLTextGenerator.cpp:632
librevenge::RVNGHTMLTextGenerator::closeTableCell
void closeTableCell()
Called when the current table cell is closed.
Definition RVNGHTMLTextGenerator.cpp:720
librevenge::RVNGHTMLTextGenerator::drawPolygon
void drawPolygon(const librevenge::RVNGPropertyList &propList)
Definition RVNGHTMLTextGenerator.cpp:747
librevenge::RVNGHTMLTextGenerator::openTableRow
void openTableRow(const RVNGPropertyList &propList)
Called when a new table row is opened.
Definition RVNGHTMLTextGenerator.cpp:692
librevenge::RVNGHTMLTextGenerator::endDocument
void endDocument()
Called at the end of the parsing process.
Definition RVNGHTMLTextGenerator.cpp:389
librevenge::RVNGHTMLTextGenerator::drawPath
void drawPath(const librevenge::RVNGPropertyList &propList)
Definition RVNGHTMLTextGenerator.cpp:749
librevenge::RVNGHTMLTextGenerator::operator=
RVNGHTMLTextGenerator & operator=(const RVNGHTMLTextGenerator &)
librevenge::RVNGHTMLTextGenerator::openFootnote
void openFootnote(const RVNGPropertyList &propList)
Called when a footnote should be opened (a sub-document will be placed inside of it).
Definition RVNGHTMLTextGenerator.cpp:616
librevenge::RVNGHTMLTextGenerator::openTableCell
void openTableCell(const RVNGPropertyList &propList)
Called when a new table cell is opened.
Definition RVNGHTMLTextGenerator.cpp:706
librevenge::RVNGHTMLTextGenerator::openFooter
void openFooter(const RVNGPropertyList &propList)
Called when a footer should be opened (a sub-document will be placed inside of it).
Definition RVNGHTMLTextGenerator.cpp:438
librevenge::RVNGHTMLTextGenerator::defineSectionStyle
void defineSectionStyle(const RVNGPropertyList &)
Definition RVNGHTMLTextGenerator.cpp:448
librevenge::RVNGHTMLTextGenerator::openListElement
void openListElement(const RVNGPropertyList &propList)
Called when a list element should be opened.
Definition RVNGHTMLTextGenerator.cpp:602
librevenge::RVNGHTMLTextGenerator::insertTab
void insertTab()
Called when a TAB character should be inserted.
Definition RVNGHTMLTextGenerator.cpp:530
librevenge::RVNGHTMLTextGenerator::closeLink
void closeLink()
Called when the current link is closed.
Definition RVNGHTMLTextGenerator.cpp:523
librevenge::RVNGHTMLTextGenerator::openPageSpan
void openPageSpan(const RVNGPropertyList &propList)
Called when a new page span is opened.
Definition RVNGHTMLTextGenerator.cpp:416
librevenge::RVNGHTMLTextGenerator::defineCharacterStyle
void defineCharacterStyle(const RVNGPropertyList &)
Definition RVNGHTMLTextGenerator.cpp:488
librevenge::RVNGHTMLTextGenerator::insertBinaryObject
void insertBinaryObject(const RVNGPropertyList &propList)
Called when a binary object should be inserted.
Definition RVNGHTMLTextGenerator.cpp:752
librevenge::RVNGHTMLTextGenerator::defineParagraphStyle
void defineParagraphStyle(const RVNGPropertyList &)
Definition RVNGHTMLTextGenerator.cpp:452
librevenge::RVNGHTMLTextGenerator::m_impl
RVNGHTMLTextGeneratorImpl * m_impl
Definition RVNGHTMLTextGenerator.h:118
librevenge::RVNGHTMLTextGenerator::openLink
void openLink(const RVNGPropertyList &propList)
Called when a link should be opened.
Definition RVNGHTMLTextGenerator.cpp:508
librevenge::RVNGHTMLTextGenerator::RVNGHTMLTextGenerator
RVNGHTMLTextGenerator(const RVNGHTMLTextGenerator &)
librevenge::RVNGHTMLTextGenerator::insertField
void insertField(const RVNGPropertyList &propList)
Called when a field should be inserted.
Definition RVNGHTMLTextGenerator.cpp:546
librevenge::RVNGHTMLTextGenerator::openUnorderedListLevel
void openUnorderedListLevel(const RVNGPropertyList &propList)
Called when a new unordered list level should be opened.
Definition RVNGHTMLTextGenerator.cpp:584
librevenge::RVNGHTMLTextGenerator::closeSection
void closeSection()
Called when a section is closed.
Definition RVNGHTMLTextGenerator.cpp:450
librevenge::RVNGHTMLTextGenerator::closePageSpan
void closePageSpan()
Called when a page span is closed.
Definition RVNGHTMLTextGenerator.cpp:421
librevenge::RVNGHTMLTextGenerator::drawConnector
void drawConnector(const RVNGPropertyList &propList)
Draw a connector.
Definition RVNGHTMLTextGenerator.cpp:750
librevenge::RVNGHTMLTextGenerator::closeEndnote
void closeEndnote()
Called when a endnote should be closed.
Definition RVNGHTMLTextGenerator.cpp:641
librevenge::RVNGHTMLTextGenerator::drawRectangle
void drawRectangle(const librevenge::RVNGPropertyList &propList)
Definition RVNGHTMLTextGenerator.cpp:745
librevenge::RVNGHTMLTextGenerator::insertText
void insertText(const RVNGString &text)
Called when a string of text should be inserted.
Definition RVNGHTMLTextGenerator.cpp:553
librevenge::RVNGHTMLTextGenerator::openSpan
void openSpan(const RVNGPropertyList &propList)
Called when a text span is opened.
Definition RVNGHTMLTextGenerator.cpp:493
librevenge::RVNGHTMLTextGenerator::definePageStyle
void definePageStyle(const RVNGPropertyList &)
Definition RVNGHTMLTextGenerator.cpp:425
librevenge::RVNGHTMLTextGenerator::openParagraph
void openParagraph(const RVNGPropertyList &propList)
Called when a new paragraph is opened.
Definition RVNGHTMLTextGenerator.cpp:460
librevenge::RVNGHTMLTextGenerator::openSection
void openSection(const RVNGPropertyList &propList)
Called when a new section is opened.
Definition RVNGHTMLTextGenerator.cpp:449
librevenge::RVNGHTMLTextGenerator::closeOrderedListLevel
void closeOrderedListLevel()
Called when an unordered list level should be closed.
Definition RVNGHTMLTextGenerator.cpp:576
librevenge::RVNGHTMLTextGenerator::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 RVNGHTMLTextGenerator.cpp:648
librevenge::RVNGHTMLTextGenerator::insertLineBreak
void insertLineBreak()
Called when a line break should be inserted.
Definition RVNGHTMLTextGenerator.cpp:539
librevenge::RVNGHTMLTextGenerator::closeFootnote
void closeFootnote()
Called when a footnote should be closed.
Definition RVNGHTMLTextGenerator.cpp:625
librevenge::RVNGHTMLTextGenerator::insertCoveredTableCell
void insertCoveredTableCell(const RVNGPropertyList &propList)
Called when a covered (spanned by another cell in the table) table cell is opened.
Definition RVNGHTMLTextGenerator.cpp:727
librevenge::RVNGHTMLTextGenerator::closeFooter
void closeFooter()
Called when a footer should be closed.
Definition RVNGHTMLTextGenerator.cpp:443
librevenge::RVNGHTMLTextGenerator::closeParagraph
void closeParagraph()
Called when a paragraph is closed.
Definition RVNGHTMLTextGenerator.cpp:479
librevenge::RVNGHTMLTextGenerator::closeListElement
void closeListElement()
Called when a list element should be closed.
Definition RVNGHTMLTextGenerator.cpp:609
librevenge::RVNGPropertyList
Definition RVNGPropertyList.h:39
librevenge::RVNGString
UTF-8 string.
Definition RVNGString.h:35
librevenge::RVNGTextInterface
Definition RVNGTextInterface.h:40
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::RVNGHTMLTextGeneratorImpl
the internal state of a html document generator
Definition RVNGHTMLTextGenerator.cpp:247