#include <WPXDocumentInterface.h>
Public Member Functions | |
virtual | ~WPXDocumentInterface () |
virtual void | setDocumentMetaData (const WPXPropertyList &propList)=0 |
Called when all document metadata should be set. | |
virtual void | startDocument ()=0 |
Called at the start of the parsing process. | |
virtual void | endDocument ()=0 |
Called at the end of the parsing process. | |
virtual void | openPageSpan (const WPXPropertyList &propList)=0 |
Called when a new page span is opened. | |
virtual void | closePageSpan ()=0 |
Called when a page span is closed. | |
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 | closeHeader ()=0 |
Called when a header should be closed. | |
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 | closeFooter ()=0 |
Called when a footer should be closed. | |
virtual void | openParagraph (const WPXPropertyList &propList, const WPXPropertyListVector &tabStops)=0 |
Called when a new paragraph is opened. | |
virtual void | closeParagraph ()=0 |
Called when a paragraph is closed. | |
virtual void | openSpan (const WPXPropertyList &propList)=0 |
Called when a text span is opened. | |
virtual void | closeSpan ()=0 |
Called when a text span is closed. | |
virtual void | openSection (const WPXPropertyList &propList, const WPXPropertyListVector &columns)=0 |
Called when a new section is opened. | |
virtual void | closeSection ()=0 |
Called when a section is closed. | |
virtual void | insertTab ()=0 |
Called when a TAB character should be inserted. | |
virtual void | insertText (const WPXString &text)=0 |
Called when a string of text should be inserted. | |
virtual void | insertLineBreak ()=0 |
Called when a line break should be inserted. | |
virtual void | defineOrderedListLevel (const WPXPropertyList &propList)=0 |
Defines an ordered (enumerated) list level. | |
virtual void | defineUnorderedListLevel (const WPXPropertyList &propList)=0 |
Defines an unordered (unenumerated) list level. | |
virtual void | openOrderedListLevel (const WPXPropertyList &propList)=0 |
Called when a new ordered list level should be opened. | |
virtual void | openUnorderedListLevel (const WPXPropertyList &propList)=0 |
Called when a new unordered list level should be opened. | |
virtual void | closeOrderedListLevel ()=0 |
Called when an unordered list level should be closed. | |
virtual void | closeUnorderedListLevel ()=0 |
Called when an ununordered list level should be closed. | |
virtual void | openListElement (const WPXPropertyList &propList, const WPXPropertyListVector &tabStops)=0 |
Called when a list element should be opened. | |
virtual void | closeListElement ()=0 |
Called when a list element 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 | closeFootnote ()=0 |
Called when a footnote should be closed. | |
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 | closeEndnote ()=0 |
Called when a endnote should be 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 | closeComment ()=0 |
Called when a comment or annotation should be closed. | |
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 | closeTextBox ()=0 |
Called when a text box should be closed. | |
virtual void | openTable (const WPXPropertyList &propList, const WPXPropertyListVector &columns)=0 |
Called when a table should be opened. | |
virtual void | openTableRow (const WPXPropertyList &propList)=0 |
Called when a new table row is opened. | |
virtual void | closeTableRow ()=0 |
Called when the current table row is closed. | |
virtual void | openTableCell (const WPXPropertyList &propList)=0 |
Called when a new table cell is opened. | |
virtual void | closeTableCell ()=0 |
Called when the current table cell is closed. | |
virtual void | insertCoveredTableCell (const WPXPropertyList &propList)=0 |
Called when a covered (spanned by another cell in the table) table cell is opened. | |
virtual void | closeTable ()=0 |
Called when the current table is closed. | |
virtual void | openFrame (const WPXPropertyList &propList)=0 |
Called when a positioned box should be opened. | |
virtual void | closeFrame ()=0 |
Called when the current positioned box is closed. | |
virtual void | insertBinaryObject (const WPXPropertyList &propList, const WPXBinaryData &data)=0 |
Called when a binary object should be inserted. |
virtual WPXDocumentInterface::~WPXDocumentInterface | ( | ) | [inline, virtual] |
virtual void WPXDocumentInterface::setDocumentMetaData | ( | const WPXPropertyList & | propList | ) | [pure virtual] |
Called when all document metadata should be set.
This is always the first callback made.
propList | Property list for the metadata. May contain:
|
virtual void WPXDocumentInterface::startDocument | ( | ) | [pure virtual] |
Called at the start of the parsing process.
This is always the second callback made.
virtual void WPXDocumentInterface::endDocument | ( | ) | [pure virtual] |
Called at the end of the parsing process.
This is always the last callback made.
virtual void WPXDocumentInterface::openPageSpan | ( | const WPXPropertyList & | propList | ) | [pure virtual] |
Called when a new page span is opened.
This will always be called before any actual content is placed into the document.
propList | Property list for the page span. May contain:
|
virtual void WPXDocumentInterface::closePageSpan | ( | ) | [pure virtual] |
Called when a page span is closed.
virtual void WPXDocumentInterface::openHeader | ( | const WPXPropertyList & | propList | ) | [pure virtual] |
Called when a header should be opened (a sub-document will be placed inside of it).
propList | Property list for the header. May contain:
|
virtual void WPXDocumentInterface::closeHeader | ( | ) | [pure virtual] |
Called when a header should be closed.
virtual void WPXDocumentInterface::openFooter | ( | const WPXPropertyList & | propList | ) | [pure virtual] |
Called when a footer should be opened (a sub-document will be placed inside of it).
propList | Property list for the footer. May contain:
|
virtual void WPXDocumentInterface::closeFooter | ( | ) | [pure virtual] |
Called when a footer should be closed.
virtual void WPXDocumentInterface::openParagraph | ( | const WPXPropertyList & | propList, | |
const WPXPropertyListVector & | tabStops | |||
) | [pure virtual] |
Called when a new paragraph is opened.
This (or openListElement) will always be called before any text or span is placed into the document.
propList | Property list for the paragraph. May contain:
| |
tabStops | List of tabstop definitions for the paragraph. If the list is empty, default tabstop definition should be used. Each tab stop may contain:
|
virtual void WPXDocumentInterface::closeParagraph | ( | ) | [pure virtual] |
Called when a paragraph is closed.
virtual void WPXDocumentInterface::openSpan | ( | const WPXPropertyList & | propList | ) | [pure virtual] |
Called when a text span is opened.
propList | Property list for the span. May contain:
|
virtual void WPXDocumentInterface::closeSpan | ( | ) | [pure virtual] |
Called when a text span is closed.
virtual void WPXDocumentInterface::openSection | ( | const WPXPropertyList & | propList, | |
const WPXPropertyListVector & | columns | |||
) | [pure virtual] |
Called when a new section is opened.
propList | Property list for the section. May contain:
| |
columns | List of definitions of each column: left gutter, right gutter, and width (includes the gutters). Empty if there is only one column in the section. Each column may contain:
|
virtual void WPXDocumentInterface::closeSection | ( | ) | [pure virtual] |
Called when a section is closed.
virtual void WPXDocumentInterface::insertTab | ( | ) | [pure virtual] |
Called when a TAB character should be inserted.
virtual void WPXDocumentInterface::insertText | ( | const WPXString & | text | ) | [pure virtual] |
Called when a string of text should be inserted.
text | A textbuffer encoded as a UTF8 string |
virtual void WPXDocumentInterface::insertLineBreak | ( | ) | [pure virtual] |
Called when a line break should be inserted.
virtual void WPXDocumentInterface::defineOrderedListLevel | ( | const WPXPropertyList & | propList | ) | [pure virtual] |
Defines an ordered (enumerated) list level.
propList | Defines a set of properties for the list. May contain:
|
virtual void WPXDocumentInterface::defineUnorderedListLevel | ( | const WPXPropertyList & | propList | ) | [pure virtual] |
Defines an unordered (unenumerated) list level.
propList | Defines a set of properties for the list level. May contain:
|
virtual void WPXDocumentInterface::openOrderedListLevel | ( | const WPXPropertyList & | propList | ) | [pure virtual] |
Called when a new ordered list level should be opened.
propList | Defines a set of properties for the list level. May contain:
|
virtual void WPXDocumentInterface::openUnorderedListLevel | ( | const WPXPropertyList & | propList | ) | [pure virtual] |
Called when a new unordered list level should be opened.
propList | Defines a set of properties for the list level. May contain:
|
virtual void WPXDocumentInterface::closeOrderedListLevel | ( | ) | [pure virtual] |
Called when an unordered list level should be closed.
virtual void WPXDocumentInterface::closeUnorderedListLevel | ( | ) | [pure virtual] |
Called when an ununordered list level should be closed.
virtual void WPXDocumentInterface::openListElement | ( | const WPXPropertyList & | propList, | |
const WPXPropertyListVector & | tabStops | |||
) | [pure virtual] |
Called when a list element should be opened.
propList | Property list for the paragraph. May contain:
| |
tabStops | List of tabstop definitions for the paragraph. If the list is empty, default tabstop definition should be used. Each tab stop may contain:
|
virtual void WPXDocumentInterface::closeListElement | ( | ) | [pure virtual] |
Called when a list element should be closed.
virtual void WPXDocumentInterface::openFootnote | ( | const WPXPropertyList & | propList | ) | [pure virtual] |
Called when a footnote should be opened (a sub-document will be placed inside of it).
propList | Defines a set of properties for the footnote. May contain:
|
virtual void WPXDocumentInterface::closeFootnote | ( | ) | [pure virtual] |
Called when a footnote should be closed.
virtual void WPXDocumentInterface::openEndnote | ( | const WPXPropertyList & | propList | ) | [pure virtual] |
Called when a endnote should be opened (a sub-document will be placed inside of it).
propList | Defines a set of properties for the endnote. May contain:
|
virtual void WPXDocumentInterface::closeEndnote | ( | ) | [pure virtual] |
Called when a endnote should be closed.
virtual void WPXDocumentInterface::openComment | ( | const WPXPropertyList & | propList | ) | [pure virtual] |
Called when a comment or annotation should be opened (a sub-document will be placed inside of it).
propList | Defines a set of properties for the comment or annotation. |
virtual void WPXDocumentInterface::closeComment | ( | ) | [pure virtual] |
Called when a comment or annotation should be closed.
virtual void WPXDocumentInterface::openTextBox | ( | const WPXPropertyList & | propList | ) | [pure virtual] |
Called when a text box should be opened (a sub-document will be placed inside of it).
propList | Defines a set of properties for the text box. |
virtual void WPXDocumentInterface::closeTextBox | ( | ) | [pure virtual] |
Called when a text box should be closed.
virtual void WPXDocumentInterface::openTable | ( | const WPXPropertyList & | propList, | |
const WPXPropertyListVector & | columns | |||
) | [pure virtual] |
Called when a table should be opened.
propList | Defines a set of properties for the table. May contain:
| |
columns | Column definitions for the table. May contain
|
virtual void WPXDocumentInterface::openTableRow | ( | const WPXPropertyList & | propList | ) | [pure virtual] |
Called when a new table row is opened.
propList | Defines a set of properties for the table row. May contain:
|
virtual void WPXDocumentInterface::closeTableRow | ( | ) | [pure virtual] |
Called when the current table row is closed.
virtual void WPXDocumentInterface::openTableCell | ( | const WPXPropertyList & | propList | ) | [pure virtual] |
Called when a new table cell is opened.
propList | Property list for the table cell. May contain:
|
virtual void WPXDocumentInterface::closeTableCell | ( | ) | [pure virtual] |
Called when the current table cell is closed.
virtual void WPXDocumentInterface::insertCoveredTableCell | ( | const WPXPropertyList & | propList | ) | [pure virtual] |
virtual void WPXDocumentInterface::closeTable | ( | ) | [pure virtual] |
Called when the current table is closed.
virtual void WPXDocumentInterface::openFrame | ( | const WPXPropertyList & | propList | ) | [pure virtual] |
Called when a positioned box should be opened.
propList | Defines a set of properties for the box. May contain:
|
virtual void WPXDocumentInterface::closeFrame | ( | ) | [pure virtual] |
Called when the current positioned box is closed.
virtual void WPXDocumentInterface::insertBinaryObject | ( | const WPXPropertyList & | propList, | |
const WPXBinaryData & | data | |||
) | [pure virtual] |
Called when a binary object should be inserted.
propList | Defines a set of properties for the object. May contain:
| |
data | Reference to the binary object |