RVNGSpreadsheetInterface.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 RVNGSPREADSHEETINTERFACE_H
23 #define RVNGSPREADSHEETINTERFACE_H
24
25 #include "RVNGString.h"
26 #include "RVNGPropertyList.h"
27 #include "RVNGPropertyListVector.h"
28
29 namespace librevenge
30 {
31
49 class RVNGSpreadsheetInterface
50 {
51 public:
52
53
55 virtual ~RVNGSpreadsheetInterface() {}
56
112 virtual void setDocumentMetaData(const RVNGPropertyList &propList) = 0;
113
117 virtual void startDocument(const RVNGPropertyList &propList) = 0;
121 virtual void endDocument() = 0;
122
123 virtual void definePageStyle(const RVNGPropertyList &propList) = 0;
124
135 virtual void defineEmbeddedFont(const RVNGPropertyList &propList) = 0;
136
151 virtual void openPageSpan(const RVNGPropertyList &propList) = 0;
155 virtual void closePageSpan() = 0;
156
162 virtual void openHeader(const RVNGPropertyList &propList) = 0;
166 virtual void closeHeader() = 0;
167
173 virtual void openFooter(const RVNGPropertyList &propList) = 0;
177 virtual void closeFooter() = 0;
178
179
190 virtual void defineSheetNumberingStyle(const RVNGPropertyList &propList) = 0;
198 virtual void openSheet(const RVNGPropertyList &propList) = 0;
202 virtual void closeSheet() = 0;
210 virtual void openSheetRow(const RVNGPropertyList &propList) = 0;
214 virtual void closeSheetRow() = 0;
228 virtual void openSheetCell(const RVNGPropertyList &propList) = 0;
232 virtual void closeSheetCell() = 0;
233
234 virtual void defineChartStyle(const RVNGPropertyList &propList) = 0;
235
241 virtual void openChart(const RVNGPropertyList &propList) = 0;
245 virtual void closeChart() = 0;
246
250 virtual void openChartTextObject(const RVNGPropertyList &propList) = 0;
254 virtual void closeChartTextObject() = 0;
255
259 virtual void openChartPlotArea(const RVNGPropertyList &propList) = 0;
263 virtual void closeChartPlotArea() = 0;
267 virtual void insertChartAxis(const RVNGPropertyList &axis) = 0;
271 virtual void openChartSerie(const librevenge::RVNGPropertyList &series) = 0;
275 virtual void closeChartSerie() = 0;
276
277 virtual void defineParagraphStyle(const RVNGPropertyList &propList) = 0;
278
289 virtual void openParagraph(const RVNGPropertyList &propList) = 0;
293 virtual void closeParagraph() = 0;
294
295 virtual void defineCharacterStyle(const RVNGPropertyList &propList) = 0;
296
303 virtual void openSpan(const RVNGPropertyList &propList) = 0;
307 virtual void closeSpan() = 0;
314 virtual void openLink(const RVNGPropertyList &propList) = 0;
318 virtual void closeLink() = 0;
319
320 virtual void defineSectionStyle(const RVNGPropertyList &propList) = 0;
321
334 virtual void openSection(const RVNGPropertyList &propList) = 0;
338 virtual void closeSection() = 0;
339
343 virtual void insertTab() = 0;
347 virtual void insertSpace() = 0;
352 virtual void insertText(const RVNGString &text) = 0;
356 virtual void insertLineBreak() = 0;
357
365 virtual void insertField(const RVNGPropertyList &propList) = 0;
366
379 virtual void openOrderedListLevel(const RVNGPropertyList &propList) = 0;
389 virtual void openUnorderedListLevel(const RVNGPropertyList &propList) = 0;
393 virtual void closeOrderedListLevel() = 0;
397 virtual void closeUnorderedListLevel() = 0;
415 virtual void openListElement(const RVNGPropertyList &propList) = 0;
419 virtual void closeListElement() = 0;
420
426 virtual void openFootnote(const RVNGPropertyList &propList) = 0;
430 virtual void closeFootnote() = 0;
431
436 virtual void openComment(const RVNGPropertyList &propList) = 0;
440 virtual void closeComment() = 0;
441
457 virtual void openFrame(const RVNGPropertyList &propList) = 0;
461 virtual void closeFrame() = 0;
472 virtual void insertBinaryObject(const RVNGPropertyList &propList) = 0;
473
474 //
475 // specific text
476 //
477
482 virtual void openTextBox(const RVNGPropertyList &propList) = 0;
486 virtual void closeTextBox() = 0;
487
499 virtual void openTable(const RVNGPropertyList &propList) = 0;
507 virtual void openTableRow(const RVNGPropertyList &propList) = 0;
511 virtual void closeTableRow() = 0;
526 virtual void openTableCell(const RVNGPropertyList &propList) = 0;
530 virtual void closeTableCell() = 0;
537 virtual void insertCoveredTableCell(const RVNGPropertyList &propList) = 0;
541 virtual void closeTable() = 0;
542
543 //
544 // simple Graphic
545 //
546
547 virtual void openGroup(const RVNGPropertyList &propList) = 0;
548 virtual void closeGroup() = 0;
549
550 virtual void defineGraphicStyle(const RVNGPropertyList &propList) = 0;
551
552 // Different primitive shapes
553 virtual void drawRectangle(const RVNGPropertyList &propList) = 0;
554
555 virtual void drawEllipse(const RVNGPropertyList &propList) = 0;
556
557 virtual void drawPolygon(const RVNGPropertyList &propList) = 0;
558
559 virtual void drawPolyline(const RVNGPropertyList &propList) = 0;
560
561 virtual void drawPath(const RVNGPropertyList &propList) = 0;
562
574 virtual void drawConnector(const RVNGPropertyList &propList) = 0;
575
576 //
577 // Equation
578 //
579
586 virtual void insertEquation(const RVNGPropertyList &propList) = 0;
587 };
588 }
589
590 #endif /* DI_SPREADSHEET_INTERFACE_HXX */
591 /* vim:set shiftwidth=4 softtabstop=4 noexpandtab: */
librevenge::RVNGSpreadsheetInterface::insertChartAxis
virtual void insertChartAxis(const RVNGPropertyList &axis)=0
Called when a axis should be add in a plot area
librevenge::RVNGSpreadsheetInterface::closeParagraph
virtual void closeParagraph()=0
Called when a paragraph is closed.
librevenge::RVNGSpreadsheetInterface::insertLineBreak
virtual void insertLineBreak()=0
Called when a line break should be inserted
librevenge::RVNGSpreadsheetInterface::closeTableRow
virtual void closeTableRow()=0
Called when the current table row is closed
librevenge::RVNGSpreadsheetInterface::drawPath
virtual void drawPath(const RVNGPropertyList &propList)=0
librevenge::RVNGSpreadsheetInterface::defineSectionStyle
virtual void defineSectionStyle(const RVNGPropertyList &propList)=0
librevenge::RVNGSpreadsheetInterface::closeUnorderedListLevel
virtual void closeUnorderedListLevel()=0
Called when an ununordered list level should be closed
librevenge::RVNGSpreadsheetInterface::closeGroup
virtual void closeGroup()=0
librevenge::RVNGSpreadsheetInterface::definePageStyle
virtual void definePageStyle(const RVNGPropertyList &propList)=0
librevenge::RVNGSpreadsheetInterface::insertSpace
virtual void insertSpace()=0
Called when an explicit space should be inserted
librevenge::RVNGSpreadsheetInterface::closeComment
virtual void closeComment()=0
Called when a comment or annotation should be closed
librevenge
Definition: RVNGBinaryData.cpp:38
librevenge::RVNGSpreadsheetInterface::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::RVNGSpreadsheetInterface::closeChart
virtual void closeChart()=0
Called when a chart should be closed.
librevenge::RVNGSpreadsheetInterface::closeTableCell
virtual void closeTableCell()=0
Called when the current table cell is closed
librevenge::RVNGSpreadsheetInterface::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::RVNGSpreadsheetInterface::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::RVNGSpreadsheetInterface
Pure virtual class containing all the callback functions that can be made by a spreadsheet parser...
Definition: RVNGSpreadsheetInterface.h:49
librevenge::RVNGSpreadsheetInterface::openOrderedListLevel
virtual void openOrderedListLevel(const RVNGPropertyList &propList)=0
Called when a new ordered list level should be opened
librevenge::RVNGSpreadsheetInterface::openChart
virtual void openChart(const RVNGPropertyList &propList)=0
Called when a chart should be opened
librevenge::RVNGSpreadsheetInterface::openFrame
virtual void openFrame(const RVNGPropertyList &propList)=0
Called when a positioned box should be opened
librevenge::RVNGSpreadsheetInterface::startDocument
virtual void startDocument(const RVNGPropertyList &propList)=0
Called at the start of the parsing process.
librevenge::RVNGSpreadsheetInterface::closeChartPlotArea
virtual void closeChartPlotArea()=0
Called when a chart plot arre should be closed.
librevenge::RVNGSpreadsheetInterface::openGroup
virtual void openGroup(const RVNGPropertyList &propList)=0
librevenge::RVNGSpreadsheetInterface::closeTable
virtual void closeTable()=0
Called when the current table is closed
librevenge::RVNGSpreadsheetInterface::defineCharacterStyle
virtual void defineCharacterStyle(const RVNGPropertyList &propList)=0
librevenge::RVNGSpreadsheetInterface::openChartTextObject
virtual void openChartTextObject(const RVNGPropertyList &propList)=0
Called when a chart text zone:label/legend/title/subtitle/footer should be opened.
librevenge::RVNGSpreadsheetInterface::closeSheetCell
virtual void closeSheetCell()=0
Called when a sheet should be closed.
librevenge::RVNGSpreadsheetInterface::insertField
virtual void insertField(const RVNGPropertyList &propList)=0
Called when a field should be inserted.
librevenge::RVNGSpreadsheetInterface::openSheetCell
virtual void openSheetCell(const RVNGPropertyList &propList)=0
Called when a cell should be opened
librevenge::RVNGSpreadsheetInterface::closeChartSerie
virtual void closeChartSerie()=0
Called when a serie should be closed (in a plot area)
RVNGPropertyListVector.h
librevenge::RVNGSpreadsheetInterface::openUnorderedListLevel
virtual void openUnorderedListLevel(const RVNGPropertyList &propList)=0
Called when a new unordered list level should be opened
librevenge::RVNGSpreadsheetInterface::drawConnector
virtual void drawConnector(const RVNGPropertyList &propList)=0
Draw a connector.
RVNGString.h
librevenge::RVNGSpreadsheetInterface::closeFooter
virtual void closeFooter()=0
Called when a footer should be closed.
librevenge::RVNGSpreadsheetInterface::defineSheetNumberingStyle
virtual void defineSheetNumberingStyle(const RVNGPropertyList &propList)=0
Called when a numbering style must be defined
librevenge::RVNGSpreadsheetInterface::openSection
virtual void openSection(const RVNGPropertyList &propList)=0
Called when a new section is opened
librevenge::RVNGSpreadsheetInterface::defineEmbeddedFont
virtual void defineEmbeddedFont(const RVNGPropertyList &propList)=0
Called when an embedded font should be defined
librevenge::RVNGSpreadsheetInterface::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::RVNGSpreadsheetInterface::openTableCell
virtual void openTableCell(const RVNGPropertyList &propList)=0
Called when a new table cell is opened
librevenge::RVNGSpreadsheetInterface::closeTextBox
virtual void closeTextBox()=0
Called when a text box should be closed
RVNGPropertyList.h
librevenge::RVNGSpreadsheetInterface::closeListElement
virtual void closeListElement()=0
Called when a list element should be closed
librevenge::RVNGSpreadsheetInterface::openChartPlotArea
virtual void openChartPlotArea(const RVNGPropertyList &propList)=0
Called when a chart plot area should be opened.
librevenge::RVNGSpreadsheetInterface::setDocumentMetaData
virtual void setDocumentMetaData(const RVNGPropertyList &propList)=0
Called when all document metadata should be set.
librevenge::RVNGSpreadsheetInterface::closeLink
virtual void closeLink()=0
Called when the current link is closed
librevenge::RVNGSpreadsheetInterface::closeSpan
virtual void closeSpan()=0
Called when a text span is closed
librevenge::RVNGSpreadsheetInterface::defineParagraphStyle
virtual void defineParagraphStyle(const RVNGPropertyList &propList)=0
librevenge::RVNGSpreadsheetInterface::openTable
virtual void openTable(const RVNGPropertyList &propList)=0
Called when a table should be opened
librevenge::RVNGSpreadsheetInterface::insertEquation
virtual void insertEquation(const RVNGPropertyList &propList)=0
Called when a mathml object should be inserted
librevenge::RVNGSpreadsheetInterface::openSpan
virtual void openSpan(const RVNGPropertyList &propList)=0
Called when a text span is opened
librevenge::RVNGSpreadsheetInterface::openSheetRow
virtual void openSheetRow(const RVNGPropertyList &propList)=0
Called when a new sheet row is opened
librevenge::RVNGSpreadsheetInterface::drawPolyline
virtual void drawPolyline(const RVNGPropertyList &propList)=0
librevenge::RVNGSpreadsheetInterface::insertText
virtual void insertText(const RVNGString &text)=0
Called when a string of text should be inserted
librevenge::RVNGSpreadsheetInterface::openListElement
virtual void openListElement(const RVNGPropertyList &propList)=0
Called when a list element should be opened
librevenge::RVNGSpreadsheetInterface::openTableRow
virtual void openTableRow(const RVNGPropertyList &propList)=0
Called when a new table row is opened
librevenge::RVNGSpreadsheetInterface::closeFootnote
virtual void closeFootnote()=0
Called when a footnote should be closed
librevenge::RVNGSpreadsheetInterface::closeSheetRow
virtual void closeSheetRow()=0
Called when a sheet row should be closed.
librevenge::RVNGSpreadsheetInterface::insertBinaryObject
virtual void insertBinaryObject(const RVNGPropertyList &propList)=0
Called when a binary object should be inserted
librevenge::RVNGSpreadsheetInterface::endDocument
virtual void endDocument()=0
Called at the end of the parsing process.
librevenge::RVNGSpreadsheetInterface::closeHeader
virtual void closeHeader()=0
Called when a header should be closed.
librevenge::RVNGSpreadsheetInterface::insertCoveredTableCell
virtual void insertCoveredTableCell(const RVNGPropertyList &propList)=0
Called when a covered (spanned by another cell in the table) table cell is opened ...
librevenge::RVNGSpreadsheetInterface::openChartSerie
virtual void openChartSerie(const librevenge::RVNGPropertyList &series)=0
Called when a serie should be opened (in a plot area)
librevenge::RVNGSpreadsheetInterface::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::RVNGSpreadsheetInterface::closeChartTextObject
virtual void closeChartTextObject()=0
Called when a chart text zone:legend/title/subtitle/footer should be closed.
librevenge::RVNGSpreadsheetInterface::openLink
virtual void openLink(const RVNGPropertyList &propList)=0
Called when a link should be opened
librevenge::RVNGSpreadsheetInterface::closePageSpan
virtual void closePageSpan()=0
Called when a page span is closed.
librevenge::RVNGSpreadsheetInterface::drawRectangle
virtual void drawRectangle(const RVNGPropertyList &propList)=0
librevenge::RVNGSpreadsheetInterface::~RVNGSpreadsheetInterface
virtual ~RVNGSpreadsheetInterface()
destructor
Definition: RVNGSpreadsheetInterface.h:55
librevenge::RVNGSpreadsheetInterface::defineChartStyle
virtual void defineChartStyle(const RVNGPropertyList &propList)=0
librevenge::RVNGSpreadsheetInterface::drawEllipse
virtual void drawEllipse(const RVNGPropertyList &propList)=0
librevenge::RVNGSpreadsheetInterface::closeFrame
virtual void closeFrame()=0
Called when the current positioned box is closed
librevenge::RVNGSpreadsheetInterface::closeSection
virtual void closeSection()=0
Called when a section is closed
librevenge::RVNGPropertyList
Definition: RVNGPropertyList.h:38
librevenge::RVNGSpreadsheetInterface::openPageSpan
virtual void openPageSpan(const RVNGPropertyList &propList)=0
Called when a new page span is opened.
librevenge::RVNGSpreadsheetInterface::closeOrderedListLevel
virtual void closeOrderedListLevel()=0
Called when an unordered list level should be closed
librevenge::RVNGString
UTF-8 string.
Definition: RVNGString.h:33
librevenge::RVNGSpreadsheetInterface::drawPolygon
virtual void drawPolygon(const RVNGPropertyList &propList)=0
librevenge::RVNGSpreadsheetInterface::openParagraph
virtual void openParagraph(const RVNGPropertyList &propList)=0
Called when a new paragraph is opened.
librevenge::RVNGSpreadsheetInterface::closeSheet
virtual void closeSheet()=0
Called when a sheet should be closed.
librevenge::RVNGSpreadsheetInterface::insertTab
virtual void insertTab()=0
Called when a TAB character should be inserted
librevenge::RVNGSpreadsheetInterface::defineGraphicStyle
virtual void defineGraphicStyle(const RVNGPropertyList &propList)=0
librevenge::RVNGSpreadsheetInterface::openSheet
virtual void openSheet(const RVNGPropertyList &propList)=0
Called when a sheet should be opened