OdtGenerator Class Reference

A generator for text documents. More...

#include <OdtGenerator.hxx>

Inheritance diagram for OdtGenerator:

Public Member Functions

 OdtGenerator (OdfDocumentHandler *pHandler, const OdfStreamType streamType)
 
 ~OdtGenerator ()
 
void setDocumentMetaData (const WPXPropertyList &propList)
 
void startDocument ()
 
void endDocument ()
 
void definePageStyle (const WPXPropertyList &)
 
void openPageSpan (const WPXPropertyList &propList)
 
void closePageSpan ()
 
void defineSectionStyle (const WPXPropertyList &, const WPXPropertyListVector &)
 
void openSection (const WPXPropertyList &propList, const WPXPropertyListVector &columns)
 
void closeSection ()
 
void openHeader (const WPXPropertyList &propList)
 
void closeHeader ()
 
void openFooter (const WPXPropertyList &propList)
 
void closeFooter ()
 
void defineParagraphStyle (const WPXPropertyList &, const WPXPropertyListVector &)
 
void openParagraph (const WPXPropertyList &propList, const WPXPropertyListVector &tabStops)
 
void closeParagraph ()
 
void defineCharacterStyle (const WPXPropertyList &)
 
void openSpan (const WPXPropertyList &propList)
 
void closeSpan ()
 
void insertTab ()
 
void insertSpace ()
 
void insertText (const WPXString &text)
 
void insertLineBreak ()
 
void insertField (const WPXString &type, const WPXPropertyList &propList)
 
void defineOrderedListLevel (const WPXPropertyList &propList)
 
void defineUnorderedListLevel (const WPXPropertyList &propList)
 
void openOrderedListLevel (const WPXPropertyList &propList)
 
void openUnorderedListLevel (const WPXPropertyList &propList)
 
void closeOrderedListLevel ()
 
void closeUnorderedListLevel ()
 
void openListElement (const WPXPropertyList &propList, const WPXPropertyListVector &tabStops)
 
void closeListElement ()
 
void openFootnote (const WPXPropertyList &propList)
 
void closeFootnote ()
 
void openEndnote (const WPXPropertyList &propList)
 
void closeEndnote ()
 
void openComment (const WPXPropertyList &propList)
 
void closeComment ()
 
void openTextBox (const WPXPropertyList &propList)
 
void closeTextBox ()
 
void openTable (const WPXPropertyList &propList, const WPXPropertyListVector &columns)
 
void openTableRow (const WPXPropertyList &propList)
 
void closeTableRow ()
 
void openTableCell (const WPXPropertyList &propList)
 
void closeTableCell ()
 
void insertCoveredTableCell (const WPXPropertyList &propList)
 
void closeTable ()
 
void openFrame (const WPXPropertyList &propList)
 
void closeFrame ()
 
void insertBinaryObject (const WPXPropertyList &propList, const WPXBinaryData &data)
 
void insertEquation (const WPXPropertyList &propList, const WPXString &data)
 
void registerEmbeddedObjectHandler (const WPXString &mimeType, OdfEmbeddedObject objectHandler)
 Registers a handler for embedded objects. More...
 
void registerEmbeddedImageHandler (const WPXString &mimeType, OdfEmbeddedImage imageHandler)
 Registers a handler for embedded images. More...
 

Private Member Functions

 OdtGenerator (OdtGenerator const &)
 
OdtGeneratoroperator= (OdtGenerator const &)
 

Private Attributes

OdtGeneratorPrivate * mpImpl
 

Detailed Description

A generator for text documents.

See libwpd library for documentation of the ::WPXDocumentInterface interface.

Constructor & Destructor Documentation

◆ OdtGenerator() [1/2]

OdtGenerator::OdtGenerator ( OdfDocumentHandler pHandler,
const OdfStreamType  streamType 
)

◆ ~OdtGenerator()

OdtGenerator::~OdtGenerator ( )

◆ OdtGenerator() [2/2]

OdtGenerator::OdtGenerator ( OdtGenerator const &  )
private

Member Function Documentation

◆ closeComment()

void OdtGenerator::closeComment ( )

◆ closeEndnote()

void OdtGenerator::closeEndnote ( )

◆ closeFooter()

void OdtGenerator::closeFooter ( )

◆ closeFootnote()

void OdtGenerator::closeFootnote ( )

◆ closeFrame()

void OdtGenerator::closeFrame ( )

◆ closeHeader()

void OdtGenerator::closeHeader ( )

◆ closeListElement()

void OdtGenerator::closeListElement ( )

◆ closeOrderedListLevel()

void OdtGenerator::closeOrderedListLevel ( )

◆ closePageSpan()

void OdtGenerator::closePageSpan ( )

◆ closeParagraph()

void OdtGenerator::closeParagraph ( )

◆ closeSection()

void OdtGenerator::closeSection ( )

◆ closeSpan()

void OdtGenerator::closeSpan ( )

◆ closeTable()

void OdtGenerator::closeTable ( )

◆ closeTableCell()

void OdtGenerator::closeTableCell ( )

◆ closeTableRow()

void OdtGenerator::closeTableRow ( )

◆ closeTextBox()

void OdtGenerator::closeTextBox ( )

◆ closeUnorderedListLevel()

void OdtGenerator::closeUnorderedListLevel ( )

◆ defineCharacterStyle()

void OdtGenerator::defineCharacterStyle ( const WPXPropertyList &  )

◆ defineOrderedListLevel()

void OdtGenerator::defineOrderedListLevel ( const WPXPropertyList &  propList)

◆ definePageStyle()

void OdtGenerator::definePageStyle ( const WPXPropertyList &  )

◆ defineParagraphStyle()

void OdtGenerator::defineParagraphStyle ( const WPXPropertyList &  ,
const WPXPropertyListVector &   
)

◆ defineSectionStyle()

void OdtGenerator::defineSectionStyle ( const WPXPropertyList &  ,
const WPXPropertyListVector &   
)

◆ defineUnorderedListLevel()

void OdtGenerator::defineUnorderedListLevel ( const WPXPropertyList &  propList)

◆ endDocument()

void OdtGenerator::endDocument ( )

◆ insertBinaryObject()

void OdtGenerator::insertBinaryObject ( const WPXPropertyList &  propList,
const WPXBinaryData &  data 
)

◆ insertCoveredTableCell()

void OdtGenerator::insertCoveredTableCell ( const WPXPropertyList &  propList)

◆ insertEquation()

void OdtGenerator::insertEquation ( const WPXPropertyList &  propList,
const WPXString &  data 
)

◆ insertField()

void OdtGenerator::insertField ( const WPXString &  type,
const WPXPropertyList &  propList 
)

◆ insertLineBreak()

void OdtGenerator::insertLineBreak ( )

◆ insertSpace()

void OdtGenerator::insertSpace ( )

◆ insertTab()

void OdtGenerator::insertTab ( )

◆ insertText()

void OdtGenerator::insertText ( const WPXString &  text)

◆ openComment()

void OdtGenerator::openComment ( const WPXPropertyList &  propList)

◆ openEndnote()

void OdtGenerator::openEndnote ( const WPXPropertyList &  propList)

◆ openFooter()

void OdtGenerator::openFooter ( const WPXPropertyList &  propList)

◆ openFootnote()

void OdtGenerator::openFootnote ( const WPXPropertyList &  propList)

◆ openFrame()

void OdtGenerator::openFrame ( const WPXPropertyList &  propList)

◆ openHeader()

void OdtGenerator::openHeader ( const WPXPropertyList &  propList)

◆ openListElement()

void OdtGenerator::openListElement ( const WPXPropertyList &  propList,
const WPXPropertyListVector &  tabStops 
)

◆ openOrderedListLevel()

void OdtGenerator::openOrderedListLevel ( const WPXPropertyList &  propList)

◆ openPageSpan()

void OdtGenerator::openPageSpan ( const WPXPropertyList &  propList)

◆ openParagraph()

void OdtGenerator::openParagraph ( const WPXPropertyList &  propList,
const WPXPropertyListVector &  tabStops 
)

◆ openSection()

void OdtGenerator::openSection ( const WPXPropertyList &  propList,
const WPXPropertyListVector &  columns 
)

◆ openSpan()

void OdtGenerator::openSpan ( const WPXPropertyList &  propList)

◆ openTable()

void OdtGenerator::openTable ( const WPXPropertyList &  propList,
const WPXPropertyListVector &  columns 
)

◆ openTableCell()

void OdtGenerator::openTableCell ( const WPXPropertyList &  propList)

◆ openTableRow()

void OdtGenerator::openTableRow ( const WPXPropertyList &  propList)

◆ openTextBox()

void OdtGenerator::openTextBox ( const WPXPropertyList &  propList)

◆ openUnorderedListLevel()

void OdtGenerator::openUnorderedListLevel ( const WPXPropertyList &  propList)

◆ operator=()

OdtGenerator& OdtGenerator::operator= ( OdtGenerator const &  )
private

◆ registerEmbeddedImageHandler()

void OdtGenerator::registerEmbeddedImageHandler ( const WPXString &  mimeType,
OdfEmbeddedImage  imageHandler 
)

Registers a handler for embedded images.

The handler converts the image to a format suitable for the used OdfDocumentHandler.

Parameters
[in]mimeTypeMIME type of the image
[in]imageHandlera function that handles processing of the images's data and generating output

◆ registerEmbeddedObjectHandler()

void OdtGenerator::registerEmbeddedObjectHandler ( const WPXString &  mimeType,
OdfEmbeddedObject  objectHandler 
)

Registers a handler for embedded objects.

Parameters
[in]mimeTypeMIME type of the object
[in]objectHandlera function that handles processing of the object's data and generating output

◆ setDocumentMetaData()

void OdtGenerator::setDocumentMetaData ( const WPXPropertyList &  propList)

◆ startDocument()

void OdtGenerator::startDocument ( )

Member Data Documentation

◆ mpImpl

OdtGeneratorPrivate* OdtGenerator::mpImpl
private

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

Generated for libodfgen by doxygen 1.8.13