librevenge::RVNGCSVSpreadsheetGenerator Class Reference

A CSV generator for spreadsheet documents. More...

#include <RVNGCSVSpreadsheetGenerator.h>

Inheritance diagram for librevenge::RVNGCSVSpreadsheetGenerator:
librevenge::RVNGSpreadsheetInterface

Public Member Functions

 RVNGCSVSpreadsheetGenerator (RVNGStringVector &sheets, bool generateFormula=false)
 constructor given:
 ~RVNGCSVSpreadsheetGenerator ()
 destructor
void setSeparators (char fieldSep=',', char textSep='"', char decimalSep='.')
 set the separators:
void setDTFormats (RVNGString const &date="%m/%d/%y", RVNGString const &time="%H:%M:%S")
 defines the format used to export the date and the time (see strftime)
void setDocumentMetaData (const RVNGPropertyList &propList)
 Called when all document metadata should be set.
void defineEmbeddedFont (const RVNGPropertyList &propList)
 Called when an embedded font should be defined.
void startDocument (const RVNGPropertyList &propList)
 Called at the start of the parsing process.
void endDocument ()
 Called at the end of the parsing process.
void defineSheetNumberingStyle (const RVNGPropertyList &propList)
 Called when a numbering style must be defined.
void openSheet (const RVNGPropertyList &propList)
 Called when a sheet should be opened.
void closeSheet ()
 Called when a sheet should be closed.
void openSheetRow (const RVNGPropertyList &propList)
 Called when a new sheet row is opened.
void closeSheetRow ()
 Called when a sheet row should be closed.
void openSheetCell (const RVNGPropertyList &propList)
 Called when a cell should be opened.
void closeSheetCell ()
 Called when a sheet should be closed.
void defineChartStyle (const RVNGPropertyList &propList)
void openChart (const RVNGPropertyList &propList)
 Called when a chart should be opened.
void closeChart ()
 Called when a chart should be closed.
void openChartTextObject (const RVNGPropertyList &propList)
 Called when a chart text zone:label/legend/title/subtitle/footer should be opened.
void closeChartTextObject ()
 Called when a chart text zone:legend/title/subtitle/footer should be closed.
void openChartPlotArea (const RVNGPropertyList &propList)
 Called when a chart plot area should be opened.
void closeChartPlotArea ()
 Called when a chart plot arre should be closed.
void insertChartAxis (const RVNGPropertyList &axis)
 Called when a axis should be add in a plot area.
void openChartSerie (const librevenge::RVNGPropertyList &series)
 Called when a serie should be opened (in a plot area)
void closeChartSerie ()
 Called when a serie should be closed (in a plot area)
void definePageStyle (const RVNGPropertyList &propList)
void openPageSpan (const RVNGPropertyList &propList)
 Called when a new page span is opened.
void closePageSpan ()
 Called when a page span is closed.
void openHeader (const RVNGPropertyList &propList)
 Called when a header should be opened (a sub-document will be placed inside of it).
void closeHeader ()
 Called when a header should be closed.
void openFooter (const RVNGPropertyList &propList)
 Called when a footer should be opened (a sub-document will be placed inside of it).
void closeFooter ()
 Called when a footer should be closed.
void defineParagraphStyle (const RVNGPropertyList &propList)
void openParagraph (const RVNGPropertyList &propList)
 Called when a new paragraph is opened.
void closeParagraph ()
 Called when a paragraph is closed.
void defineCharacterStyle (const RVNGPropertyList &propList)
void openSpan (const RVNGPropertyList &propList)
 Called when a text span is opened.
void closeSpan ()
 Called when a text span is closed.
void openLink (const RVNGPropertyList &propList)
 Called when a link should be opened.
void closeLink ()
 Called when the current link is closed.
void defineSectionStyle (const RVNGPropertyList &propList)
void openSection (const RVNGPropertyList &propList)
 Called when a new section is opened.
void closeSection ()
 Called when a section is closed.
void insertTab ()
 Called when a TAB character should be inserted.
void insertSpace ()
 Called when an explicit space should be inserted.
void insertText (const RVNGString &text)
 Called when a string of text should be inserted.
void insertLineBreak ()
 Called when a line break should be inserted.
void insertField (const RVNGPropertyList &propList)
 Called when a field should be inserted.
void openOrderedListLevel (const RVNGPropertyList &propList)
 Called when a new ordered list level should be opened.
void openUnorderedListLevel (const RVNGPropertyList &propList)
 Called when a new unordered list level should be opened.
void closeOrderedListLevel ()
 Called when an unordered list level should be closed.
void closeUnorderedListLevel ()
 Called when an ununordered list level should be closed.
void openListElement (const RVNGPropertyList &propList)
 Called when a list element should be opened.
void closeListElement ()
 Called when a list element should be closed.
void openFootnote (const RVNGPropertyList &propList)
 Called when a footnote should be opened (a sub-document will be placed inside of it)
void closeFootnote ()
 Called when a footnote should be closed.
void openEndnote (const RVNGPropertyList &propList)
void closeEndnote ()
void openComment (const RVNGPropertyList &propList)
 Called when a comment or annotation should be opened (a sub-document will be placed inside of it)
void closeComment ()
 Called when a comment or annotation should be closed.
void openTextBox (const RVNGPropertyList &propList)
 Called when a text box should be opened (a sub-document will be placed inside of it)
void closeTextBox ()
 Called when a text box should be closed.
void openTable (const RVNGPropertyList &propList)
 Called when a table should be opened.
void openTableRow (const RVNGPropertyList &propList)
 Called when a new table row is opened.
void closeTableRow ()
 Called when the current table row is closed.
void openTableCell (const RVNGPropertyList &propList)
 Called when a new table cell is opened.
void closeTableCell ()
 Called when the current table cell is closed.
void insertCoveredTableCell (const RVNGPropertyList &propList)
 Called when a covered (spanned by another cell in the table) table cell is opened.
void closeTable ()
 Called when the current table is closed.
void openFrame (const RVNGPropertyList &propList)
 Called when a positioned box should be opened.
void closeFrame ()
 Called when the current positioned box is closed.
void insertBinaryObject (const RVNGPropertyList &propList)
 Called when a binary object should be inserted.
void openGroup (const RVNGPropertyList &propList)
void closeGroup ()
void defineGraphicStyle (const RVNGPropertyList &propList)
void drawRectangle (const RVNGPropertyList &propList)
void drawEllipse (const RVNGPropertyList &propList)
void drawPolygon (const RVNGPropertyList &propList)
void drawPolyline (const RVNGPropertyList &propList)
void drawPath (const RVNGPropertyList &propList)
void drawConnector (const RVNGPropertyList &propList)
 Draw a connector.
void insertEquation (const RVNGPropertyList &propList)
 Called when a mathml object should be inserted.
Public Member Functions inherited from librevenge::RVNGSpreadsheetInterface
virtual ~RVNGSpreadsheetInterface ()
 destructor

Private Member Functions

 RVNGCSVSpreadsheetGenerator (const RVNGCSVSpreadsheetGenerator &other)
 unimplemented copy constructor to prevent copy
RVNGCSVSpreadsheetGenerator & operator= (const RVNGCSVSpreadsheetGenerator &other)
 unimplemented copy operator to prevent copy

Private Attributes

RVNGCSVSpreadsheetGeneratorImpl * m_impl
 the internal storage data

Detailed Description

A CSV generator for spreadsheet documents.

See librevenge::RVNGSpreadsheetInterface for documentation of the basic interface.

Constructor & Destructor Documentation

◆ RVNGCSVSpreadsheetGenerator() [1/2]

librevenge::RVNGCSVSpreadsheetGenerator::RVNGCSVSpreadsheetGenerator ( const RVNGCSVSpreadsheetGenerator & other)
private

unimplemented copy constructor to prevent copy

Referenced by operator=(), and RVNGCSVSpreadsheetGenerator().

◆ RVNGCSVSpreadsheetGenerator() [2/2]

librevenge::RVNGCSVSpreadsheetGenerator::RVNGCSVSpreadsheetGenerator ( RVNGStringVector & sheets,
bool generateFormula = false )
explicit

constructor given:

  • sheets a vector of string to fill
  • generateFormula a flag to known if we need to generate the formula or not
Note
if generateFormula is true, the formula will be generated with english name, so a localized version of Excel, ... will not recognize them

◆ ~RVNGCSVSpreadsheetGenerator()

librevenge::RVNGCSVSpreadsheetGenerator::~RVNGCSVSpreadsheetGenerator ( )

destructor

Member Function Documentation

◆ closeChart()

void librevenge::RVNGCSVSpreadsheetGenerator::closeChart ( )
virtual

Called when a chart should be closed.

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ closeChartPlotArea()

void librevenge::RVNGCSVSpreadsheetGenerator::closeChartPlotArea ( )
virtual

Called when a chart plot arre should be closed.

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ closeChartSerie()

void librevenge::RVNGCSVSpreadsheetGenerator::closeChartSerie ( )
virtual

Called when a serie should be closed (in a plot area)

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ closeChartTextObject()

void librevenge::RVNGCSVSpreadsheetGenerator::closeChartTextObject ( )
virtual

Called when a chart text zone:legend/title/subtitle/footer should be closed.

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ closeComment()

void librevenge::RVNGCSVSpreadsheetGenerator::closeComment ( )
virtual

Called when a comment or annotation should be closed.

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ closeEndnote()

void librevenge::RVNGCSVSpreadsheetGenerator::closeEndnote ( )

Referenced by operator=().

◆ closeFooter()

void librevenge::RVNGCSVSpreadsheetGenerator::closeFooter ( )
virtual

Called when a footer should be closed.

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ closeFootnote()

void librevenge::RVNGCSVSpreadsheetGenerator::closeFootnote ( )
virtual

Called when a footnote should be closed.

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ closeFrame()

void librevenge::RVNGCSVSpreadsheetGenerator::closeFrame ( )
virtual

Called when the current positioned box is closed.

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ closeGroup()

void librevenge::RVNGCSVSpreadsheetGenerator::closeGroup ( )
virtual

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ closeHeader()

void librevenge::RVNGCSVSpreadsheetGenerator::closeHeader ( )
virtual

Called when a header should be closed.

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ closeLink()

void librevenge::RVNGCSVSpreadsheetGenerator::closeLink ( )
virtual

Called when the current link is closed.

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ closeListElement()

void librevenge::RVNGCSVSpreadsheetGenerator::closeListElement ( )
virtual

Called when a list element should be closed.

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ closeOrderedListLevel()

void librevenge::RVNGCSVSpreadsheetGenerator::closeOrderedListLevel ( )
virtual

Called when an unordered list level should be closed.

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ closePageSpan()

void librevenge::RVNGCSVSpreadsheetGenerator::closePageSpan ( )
virtual

Called when a page span is closed.

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ closeParagraph()

void librevenge::RVNGCSVSpreadsheetGenerator::closeParagraph ( )
virtual

Called when a paragraph is closed.

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ closeSection()

void librevenge::RVNGCSVSpreadsheetGenerator::closeSection ( )
virtual

Called when a section is closed.

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ closeSheet()

void librevenge::RVNGCSVSpreadsheetGenerator::closeSheet ( )
virtual

Called when a sheet should be closed.

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ closeSheetCell()

void librevenge::RVNGCSVSpreadsheetGenerator::closeSheetCell ( )
virtual

Called when a sheet should be closed.

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ closeSheetRow()

void librevenge::RVNGCSVSpreadsheetGenerator::closeSheetRow ( )
virtual

Called when a sheet row should be closed.

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ closeSpan()

void librevenge::RVNGCSVSpreadsheetGenerator::closeSpan ( )
virtual

Called when a text span is closed.

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ closeTable()

void librevenge::RVNGCSVSpreadsheetGenerator::closeTable ( )
virtual

Called when the current table is closed.

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ closeTableCell()

void librevenge::RVNGCSVSpreadsheetGenerator::closeTableCell ( )
virtual

Called when the current table cell is closed.

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ closeTableRow()

void librevenge::RVNGCSVSpreadsheetGenerator::closeTableRow ( )
virtual

Called when the current table row is closed.

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ closeTextBox()

void librevenge::RVNGCSVSpreadsheetGenerator::closeTextBox ( )
virtual

Called when a text box should be closed.

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ closeUnorderedListLevel()

void librevenge::RVNGCSVSpreadsheetGenerator::closeUnorderedListLevel ( )
virtual

Called when an ununordered list level should be closed.

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ defineCharacterStyle()

void librevenge::RVNGCSVSpreadsheetGenerator::defineCharacterStyle ( const RVNGPropertyList & propList)
virtual

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ defineChartStyle()

void librevenge::RVNGCSVSpreadsheetGenerator::defineChartStyle ( const RVNGPropertyList & propList)
virtual

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ defineEmbeddedFont()

void librevenge::RVNGCSVSpreadsheetGenerator::defineEmbeddedFont ( const RVNGPropertyList & propList)
virtual

Called when an embedded font should be defined.

Parameters
propListA 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:
    1. librevenge:mime-type The mimetype of the replacement object
    2. office:binary-data The replacement object data

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ defineGraphicStyle()

void librevenge::RVNGCSVSpreadsheetGenerator::defineGraphicStyle ( const RVNGPropertyList & propList)
virtual

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ definePageStyle()

void librevenge::RVNGCSVSpreadsheetGenerator::definePageStyle ( const RVNGPropertyList & propList)
virtual

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ defineParagraphStyle()

void librevenge::RVNGCSVSpreadsheetGenerator::defineParagraphStyle ( const RVNGPropertyList & propList)
virtual

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ defineSectionStyle()

void librevenge::RVNGCSVSpreadsheetGenerator::defineSectionStyle ( const RVNGPropertyList & propList)
virtual

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ defineSheetNumberingStyle()

void librevenge::RVNGCSVSpreadsheetGenerator::defineSheetNumberingStyle ( const RVNGPropertyList & propList)
virtual

Called when a numbering style must be defined.

Parameters
propListProperty list for the style. Must contain:
  • librevenge:name the numbering style name
  • librevenge:value_type the numbering type
  • librevenge:format a vector containing a list of format instructions
  • librevenge:conditions a vector containing
    1. librevenge:formula the condition
    2. librevenge:name the style to apply when the condition is verified

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ drawConnector()

void librevenge::RVNGCSVSpreadsheetGenerator::drawConnector ( const RVNGPropertyList & propList)
virtual

Draw a connector.

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

Parameters
propListDefines 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.

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ drawEllipse()

void librevenge::RVNGCSVSpreadsheetGenerator::drawEllipse ( const RVNGPropertyList & propList)
virtual

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ drawPath()

void librevenge::RVNGCSVSpreadsheetGenerator::drawPath ( const RVNGPropertyList & propList)
virtual

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ drawPolygon()

void librevenge::RVNGCSVSpreadsheetGenerator::drawPolygon ( const RVNGPropertyList & propList)
virtual

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ drawPolyline()

void librevenge::RVNGCSVSpreadsheetGenerator::drawPolyline ( const RVNGPropertyList & propList)
virtual

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ drawRectangle()

void librevenge::RVNGCSVSpreadsheetGenerator::drawRectangle ( const RVNGPropertyList & propList)
virtual

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ endDocument()

void librevenge::RVNGCSVSpreadsheetGenerator::endDocument ( )
virtual

Called at the end of the parsing process.

This is always the last callback made.

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ insertBinaryObject()

void librevenge::RVNGCSVSpreadsheetGenerator::insertBinaryObject ( const RVNGPropertyList & propList)
virtual

Called when a binary object should be inserted.

Parameters
propListDefines 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:
    1. librevenge:mime-type The mimetype of the replacement object
    2. office:binary-data The replacement object data
  • librevenge:replacement-text A string containing a text representation of the content.

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ insertChartAxis()

void librevenge::RVNGCSVSpreadsheetGenerator::insertChartAxis ( const RVNGPropertyList & axis)
virtual

Called when a axis should be add in a plot area.

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ insertCoveredTableCell()

void librevenge::RVNGCSVSpreadsheetGenerator::insertCoveredTableCell ( const RVNGPropertyList & propList)
virtual

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

Parameters
propListProperty 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

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ insertEquation()

void librevenge::RVNGCSVSpreadsheetGenerator::insertEquation ( const RVNGPropertyList & propList)
virtual

Called when a mathml object should be inserted.

Parameters
propListDefines 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

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ insertField()

void librevenge::RVNGCSVSpreadsheetGenerator::insertField ( const RVNGPropertyList & propList)
virtual

Called when a field should be inserted.

  • 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)

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ insertLineBreak()

void librevenge::RVNGCSVSpreadsheetGenerator::insertLineBreak ( )
virtual

Called when a line break should be inserted.

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ insertSpace()

void librevenge::RVNGCSVSpreadsheetGenerator::insertSpace ( )
virtual

Called when an explicit space should be inserted.

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ insertTab()

void librevenge::RVNGCSVSpreadsheetGenerator::insertTab ( )
virtual

Called when a TAB character should be inserted.

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ insertText()

void librevenge::RVNGCSVSpreadsheetGenerator::insertText ( const RVNGString & text)
virtual

Called when a string of text should be inserted.

Parameters
textA textbuffer encoded as a UTF8 string

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ openChart()

void librevenge::RVNGCSVSpreadsheetGenerator::openChart ( const RVNGPropertyList & propList)
virtual

Called when a chart should be opened.

Parameters
propListProperty list for the sheet. May contain:
  • librevenge:name Determines the sheet name

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ openChartPlotArea()

void librevenge::RVNGCSVSpreadsheetGenerator::openChartPlotArea ( const RVNGPropertyList & propList)
virtual

Called when a chart plot area should be opened.

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ openChartSerie()

void librevenge::RVNGCSVSpreadsheetGenerator::openChartSerie ( const librevenge::RVNGPropertyList & series)
virtual

Called when a serie should be opened (in a plot area)

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ openChartTextObject()

void librevenge::RVNGCSVSpreadsheetGenerator::openChartTextObject ( const RVNGPropertyList & propList)
virtual

Called when a chart text zone:label/legend/title/subtitle/footer should be opened.

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ openComment()

void librevenge::RVNGCSVSpreadsheetGenerator::openComment ( const RVNGPropertyList & propList)
virtual

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

Parameters
propListDefines a set of properties for the comment or annotation.

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ openEndnote()

void librevenge::RVNGCSVSpreadsheetGenerator::openEndnote ( const RVNGPropertyList & propList)

Referenced by operator=().

◆ openFooter()

void librevenge::RVNGCSVSpreadsheetGenerator::openFooter ( const RVNGPropertyList & propList)
virtual

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

Parameters
propListProperty list for the footer. May contain:
  • librevenge:occurrence Determines on which pages the footer will occur (odd, even, or all)

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ openFootnote()

void librevenge::RVNGCSVSpreadsheetGenerator::openFootnote ( const RVNGPropertyList & propList)
virtual

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

Parameters
propListDefines a set of properties for the footnote. May contain:
  • librevenge:number The footnote's number

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ openFrame()

void librevenge::RVNGCSVSpreadsheetGenerator::openFrame ( const RVNGPropertyList & propList)
virtual

Called when a positioned box should be opened.

Parameters
propListDefines 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".

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ openGroup()

void librevenge::RVNGCSVSpreadsheetGenerator::openGroup ( const RVNGPropertyList & propList)
virtual

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ openHeader()

void librevenge::RVNGCSVSpreadsheetGenerator::openHeader ( const RVNGPropertyList & propList)
virtual

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

Parameters
propListProperty list for the header. May contain:
  • librevenge:occurrence Determines on which pages the header will occur (odd, even, or all)

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ openLink()

void librevenge::RVNGCSVSpreadsheetGenerator::openLink ( const RVNGPropertyList & propList)
virtual

Called when a link should be opened.

Parameters
propListDefines a set of properties for the link. May contain:
  • xlink:type .
  • xlink:href .

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ openListElement()

void librevenge::RVNGCSVSpreadsheetGenerator::openListElement ( const RVNGPropertyList & propList)
virtual

Called when a list element should be opened.

Parameters
propListProperty 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:
    1. style:type Type of tab (left, right, center, or char)
    2. style:char Alingnment character for char aligned tabs
    3. style:leader-text The leader character
    4. style:position Position of the tab

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ openOrderedListLevel()

void librevenge::RVNGCSVSpreadsheetGenerator::openOrderedListLevel ( const RVNGPropertyList & propList)
virtual

Called when a new ordered list level should be opened.

Parameters
propListDefines 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

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ openPageSpan()

void librevenge::RVNGCSVSpreadsheetGenerator::openPageSpan ( const RVNGPropertyList & propList)
virtual

Called when a new page span is opened.

This will always be called before any actual content is placed into the document.

Parameters
propListProperty 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

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ openParagraph()

void librevenge::RVNGCSVSpreadsheetGenerator::openParagraph ( const RVNGPropertyList & propList)
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
propListProperty 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:
    1. style:type Type of tab (left, right, center, or char)
    2. style:char Alingnment character for char aligned tabs
    3. style:leader-text The leader character
    4. style:position Position of the tab

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ openSection()

void librevenge::RVNGCSVSpreadsheetGenerator::openSection ( const RVNGPropertyList & propList)
virtual

Called when a new section is opened.

Parameters
propListProperty 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:
    1. style:rel-width
    2. fo:start-indent The left indentation of the margin, in inches
    3. fo:end-indent The right indentation of the margin, in inches

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ openSheet()

void librevenge::RVNGCSVSpreadsheetGenerator::openSheet ( const RVNGPropertyList & propList)
virtual

Called when a sheet should be opened.

Parameters
propListProperty list for the sheet. May contain:
  • librevenge:name Determines the sheet name
  • librevenge:columns a vector of property list which must contain:
    1. style:column-width: the width of a column, in inches

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ openSheetCell()

void librevenge::RVNGCSVSpreadsheetGenerator::openSheetCell ( const RVNGPropertyList & propList)
virtual

Called when a cell should be opened.

Parameters
propListProperty list for the sheet. May contain:
  • librevenge:column the cell column (between 0 and ... )
  • librevenge:row the cell row (between 0 and ... )
  • librevenge:formula a formula
  • librevenge:numbering-name a numbering style name
  • librevenge:double for a number cell
  • librevenge:bool for a boolean cell
  • librevenge:year, librevenge:month, librevenge:day, librevenge:hour, libwp:minute, librevenge:second for a date and/or time cell

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ openSheetRow()

void librevenge::RVNGCSVSpreadsheetGenerator::openSheetRow ( const RVNGPropertyList & propList)
virtual

Called when a new sheet row is opened.

Parameters
propListDefines 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)

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ openSpan()

void librevenge::RVNGCSVSpreadsheetGenerator::openSpan ( const RVNGPropertyList & propList)
virtual

Called when a text span is opened.

Parameters
propListProperty 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
  • fo:text-shadow

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ openTable()

void librevenge::RVNGCSVSpreadsheetGenerator::openTable ( const RVNGPropertyList & propList)
virtual

Called when a table should be opened.

Parameters
propListDefines 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
  • 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
    1. style:column-width Width of a column, in inches

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ openTableCell()

void librevenge::RVNGCSVSpreadsheetGenerator::openTableCell ( const RVNGPropertyList & propList)
virtual

Called when a new table cell is opened.

Parameters
propListProperty 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)

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ openTableRow()

void librevenge::RVNGCSVSpreadsheetGenerator::openTableRow ( const RVNGPropertyList & propList)
virtual

Called when a new table row is opened.

Parameters
propListDefines 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)

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ openTextBox()

void librevenge::RVNGCSVSpreadsheetGenerator::openTextBox ( const RVNGPropertyList & propList)
virtual

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

Parameters
propListDefines a set of properties for the text box.

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ openUnorderedListLevel()

void librevenge::RVNGCSVSpreadsheetGenerator::openUnorderedListLevel ( const RVNGPropertyList & propList)
virtual

Called when a new unordered list level should be opened.

Parameters
propListDefines 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

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ operator=()

RVNGCSVSpreadsheetGenerator & librevenge::RVNGCSVSpreadsheetGenerator::operator= ( const RVNGCSVSpreadsheetGenerator & other)
private

unimplemented copy operator to prevent copy

◆ setDocumentMetaData()

void librevenge::RVNGCSVSpreadsheetGenerator::setDocumentMetaData ( const RVNGPropertyList & propList)
virtual

Called when all document metadata should be set.

This is always the first callback made.

Parameters
propListProperty list for the metadata. May contain:
  • dc:creator
  • 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

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

◆ setDTFormats()

void librevenge::RVNGCSVSpreadsheetGenerator::setDTFormats ( RVNGString const & date = "%m/%d/%y",
RVNGString const & time = "%H:%M:%S" )

defines the format used to export the date and the time (see strftime)

Referenced by operator=().

◆ setSeparators()

void librevenge::RVNGCSVSpreadsheetGenerator::setSeparators ( char fieldSep = ',',
char textSep = '"',
char decimalSep = '.' )

set the separators:

  • fieldSep the field separator, default: ,
  • textSep the text separator, default: "
  • decimalSep the decimal separator, default: .

Referenced by operator=().

◆ startDocument()

void librevenge::RVNGCSVSpreadsheetGenerator::startDocument ( const RVNGPropertyList & propList)
virtual

Called at the start of the parsing process.

This is always the second callback made.

Implements librevenge::RVNGSpreadsheetInterface.

Referenced by operator=().

Member Data Documentation

◆ m_impl

RVNGCSVSpreadsheetGeneratorImpl* librevenge::RVNGCSVSpreadsheetGenerator::m_impl
private

the internal storage data

Referenced by closeChart(), closeComment(), closeEndnote(), closeFooter(), closeFootnote(), closeFrame(), closeGroup(), closeHeader(), closeSheet(), closeSheetCell(), closeSheetRow(), closeTable(), closeTextBox(), insertLineBreak(), insertSpace(), insertTab(), insertText(), openChart(), openComment(), openEndnote(), openFooter(), openFootnote(), openFrame(), openGroup(), openHeader(), openSheet(), openSheetCell(), openSheetRow(), openTable(), openTextBox(), RVNGCSVSpreadsheetGenerator(), setDTFormats(), setSeparators(), and ~RVNGCSVSpreadsheetGenerator().

The documentation for this class was generated from the following files:
Generated for librevenge by doxygen 1.14.0