RVNGTextInterface.h Source File documentation

- Main Page
- Namespaces
- Classes
- Files

- File List
- File Members

RVNGTextInterface.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 * Copyright (C) 2006 Fridrich Strba (fridrich.strba@bluewin.ch)
13 *
14 * For minor contributions see the git repository.
15 *
16 * Alternatively, the contents of this file may be used under the terms
17 * of the GNU Lesser General Public License Version 2.1 or later
18 * (LGPLv2.1+), in which case the provisions of the LGPLv2.1+ are
19 * applicable instead of those above.
20 */
21
22 #ifndef RVNGTEXTINTERFACE_H
23 #define RVNGTEXTINTERFACE_H
24
25 #include "RVNGPropertyList.h"
26 #include "RVNGPropertyListVector.h"
27
28 namespace librevenge
29 {
30
37 class RVNGInputStream;
38
39 class RVNGTextInterface
40 {
41 public:
42 virtual ~RVNGTextInterface() {}
43
99 virtual void setDocumentMetaData(const RVNGPropertyList &propList) = 0;
100
104 virtual void startDocument(const RVNGPropertyList &propList) = 0;
105
109 virtual void endDocument() = 0;
110
111 virtual void definePageStyle(const RVNGPropertyList &propList) = 0;
112
123 virtual void defineEmbeddedFont(const RVNGPropertyList &propList) = 0;
124
139 virtual void openPageSpan(const RVNGPropertyList &propList) = 0;
143 virtual void closePageSpan() = 0;
144
150 virtual void openHeader(const RVNGPropertyList &propList) = 0;
154 virtual void closeHeader() = 0;
155
161 virtual void openFooter(const RVNGPropertyList &propList) = 0;
165 virtual void closeFooter() = 0;
166
167 virtual void defineParagraphStyle(const RVNGPropertyList &propList) = 0;
168
180 virtual void openParagraph(const RVNGPropertyList &propList) = 0;
184 virtual void closeParagraph() = 0;
185
186 virtual void defineCharacterStyle(const RVNGPropertyList &propList) = 0;
187
193 virtual void openSpan(const RVNGPropertyList &propList) = 0;
197 virtual void closeSpan() = 0;
204 virtual void openLink(const RVNGPropertyList &propList) = 0;
208 virtual void closeLink() = 0;
209
210 virtual void defineSectionStyle(const RVNGPropertyList &propList) = 0;
211
224 virtual void openSection(const RVNGPropertyList &propList) = 0;
228 virtual void closeSection() = 0;
229
233 virtual void insertTab() = 0;
237 virtual void insertSpace() = 0;
242 virtual void insertText(const RVNGString &text) = 0;
246 virtual void insertLineBreak() = 0;
247
255 virtual void insertField(const RVNGPropertyList &propList) = 0;
256
269 virtual void openOrderedListLevel(const RVNGPropertyList &propList) = 0;
279 virtual void openUnorderedListLevel(const RVNGPropertyList &propList) = 0;
283 virtual void closeOrderedListLevel() = 0;
287 virtual void closeUnorderedListLevel() = 0;
305 virtual void openListElement(const RVNGPropertyList &propList) = 0;
309 virtual void closeListElement() = 0;
310
316 virtual void openFootnote(const RVNGPropertyList &propList) = 0;
320 virtual void closeFootnote() = 0;
321
327 virtual void openEndnote(const RVNGPropertyList &propList) = 0;
331 virtual void closeEndnote() = 0;
332
337 virtual void openComment(const RVNGPropertyList &propList) = 0;
341 virtual void closeComment() = 0;
342
347 virtual void openTextBox(const RVNGPropertyList &propList) = 0;
351 virtual void closeTextBox() = 0;
352
364 virtual void openTable(const RVNGPropertyList &propList) = 0;
372 virtual void openTableRow(const RVNGPropertyList &propList) = 0;
376 virtual void closeTableRow() = 0;
391 virtual void openTableCell(const RVNGPropertyList &propList) = 0;
395 virtual void closeTableCell() = 0;
402 virtual void insertCoveredTableCell(const RVNGPropertyList &propList) = 0;
406 virtual void closeTable() = 0;
422 virtual void openFrame(const RVNGPropertyList &propList) = 0;
426 virtual void closeFrame() = 0;
437 virtual void insertBinaryObject(const RVNGPropertyList &propList) = 0;
444 virtual void insertEquation(const RVNGPropertyList &propList) = 0;
445
446 // group
447 virtual void openGroup(const librevenge::RVNGPropertyList &propList) = 0;
448 virtual void closeGroup() = 0;
449
450 // Different primitive shapes
451 virtual void defineGraphicStyle(const librevenge::RVNGPropertyList &propList) = 0;
452
453 virtual void drawRectangle(const RVNGPropertyList &propList) = 0;
454 virtual void drawEllipse(const RVNGPropertyList &propList) = 0;
455 virtual void drawPolygon(const RVNGPropertyList &propList) = 0;
456 virtual void drawPolyline(const RVNGPropertyList &propList) = 0;
457 virtual void drawPath(const RVNGPropertyList &propList) = 0;
458
470 virtual void drawConnector(const RVNGPropertyList &propList) = 0;
471 };
472
473 }
474
475 #endif /* RVNGTEXTINTERFACE_H */
476 /* vim:set shiftwidth=4 softtabstop=4 noexpandtab: */
librevenge::RVNGTextInterface::openTextBox
virtual void openTextBox(const RVNGPropertyList &propList)=0
Called when a text box should be opened (a sub-document will be placed inside of it) ...
librevenge::RVNGTextInterface::insertSpace
virtual void insertSpace()=0
Called when an explicit space should be inserted.
librevenge::RVNGTextInterface::openOrderedListLevel
virtual void openOrderedListLevel(const RVNGPropertyList &propList)=0
Called when a new ordered list level should be opened.
librevenge::RVNGTextInterface::openTable
virtual void openTable(const RVNGPropertyList &propList)=0
Called when a table should be opened.
librevenge::RVNGTextInterface::drawPath
virtual void drawPath(const RVNGPropertyList &propList)=0
librevenge::RVNGTextInterface::defineCharacterStyle
virtual void defineCharacterStyle(const RVNGPropertyList &propList)=0
librevenge::RVNGTextInterface::closeTextBox
virtual void closeTextBox()=0
Called when a text box should be closed.
librevenge
Definition: RVNGBinaryData.cpp:38
librevenge::RVNGTextInterface::openPageSpan
virtual void openPageSpan(const RVNGPropertyList &propList)=0
Called when a new page span is opened.
librevenge::RVNGTextInterface::closeFooter
virtual void closeFooter()=0
Called when a footer should be closed.
librevenge::RVNGTextInterface::drawPolygon
virtual void drawPolygon(const RVNGPropertyList &propList)=0
librevenge::RVNGTextInterface::insertText
virtual void insertText(const RVNGString &text)=0
Called when a string of text should be inserted.
librevenge::RVNGTextInterface::openFootnote
virtual void openFootnote(const RVNGPropertyList &propList)=0
Called when a footnote should be opened (a sub-document will be placed inside of it) ...
librevenge::RVNGTextInterface::closeEndnote
virtual void closeEndnote()=0
Called when a endnote should be closed.
librevenge::RVNGTextInterface::closeFootnote
virtual void closeFootnote()=0
Called when a footnote should be closed.
librevenge::RVNGTextInterface::insertField
virtual void insertField(const RVNGPropertyList &propList)=0
Called when a field should be inserted.
librevenge::RVNGTextInterface
Definition: RVNGTextInterface.h:39
librevenge::RVNGTextInterface::openSpan
virtual void openSpan(const RVNGPropertyList &propList)=0
Called when a text span is opened.
librevenge::RVNGTextInterface::defineSectionStyle
virtual void defineSectionStyle(const RVNGPropertyList &propList)=0
librevenge::RVNGTextInterface::closeFrame
virtual void closeFrame()=0
Called when the current positioned box is closed.
librevenge::RVNGTextInterface::definePageStyle
virtual void definePageStyle(const RVNGPropertyList &propList)=0
RVNGPropertyListVector.h
librevenge::RVNGTextInterface::insertCoveredTableCell
virtual void insertCoveredTableCell(const RVNGPropertyList &propList)=0
Called when a covered (spanned by another cell in the table) table cell is opened.
librevenge::RVNGTextInterface::defineGraphicStyle
virtual void defineGraphicStyle(const librevenge::RVNGPropertyList &propList)=0
librevenge::RVNGTextInterface::drawPolyline
virtual void drawPolyline(const RVNGPropertyList &propList)=0
librevenge::RVNGTextInterface::insertEquation
virtual void insertEquation(const RVNGPropertyList &propList)=0
Called when a mathml object should be inserted.
librevenge::RVNGTextInterface::insertBinaryObject
virtual void insertBinaryObject(const RVNGPropertyList &propList)=0
Called when a binary object should be inserted.
librevenge::RVNGTextInterface::openComment
virtual void openComment(const RVNGPropertyList &propList)=0
Called when a comment or annotation should be opened (a sub-document will be placed inside of it) ...
librevenge::RVNGTextInterface::openListElement
virtual void openListElement(const RVNGPropertyList &propList)=0
Called when a list element should be opened.
librevenge::RVNGTextInterface::insertTab
virtual void insertTab()=0
Called when a TAB character should be inserted.
RVNGPropertyList.h
librevenge::RVNGTextInterface::openTableCell
virtual void openTableCell(const RVNGPropertyList &propList)=0
Called when a new table cell is opened.
librevenge::RVNGTextInterface::openUnorderedListLevel
virtual void openUnorderedListLevel(const RVNGPropertyList &propList)=0
Called when a new unordered list level should be opened.
librevenge::RVNGTextInterface::openParagraph
virtual void openParagraph(const RVNGPropertyList &propList)=0
Called when a new paragraph is opened.
librevenge::RVNGTextInterface::defineEmbeddedFont
virtual void defineEmbeddedFont(const RVNGPropertyList &propList)=0
Called when an embedded font should be defined.
librevenge::RVNGTextInterface::drawRectangle
virtual void drawRectangle(const RVNGPropertyList &propList)=0
librevenge::RVNGTextInterface::openEndnote
virtual void openEndnote(const RVNGPropertyList &propList)=0
Called when a endnote should be opened (a sub-document will be placed inside of it) ...
librevenge::RVNGTextInterface::closeTableCell
virtual void closeTableCell()=0
Called when the current table cell is closed.
librevenge::RVNGTextInterface::openTableRow
virtual void openTableRow(const RVNGPropertyList &propList)=0
Called when a new table row is opened.
librevenge::RVNGTextInterface::openLink
virtual void openLink(const RVNGPropertyList &propList)=0
Called when a link should be opened.
librevenge::RVNGTextInterface::closeSection
virtual void closeSection()=0
Called when a section is closed.
librevenge::RVNGTextInterface::openHeader
virtual void openHeader(const RVNGPropertyList &propList)=0
Called when a header should be opened (a sub-document will be placed inside of it).
librevenge::RVNGTextInterface::openFooter
virtual void openFooter(const RVNGPropertyList &propList)=0
Called when a footer should be opened (a sub-document will be placed inside of it).
librevenge::RVNGTextInterface::startDocument
virtual void startDocument(const RVNGPropertyList &propList)=0
Called at the start of the parsing process.
librevenge::RVNGTextInterface::closeParagraph
virtual void closeParagraph()=0
Called when a paragraph is closed.
librevenge::RVNGTextInterface::closeLink
virtual void closeLink()=0
Called when the current link is closed.
librevenge::RVNGTextInterface::closeGroup
virtual void closeGroup()=0
librevenge::RVNGTextInterface::setDocumentMetaData
virtual void setDocumentMetaData(const RVNGPropertyList &propList)=0
Called when all document metadata should be set.
librevenge::RVNGTextInterface::closeTable
virtual void closeTable()=0
Called when the current table is closed.
librevenge::RVNGTextInterface::endDocument
virtual void endDocument()=0
Called at the end of the parsing process.
librevenge::RVNGTextInterface::closeOrderedListLevel
virtual void closeOrderedListLevel()=0
Called when an unordered list level should be closed.
librevenge::RVNGTextInterface::drawEllipse
virtual void drawEllipse(const RVNGPropertyList &propList)=0
librevenge::RVNGTextInterface::closeSpan
virtual void closeSpan()=0
Called when a text span is closed.
librevenge::RVNGTextInterface::openSection
virtual void openSection(const RVNGPropertyList &propList)=0
Called when a new section is opened.
librevenge::RVNGTextInterface::closeHeader
virtual void closeHeader()=0
Called when a header should be closed.
librevenge::RVNGTextInterface::openGroup
virtual void openGroup(const librevenge::RVNGPropertyList &propList)=0
librevenge::RVNGTextInterface::defineParagraphStyle
virtual void defineParagraphStyle(const RVNGPropertyList &propList)=0
librevenge::RVNGTextInterface::closeTableRow
virtual void closeTableRow()=0
Called when the current table row is closed.
librevenge::RVNGTextInterface::openFrame
virtual void openFrame(const RVNGPropertyList &propList)=0
Called when a positioned box should be opened.
librevenge::RVNGTextInterface::closeListElement
virtual void closeListElement()=0
Called when a list element should be closed.
librevenge::RVNGTextInterface::drawConnector
virtual void drawConnector(const RVNGPropertyList &propList)=0
Draw a connector.
librevenge::RVNGTextInterface::insertLineBreak
virtual void insertLineBreak()=0
Called when a line break should be inserted.
librevenge::RVNGTextInterface::~RVNGTextInterface
virtual ~RVNGTextInterface()
Definition: RVNGTextInterface.h:42
librevenge::RVNGTextInterface::closePageSpan
virtual void closePageSpan()=0
Called when a page span is closed.
librevenge::RVNGTextInterface::closeUnorderedListLevel
virtual void closeUnorderedListLevel()=0
Called when an ununordered list level should be closed.
librevenge::RVNGPropertyList
Definition: RVNGPropertyList.h:38
librevenge::RVNGTextInterface::closeComment
virtual void closeComment()=0
Called when a comment or annotation should be closed.
librevenge::RVNGString
Definition: RVNGString.h:31