WPXDocumentInterface.h
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: t; c-basic-offset: 4 -*- */
2 /* libwpd
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  * For further information visit http://libwpd.sourceforge.net
22  */
23 
24 /* "This product is not manufactured, approved, or supported by
25  * Corel Corporation or Corel Corporation Limited."
26  */
27 
28 #ifndef WPXDOCUMENTINTERFACEIMPL_H
29 #define WPXDOCUMENTINTERFACEIMPL_H
30 #include "WPXPropertyList.h"
31 #include "WPXPropertyListVector.h"
32 #include "WPXBinaryData.h"
33 
40 class WPXInputStream;
41 
43 {
44 public:
45  virtual ~WPXDocumentInterface() {}
46 
102  virtual void setDocumentMetaData(const WPXPropertyList &propList) = 0;
103 
107  virtual void startDocument() = 0;
111  virtual void endDocument() = 0;
112 
113  virtual void definePageStyle(const WPXPropertyList &propList) = 0;
114 
129  virtual void openPageSpan(const WPXPropertyList &propList) = 0;
133  virtual void closePageSpan() = 0;
134 
140  virtual void openHeader(const WPXPropertyList &propList) = 0;
144  virtual void closeHeader() = 0;
145 
151  virtual void openFooter(const WPXPropertyList &propList) = 0;
155  virtual void closeFooter() = 0;
156 
157  virtual void defineParagraphStyle(const WPXPropertyList &propList, const WPXPropertyListVector &tabStops) = 0;
158 
176  virtual void openParagraph(const WPXPropertyList &propList, const WPXPropertyListVector &tabStops) = 0;
180  virtual void closeParagraph() = 0;
181 
182  virtual void defineCharacterStyle(const WPXPropertyList &propList) = 0;
183 
200  virtual void openSpan(const WPXPropertyList &propList) = 0;
204  virtual void closeSpan() = 0;
205 
206  virtual void defineSectionStyle(const WPXPropertyList &propList, const WPXPropertyListVector &columns) = 0;
207 
220  virtual void openSection(const WPXPropertyList &propList, const WPXPropertyListVector &columns) = 0;
224  virtual void closeSection() = 0;
225 
229  virtual void insertTab() = 0;
233  virtual void insertSpace() = 0;
238  virtual void insertText(const WPXString &text) = 0;
242  virtual void insertLineBreak() = 0;
243 
251  virtual void insertField(const WPXString &type, const WPXPropertyList &propList) = 0;
252 
265  virtual void defineOrderedListLevel(const WPXPropertyList &propList) = 0;
275  virtual void defineUnorderedListLevel(const WPXPropertyList &propList) = 0;
281  virtual void openOrderedListLevel(const WPXPropertyList &propList) = 0;
287  virtual void openUnorderedListLevel(const WPXPropertyList &propList) = 0;
291  virtual void closeOrderedListLevel() = 0;
295  virtual void closeUnorderedListLevel() = 0;
313  virtual void openListElement(const WPXPropertyList &propList, const WPXPropertyListVector &tabStops) = 0;
317  virtual void closeListElement() = 0;
318 
324  virtual void openFootnote(const WPXPropertyList &propList) = 0;
328  virtual void closeFootnote() = 0;
329 
335  virtual void openEndnote(const WPXPropertyList &propList) = 0;
339  virtual void closeEndnote() = 0;
340 
345  virtual void openComment(const WPXPropertyList &propList) = 0;
349  virtual void closeComment() = 0;
350 
355  virtual void openTextBox(const WPXPropertyList &propList) = 0;
359  virtual void closeTextBox() = 0;
360 
372  virtual void openTable(const WPXPropertyList &propList, const WPXPropertyListVector &columns) = 0;
380  virtual void openTableRow(const WPXPropertyList &propList) = 0;
384  virtual void closeTableRow() = 0;
399  virtual void openTableCell(const WPXPropertyList &propList) = 0;
403  virtual void closeTableCell() = 0;
410  virtual void insertCoveredTableCell(const WPXPropertyList &propList) = 0;
414  virtual void closeTable() = 0;
430  virtual void openFrame(const WPXPropertyList &propList) = 0;
434  virtual void closeFrame() = 0;
441  virtual void insertBinaryObject(const WPXPropertyList &propList, const WPXBinaryData &data) = 0;
448  virtual void insertEquation(const WPXPropertyList &propList, const WPXString &data) = 0;
449 };
450 
451 #endif /* WPXDOCUMENTINTERFACEIMPL_H */
452 /* vim:set shiftwidth=4 softtabstop=4 noexpandtab: */
Definition: WPXString.h:32
virtual void closeFrame()=0
Called when the current positioned box is closed.
virtual ~WPXDocumentInterface()
Definition: WPXDocumentInterface.h:45
virtual void defineCharacterStyle(const WPXPropertyList &propList)=0
virtual void closeFooter()=0
Called when a footer should be closed.
virtual void closeTableCell()=0
Called when the current table cell is closed.
virtual void closeHeader()=0
Called when a header should be closed.
virtual void defineParagraphStyle(const WPXPropertyList &propList, const WPXPropertyListVector &tabStops)=0
virtual void defineSectionStyle(const WPXPropertyList &propList, const WPXPropertyListVector &columns)=0
virtual void defineUnorderedListLevel(const WPXPropertyList &propList)=0
Defines an unordered (unenumerated) list level.
virtual void openListElement(const WPXPropertyList &propList, const WPXPropertyListVector &tabStops)=0
Called when a list element should be opened.
Definition: WPXPropertyList.h:37
virtual void openEndnote(const WPXPropertyList &propList)=0
Called when a endnote should be opened (a sub-document will be placed inside of it) ...
virtual void closeComment()=0
Called when a comment or annotation should be closed.
Definition: WPXPropertyListVector.h:35
virtual void openSection(const WPXPropertyList &propList, const WPXPropertyListVector &columns)=0
Called when a new section is opened.
virtual void closeUnorderedListLevel()=0
Called when an ununordered list level should be closed.
virtual void closeParagraph()=0
Called when a paragraph is closed.
virtual void closeSection()=0
Called when a section is closed.
virtual void openTableRow(const WPXPropertyList &propList)=0
Called when a new table row is opened.
virtual void closeSpan()=0
Called when a text span is closed.
virtual void closeEndnote()=0
Called when a endnote should be closed.
virtual void insertTab()=0
Called when a TAB character should be inserted.
virtual void closeTable()=0
Called when the current table is closed.
virtual void closePageSpan()=0
Called when a page span is closed.
virtual void openFrame(const WPXPropertyList &propList)=0
Called when a positioned box should be opened.
Definition: WPXDocumentInterface.h:42
virtual void openParagraph(const WPXPropertyList &propList, const WPXPropertyListVector &tabStops)=0
Called when a new paragraph is opened.
virtual void definePageStyle(const WPXPropertyList &propList)=0
virtual void closeTextBox()=0
Called when a text box should be closed.
virtual void openFootnote(const WPXPropertyList &propList)=0
Called when a footnote should be opened (a sub-document will be placed inside of it) ...
virtual void endDocument()=0
Called at the end of the parsing process.
virtual void insertSpace()=0
Called when an explicit space should be inserted.
virtual void closeOrderedListLevel()=0
Called when an unordered list level should be closed.
virtual void openTableCell(const WPXPropertyList &propList)=0
Called when a new table cell is opened.
virtual void openSpan(const WPXPropertyList &propList)=0
Called when a text span is opened.
virtual void closeListElement()=0
Called when a list element should be closed.
virtual void closeTableRow()=0
Called when the current table row is closed.
virtual void openComment(const WPXPropertyList &propList)=0
Called when a comment or annotation should be opened (a sub-document will be placed inside of it) ...
virtual void defineOrderedListLevel(const WPXPropertyList &propList)=0
Defines an ordered (enumerated) list level.
virtual void insertEquation(const WPXPropertyList &propList, const WPXString &data)=0
Called when a mathml object should be inserted.
Definition: WPXBinaryData.h:34
virtual void openUnorderedListLevel(const WPXPropertyList &propList)=0
Called when a new unordered list level should be opened.
virtual void closeFootnote()=0
Called when a footnote should be closed.
Definition: WPXStream.h:36
virtual void insertField(const WPXString &type, const WPXPropertyList &propList)=0
Called when a field should be inserted.
virtual void openOrderedListLevel(const WPXPropertyList &propList)=0
Called when a new ordered list level should be opened.
virtual void insertLineBreak()=0
Called when a line break should be inserted.
virtual void setDocumentMetaData(const WPXPropertyList &propList)=0
Called when all document metadata should be set.
virtual void insertCoveredTableCell(const WPXPropertyList &propList)=0
Called when a covered (spanned by another cell in the table) table cell is opened.
virtual void openFooter(const WPXPropertyList &propList)=0
Called when a footer should be opened (a sub-document will be placed inside of it).
virtual void startDocument()=0
Called at the start of the parsing process.
virtual void insertBinaryObject(const WPXPropertyList &propList, const WPXBinaryData &data)=0
Called when a binary object should be inserted.
virtual void openHeader(const WPXPropertyList &propList)=0
Called when a header should be opened (a sub-document will be placed inside of it).
virtual void openTextBox(const WPXPropertyList &propList)=0
Called when a text box should be opened (a sub-document will be placed inside of it) ...
virtual void insertText(const WPXString &text)=0
Called when a string of text should be inserted.
virtual void openTable(const WPXPropertyList &propList, const WPXPropertyListVector &columns)=0
Called when a table should be opened.
virtual void openPageSpan(const WPXPropertyList &propList)=0
Called when a new page span is opened.

Generated for libwpd by doxygen 1.8.5