librevenge::RVNGTextInterface Class Reference documentation

librevenge::RVNGTextInterface Class Referenceabstract

`#include <RVNGTextInterface.h>`

Inheritance diagram for librevenge::RVNGTextInterface:

## Public Member Functions
virtual | ~RVNGTextInterface ()
virtual void | setDocumentMetaData (const RVNGPropertyList &propList)=0
| Called when all document metadata should be set.
virtual void | startDocument (const RVNGPropertyList &propList)=0
| Called at the start of the parsing process.
virtual void | endDocument ()=0
| Called at the end of the parsing process.
virtual void | definePageStyle (const RVNGPropertyList &propList)=0
virtual void | defineEmbeddedFont (const RVNGPropertyList &propList)=0
| Called when an embedded font should be defined.
virtual void | openPageSpan (const RVNGPropertyList &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 RVNGPropertyList &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 RVNGPropertyList &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 | defineParagraphStyle (const RVNGPropertyList &propList)=0
virtual void | openParagraph (const RVNGPropertyList &propList)=0
| Called when a new paragraph is opened.
virtual void | closeParagraph ()=0
| Called when a paragraph is closed.
virtual void | defineCharacterStyle (const RVNGPropertyList &propList)=0
virtual void | openSpan (const RVNGPropertyList &propList)=0
| Called when a text span is opened.
virtual void | closeSpan ()=0
| Called when a text span is closed.
virtual void | openLink (const RVNGPropertyList &propList)=0
| Called when a link should be opened.
virtual void | closeLink ()=0
| Called when the current link is closed.
virtual void | defineSectionStyle (const RVNGPropertyList &propList)=0
virtual void | openSection (const RVNGPropertyList &propList)=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 | insertSpace ()=0
| Called when an explicit space should be inserted.
virtual void | insertText (const RVNGString &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 | insertField (const RVNGPropertyList &propList)=0
| Called when a field should be inserted.
virtual void | openOrderedListLevel (const RVNGPropertyList &propList)=0
| Called when a new ordered list level should be opened.
virtual void | openUnorderedListLevel (const RVNGPropertyList &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 RVNGPropertyList &propList)=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 RVNGPropertyList &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 RVNGPropertyList &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 RVNGPropertyList &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 RVNGPropertyList &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 RVNGPropertyList &propList)=0
| Called when a table should be opened.
virtual void | openTableRow (const RVNGPropertyList &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 RVNGPropertyList &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 RVNGPropertyList &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 RVNGPropertyList &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 RVNGPropertyList &propList)=0
| Called when a binary object should be inserted.
virtual void | insertEquation (const RVNGPropertyList &propList)=0
| Called when a mathml object should be inserted.
virtual void | openGroup (const librevenge::RVNGPropertyList &propList)=0
virtual void | closeGroup ()=0
virtual void | defineGraphicStyle (const librevenge::RVNGPropertyList &propList)=0
virtual void | drawRectangle (const RVNGPropertyList &propList)=0
virtual void | drawEllipse (const RVNGPropertyList &propList)=0
virtual void | drawPolygon (const RVNGPropertyList &propList)=0
virtual void | drawPolyline (const RVNGPropertyList &propList)=0
virtual void | drawPath (const RVNGPropertyList &propList)=0
virtual void | drawConnector (const RVNGPropertyList &propList)=0
| Draw a connector.

## Constructor & Destructor Documentation

## ◆ ~RVNGTextInterface()

virtual librevenge::RVNGTextInterface::~RVNGTextInterface | ( |  | ) |
| inlinevirtual

## Member Function Documentation

## ◆ closeComment()

virtual void librevenge::RVNGTextInterface::closeComment | ( |  | ) |
| pure virtual

Called when a comment or annotation should be closed.

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ closeEndnote()

virtual void librevenge::RVNGTextInterface::closeEndnote | ( |  | ) |
| pure virtual

Called when a endnote should be closed.

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ closeFooter()

virtual void librevenge::RVNGTextInterface::closeFooter | ( |  | ) |
| pure virtual

Called when a footer should be closed.

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ closeFootnote()

virtual void librevenge::RVNGTextInterface::closeFootnote | ( |  | ) |
| pure virtual

Called when a footnote should be closed.

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ closeFrame()

virtual void librevenge::RVNGTextInterface::closeFrame | ( |  | ) |
| pure virtual

Called when the current positioned box is closed.

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ closeGroup()

virtual void librevenge::RVNGTextInterface::closeGroup | ( |  | ) |
| pure virtual

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ closeHeader()

virtual void librevenge::RVNGTextInterface::closeHeader | ( |  | ) |
| pure virtual

Called when a header should be closed.

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ closeLink()

virtual void librevenge::RVNGTextInterface::closeLink | ( |  | ) |
| pure virtual

Called when the current link is closed.

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ closeListElement()

virtual void librevenge::RVNGTextInterface::closeListElement | ( |  | ) |
| pure virtual

Called when a list element should be closed.

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ closeOrderedListLevel()

virtual void librevenge::RVNGTextInterface::closeOrderedListLevel | ( |  | ) |
| pure virtual

Called when an unordered list level should be closed.

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ closePageSpan()

virtual void librevenge::RVNGTextInterface::closePageSpan | ( |  | ) |
| pure virtual

Called when a page span is closed.

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ closeParagraph()

virtual void librevenge::RVNGTextInterface::closeParagraph | ( |  | ) |
| pure virtual

Called when a paragraph is closed.

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ closeSection()

virtual void librevenge::RVNGTextInterface::closeSection | ( |  | ) |
| pure virtual

Called when a section is closed.

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ closeSpan()

virtual void librevenge::RVNGTextInterface::closeSpan | ( |  | ) |
| pure virtual

Called when a text span is closed.

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ closeTable()

virtual void librevenge::RVNGTextInterface::closeTable | ( |  | ) |
| pure virtual

Called when the current table is closed.

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ closeTableCell()

virtual void librevenge::RVNGTextInterface::closeTableCell | ( |  | ) |
| pure virtual

Called when the current table cell is closed.

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ closeTableRow()

virtual void librevenge::RVNGTextInterface::closeTableRow | ( |  | ) |
| pure virtual

Called when the current table row is closed.

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ closeTextBox()

virtual void librevenge::RVNGTextInterface::closeTextBox | ( |  | ) |
| pure virtual

Called when a text box should be closed.

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ closeUnorderedListLevel()

virtual void librevenge::RVNGTextInterface::closeUnorderedListLevel | ( |  | ) |
| pure virtual

Called when an ununordered list level should be closed.

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ defineCharacterStyle()

virtual void librevenge::RVNGTextInterface::defineCharacterStyle | ( | const RVNGPropertyList & | propList | ) |
| pure virtual

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ defineEmbeddedFont()

virtual void librevenge::RVNGTextInterface::defineEmbeddedFont | ( | const RVNGPropertyList & | propList | ) |
| pure virtual

Called when an embedded font should be defined.

Parameters

  propList | A set of properties that specify the font. May contain: `librevenge:name` The name of the font `librevenge:mime-type` The mimetype of the font `office:binary-data` The font data `librevenge:replacement-objects` A property list vector containing alternative formats of the font. Every element is a property list containing: `librevenge:mime-type` The mimetype of the replacement object `office:binary-data` The replacement object data `librevenge:font-style` The font style ("italic" or "normal") `librevenge:font-weight` The font weight ("bold" or "normal")

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ defineGraphicStyle()

virtual void librevenge::RVNGTextInterface::defineGraphicStyle | ( | const librevenge::RVNGPropertyList & | propList | ) |
| pure virtual

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ definePageStyle()

virtual void librevenge::RVNGTextInterface::definePageStyle | ( | const RVNGPropertyList & | propList | ) |
| pure virtual

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ defineParagraphStyle()

virtual void librevenge::RVNGTextInterface::defineParagraphStyle | ( | const RVNGPropertyList & | propList | ) |
| pure virtual

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ defineSectionStyle()

virtual void librevenge::RVNGTextInterface::defineSectionStyle | ( | const RVNGPropertyList & | propList | ) |
| pure virtual

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ drawConnector()

virtual void librevenge::RVNGTextInterface::drawConnector | ( | const RVNGPropertyList & | propList | ) |
| pure virtual

Draw a connector.

The connector will be typically between two shapes, but free-standing connectors are allowed too.

Parameters

  propList | Defines a set of properties for the object. May contain: `draw:end-shape` The `ID` of the shape attached at the end. Should not be present if the connector's end is not attached to any object. `draw:start-shape` The `ID` of the shape attached at the beginning. Should not be present if the connector's start is not attached to any object. `svg:d` The connector's geometric path. This is optional; if missing, the consumer is free to render it any way it likes. `svg:x1` The `X` coordinate of the start point. `svg:y1` The `Y` coordinate of the start point. `svg:x2` The `X` coordinate of the end point. `svg:y2` The `Y` coordinate of the end point.

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ drawEllipse()

virtual void librevenge::RVNGTextInterface::drawEllipse | ( | const RVNGPropertyList & | propList | ) |
| pure virtual

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ drawPath()

virtual void librevenge::RVNGTextInterface::drawPath | ( | const RVNGPropertyList & | propList | ) |
| pure virtual

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ drawPolygon()

virtual void librevenge::RVNGTextInterface::drawPolygon | ( | const RVNGPropertyList & | propList | ) |
| pure virtual

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ drawPolyline()

virtual void librevenge::RVNGTextInterface::drawPolyline | ( | const RVNGPropertyList & | propList | ) |
| pure virtual

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ drawRectangle()

virtual void librevenge::RVNGTextInterface::drawRectangle | ( | const RVNGPropertyList & | propList | ) |
| pure virtual

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ endDocument()

virtual void librevenge::RVNGTextInterface::endDocument | ( |  | ) |
| pure virtual

Called at the end of the parsing process.

This is always the last callback made.

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ insertBinaryObject()

virtual void librevenge::RVNGTextInterface::insertBinaryObject | ( | const RVNGPropertyList & | propList | ) |
| pure virtual

Called when a binary object should be inserted.

Parameters

  propList | Defines a set of properties for the object. May contain: `librevenge:mime-type` The mimetype of the object `office:binary-data` The object data `librevenge:replacement-objects` A property list vector containing alternative representations of the content. Every element is a property list containing: `librevenge:mime-type` The mimetype of the replacement object `office:binary-data` The replacement object data `librevenge:replacement-text` A string containing a text representation of the content.

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ insertCoveredTableCell()

virtual void librevenge::RVNGTextInterface::insertCoveredTableCell | ( | const RVNGPropertyList & | propList | ) |
| pure virtual

Called when a covered (spanned by another cell in the table) table cell is opened.

Parameters

  propList | Property list for the table cell. May contain: `librevenge:column` Number of the column in which the cell is positioned `librevenge:row` Number of the row in which the cell is positioned

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ insertEquation()

virtual void librevenge::RVNGTextInterface::insertEquation | ( | const RVNGPropertyList & | propList | ) |
| pure virtual

Called when a mathml object should be inserted.

Parameters

  propList | Defines a set of properties for the object. `librevenge:mime-type` The mimetype of the object ; its value may be "application/mathml-presentation+xml" or "application/mathml+xml" `librevenge:data` reference to the string containing the equation representation

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ insertField()

virtual void librevenge::RVNGTextInterface::insertField | ( | const RVNGPropertyList & | propList | ) |
| pure virtual

Called when a field should be inserted.

Field types may include:

- `librevenge:field-type` field types may include:
  1. `text:page-number` Current page number
  2. `text:page-count` Total # of pages in document
- `style:num-format` Type of page number (for page number)

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ insertLineBreak()

virtual void librevenge::RVNGTextInterface::insertLineBreak | ( |  | ) |
| pure virtual

Called when a line break should be inserted.

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ insertSpace()

virtual void librevenge::RVNGTextInterface::insertSpace | ( |  | ) |
| pure virtual

Called when an explicit space should be inserted.

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ insertTab()

virtual void librevenge::RVNGTextInterface::insertTab | ( |  | ) |
| pure virtual

Called when a TAB character should be inserted.

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ insertText()

virtual void librevenge::RVNGTextInterface::insertText | ( | const RVNGString & | text | ) |
| pure virtual

Called when a string of text should be inserted.

Parameters

  text | A textbuffer encoded as a UTF8 string

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ openComment()

virtual void librevenge::RVNGTextInterface::openComment | ( | const RVNGPropertyList & | propList | ) |
| pure virtual

Called when a comment or annotation should be opened (a sub-document will be placed inside of it).

Parameters

  propList | Defines a set of properties for the comment or annotation.

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ openEndnote()

virtual void librevenge::RVNGTextInterface::openEndnote | ( | const RVNGPropertyList & | propList | ) |
| pure virtual

Called when a endnote should be opened (a sub-document will be placed inside of it).

Parameters

  propList | Defines a set of properties for the endnote. May contain: `librevenge:number` The endnote's number

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ openFooter()

virtual void librevenge::RVNGTextInterface::openFooter | ( | const RVNGPropertyList & | propList | ) |
| pure virtual

Called when a footer should be opened (a sub-document will be placed inside of it).

Parameters

  propList | Property list for the footer. May contain: `librevenge:occurrence` Determines on which pages the footer will occur (odd, even, or all)

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ openFootnote()

virtual void librevenge::RVNGTextInterface::openFootnote | ( | const RVNGPropertyList & | propList | ) |
| pure virtual

Called when a footnote should be opened (a sub-document will be placed inside of it).

Parameters

  propList | Defines a set of properties for the footnote. May contain: `librevenge:number` The footnote's number

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ openFrame()

virtual void librevenge::RVNGTextInterface::openFrame | ( | const RVNGPropertyList & | propList | ) |
| pure virtual

Called when a positioned box should be opened.

Parameters

  propList | Defines a set of properties for the box. May contain: `text:anchor-type` How the Box is anchored (page, frame, paragraph, char, as-char) `svg:x` Horizontal position of the box (in inches) `svg:y` Vertical position of the box (in inches) `style:horizontal-pos` Horizontal alignment of the box (left, center, right, from-left, inside, outside, from-inside) `style:horizontal-rel` From where the horizontal position of the box is measured (page, page-content, page-start-margin, page-end-margin, frame, frame-content, frame-start-margin, frame-end-margin, paragraph, paragraph-content, paragraph-start-margin, paragraph-end-margin, char) `style:vertical-pos` Vertical alignment of the box `style:vertical-rel` From where the vertical position of the box is measured `svg:width` Width of the box (in inches) `style:relative-width` If the width should scale to keep the width/height ratio of the original object, this property is set to "scale". `svg:height` Height of the box (in inches) `style:relative-height` If the height should scale to keep the width/height ratio of the original object, this property is set to "scale".

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ openGroup()

virtual void librevenge::RVNGTextInterface::openGroup | ( | const librevenge::RVNGPropertyList & | propList | ) |
| pure virtual

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ openHeader()

virtual void librevenge::RVNGTextInterface::openHeader | ( | const RVNGPropertyList & | propList | ) |
| pure virtual

Called when a header should be opened (a sub-document will be placed inside of it).

Parameters

  propList | Property list for the header. May contain: `librevenge:occurrence` Determines on which pages the header will occur (odd, even, or all)

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ openLink()

virtual void librevenge::RVNGTextInterface::openLink | ( | const RVNGPropertyList & | propList | ) |
| pure virtual

Called when a link should be opened.

Parameters

  propList | Defines a set of properties for the link. May contain: `xlink:type` . `xlink:href` . `office:binary-data` The data of the linked content when xlink:href is omitted. `librevenge:mime-type` The mimetype of the linked content when xlink:href is omitted.

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ openListElement()

virtual void librevenge::RVNGTextInterface::openListElement | ( | const RVNGPropertyList & | propList | ) |
| pure virtual

Called when a list element should be opened.

Parameters

  propList | Property list for the paragraph. May contain: `fo:text-align` The justification of this paragraph (left, center, end, full, or justify) `fo:margin-left` The left indentation of this paragraph, in inches `fo:margin-right` The right indentation of this paragraph, in inches `fo:margin-top` The amount of extra spacing to be placed before the paragraph, in inches `fo:margin-bottom` The amount of extra spacing to be placed after the paragraph, in inches `fo:text-indent` The indentation of first line, in inches (difference relative to margin-left) `fo:line-height` The amount of spacing between lines, in number of lines (1.0 is single spacing) `fo:break-before` Whether this paragraph should be placed in a new column or page (the value is set to column or page if so) `librevenge:tab-stops` List of tabstop definitions for the paragraph. If the list is empty, default tabstop definition should be used. Each tab stop may contain: `style:type` Type of tab (left, right, center, or char) `style:char` Alingnment character for char aligned tabs `style:leader-text` The leader character `style:position` Position of the tab

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ openOrderedListLevel()

virtual void librevenge::RVNGTextInterface::openOrderedListLevel | ( | const RVNGPropertyList & | propList | ) |
| pure virtual

Called when a new ordered list level should be opened.

Parameters

  propList | Defines a set of properties for the list level. May contain: `librevenge:list-id` A unique integer identifier for the list `librevenge:level` The level of the list in the hierarchy `style:num-format` Type of list `style:num-prefix` Text that comes before the number in the list `style:num-suffix` Text that comes after the number in the list `text:start-value` The starting number of the list `text:min-label-width` The distance between the list label and the actual text, stored in inches `text:space-before` The indentation level of the lists, stored in inches

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ openPageSpan()

virtual void librevenge::RVNGTextInterface::openPageSpan | ( | const RVNGPropertyList & | 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.

Parameters

  propList | Property list for the page span. May contain: `librevenge:num-pages` The length of this span, in number of pages `librevenge:is-last-page-span` Whether this is the start of the last page span in the document `fo:page-width` The width of the page, in inches `fo:page-height` The height of the page, in inches `style:print-orientation` The orientation of the page (portrait or landscape) `fo:margin-left` The left margin for each page in the span, in inches `fo:margin-right` The right margin for each page in the span, in inches `fo:margin-top` The top margin for each page in the span, in inches `fo:margin-bottom` The bottom margin for each page in the span, in inches `librevenge:chapter-names` A property list vector containing starting chapters. Every element is a property list containing: `librevenge:name` The title of the chapter

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ openParagraph()

virtual void librevenge::RVNGTextInterface::openParagraph | ( | const RVNGPropertyList & | propList | ) |
| 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.

Parameters

  propList | Property list for the paragraph. May contain: `fo:text-align` The justification of this paragraph (left, center, end, full, or justify) `fo:margin-left` The left indentation of this paragraph, in inches `fo:margin-right` The right indentation of this paragraph, in inches `fo:margin-top` The amount of extra spacing to be placed before the paragraph, in inches `fo:margin-bottom` The amount of extra spacing to be placed after the paragraph, in inches `fo:text-indent` The indentation of first line, in inches (difference relative to margin-left) `fo:line-height` The amount of spacing between lines, in number of lines (1.0 is single spacing) `fo:break-before` Whether this paragraph should be placed in a new column or page (the value is set to column or page if so) `text:outline-level` The level of a heading represented by this paragraph. `librevenge:tab-stops` List of tabstop definitions for the paragraph. If the list is empty, default tabstop definition should be used. Each tab stop may contain: `style:type` Type of tab (left, right, center, or char) `style:char` Alingnment character for char aligned tabs `style:leader-text` The leader character `style:position` Position of the tab

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ openSection()

virtual void librevenge::RVNGTextInterface::openSection | ( | const RVNGPropertyList & | propList | ) |
| pure virtual

Called when a new section is opened.

Parameters

  propList | Property list for the section. May contain: `fo:margin-left` The left indentation of this section, in inches `fo:margin-right` The right indentation of this section, in inches `librevenge:margin-bottom` Extra space to add after the section, in inches `text:dont-balance-text-columns` Whether or not to balance text columns `style: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: `style:rel-width` `fo:start-indent` The left indentation of the margin, in inches `fo:end-indent` The right indentation of the margin, in inches

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ openSpan()

virtual void librevenge::RVNGTextInterface::openSpan | ( | const RVNGPropertyList & | propList | ) |
| pure virtual

Called when a text span is opened.

Parameters

  propList | Property list for the span. May contain: `fo:font-style` Font style (italic or normal) `fo:font-weight` Font style (bold or normal) `style:text-line-through-type` (none, double or single, if present) `style:text-line-through-style` (solid, dotted, dash, long-dash, dot-dash, dot-dot-dash or wave, if present) `style:text-underline-type` (none, double or single, if present) `style:text-underline-style` (solid, dotted, dash, long-dash, dot-dash, dot-dot-dash or wave, if present) `style:text-outline` (true or false) `fo:font-variant` (small-caps, if present) `style:font-name` The name of the font used in the span, a text string in ascii `fo:font-size` The size of the font used in the span, in points (72 points per inch) `fo:color` The color of the font used in the span (encoded in hex: #RRGGBB) `fo:background-color` The background color of the text in the span (encoded in hex: #RRGGBB) `style:text-blinking` Whether the text should blink (true or false) `fo:text-shadow\n` `fo:language\n` \ The language of the text in the span, a valid language code according to ISO 639

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ openTable()

virtual void librevenge::RVNGTextInterface::openTable | ( | const RVNGPropertyList & | propList | ) |
| pure virtual

Called when a table should be opened.

Parameters

  propList | Defines a set of properties for the table. May contain: `table:align` The alignment (left, right, center, or margins) `fo:margin-left` The left indentation of the table, in inches `fo:margin-right` The right indentation of the table, in inches `style:width` Total width of the table, in inches `style:rel-width` Total relative width of the table, in percents `fo:break-before` Whether this table should be placed in a new column or page (the value is set to column or page if so) `librevenge:table-columns` Column definitions for the table. May contain `style:column-width` Width of a column, in inches `style:rel-column-width` Relative width of a column, in ODF format

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ openTableCell()

virtual void librevenge::RVNGTextInterface::openTableCell | ( | const RVNGPropertyList & | propList | ) |
| pure virtual

Called when a new table cell is opened.

Parameters

  propList | Property list for the table cell. May contain: `librevenge:column` Number of the column in which the cell is positioned `librevenge:row` Number of the row in which the cell is positioned `table:number-columns-spanned` Number of columns that the cell spans `table:number-rows-spanned` Number of rows that the cell spans `fo:border-left` Properties of the left border of the cell `fo:border-right` Properties of the right border of the cell `fo:border-top` Properties of the top border of the cell `fo:border-bottom` Properties of the bottom border of the cell `fo:background-color` Color of the cell (encoded in hex: #RRGGBB) `style:vertical-align` Vertical alignment of the content in the cell (top, middle, or bottom)

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ openTableRow()

virtual void librevenge::RVNGTextInterface::openTableRow | ( | const RVNGPropertyList & | propList | ) |
| pure virtual

Called when a new table row is opened.

Parameters

  propList | Defines a set of properties for the table row. May contain: `style:row-height` The row's height, in inches `style:min-row-height` The row's minimum height, in inches `librevenge:is-header-row` This row contains headings of columns and should repeat at every page (for tables that span several pages)

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ openTextBox()

virtual void librevenge::RVNGTextInterface::openTextBox | ( | const RVNGPropertyList & | propList | ) |
| pure virtual

Called when a text box should be opened (a sub-document will be placed inside of it).

Parameters

  propList | Defines a set of properties for the text box.

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ openUnorderedListLevel()

virtual void librevenge::RVNGTextInterface::openUnorderedListLevel | ( | const RVNGPropertyList & | propList | ) |
| pure virtual

Called when a new unordered list level should be opened.

Parameters

  propList | Defines a set of properties for the list level. May contain: `librevenge:list-id` A unique integer identifier for the list `librevenge:level` The level of the list in the hierarchy `text:bullet-char` The string that should be used as a bullet `text:min-label-width` The distance between the bullet and the actual text, stored in inches `text:space-before` The indentation level of the lists, stored in inches

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ setDocumentMetaData()

virtual void librevenge::RVNGTextInterface::setDocumentMetaData | ( | const RVNGPropertyList & | propList | ) |
| pure virtual

Called when all document metadata should be set.

This is always the first callback made.

Parameters

  propList | Property list for the metadata. May contain: `dc:creator` `dc:identifier` The document's unique identifier `dc:language` The document's keywords `dc:publisher` The document's publisher `dc:source` `dc:subject` The document's subject `dc:type` The document's type `dcterms:available` Date when the document was completed `dcterms:issued:` Date of the version of the document `librevenge:abstract` Abstract of the document's contents `librevenge:account` Account `librevenge:address` Address `librevenge:attachments` `librevenge:authorization` `librevenge:bill-to` `librevenge:blind-copy` `librevenge:carbon-copy` `librevenge:checked-by` `librevenge:client` `librevenge:comments` `librevenge:department` `librevenge:descriptive-name` The descriptive name for the document `librevenge:descriptive-type` The descriptive type for the document `librevenge:destination` `librevenge:disposition` `librevenge:division` `librevenge:document-number` `librevenge:editor` `librevenge:forward-to` `librevenge:group` `librevenge:mail-stop` `librevenge:matter` `librevenge:office` `librevenge:owner` `librevenge:project` `librevenge:purpose` `librevenge:received-from` `librevenge:recorded-by` `librevenge:recorded-date` Date when the document was recorded `librevenge:reference` `librevenge:revision-notes` `librevenge:revision-number` `librevenge:section` `librevenge:security` `librevenge:status` `librevenge:telephone-number` `librevenge:version-notes` `librevenge:version-number` `meta:creation-date` Document creation date `meta:initial-creator` The document's author `meta:keyword` The document's keywords `librevenge:cover-images` List of cover image definitions for the document. The list typically contains one item. Each cover image may contain: `librevenge:mime-type` The mimetype of the image `office:binary-data` The image data

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

## ◆ startDocument()

virtual void librevenge::RVNGTextInterface::startDocument | ( | const RVNGPropertyList & | propList | ) |
| pure virtual

Called at the start of the parsing process.

This is always the second callback made.

Implemented in librevenge::RVNGDummyTextGenerator, librevenge::RVNGHTMLTextGenerator, librevenge::RVNGRawTextGenerator, and librevenge::RVNGTextTextGenerator.

The documentation for this class was generated from the following file:

- RVNGTextInterface.h