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::OdtGenerator ( OdfDocumentHandler pHandler,
const OdfStreamType  streamType 
)
OdtGenerator::~OdtGenerator ( )
OdtGenerator::OdtGenerator ( OdtGenerator const &  )
private

Member Function Documentation

void OdtGenerator::closeComment ( )
void OdtGenerator::closeEndnote ( )
void OdtGenerator::closeFooter ( )
void OdtGenerator::closeFootnote ( )
void OdtGenerator::closeFrame ( )
void OdtGenerator::closeHeader ( )
void OdtGenerator::closeListElement ( )
void OdtGenerator::closeOrderedListLevel ( )
void OdtGenerator::closePageSpan ( )
void OdtGenerator::closeParagraph ( )
void OdtGenerator::closeSection ( )
void OdtGenerator::closeSpan ( )
void OdtGenerator::closeTable ( )
void OdtGenerator::closeTableCell ( )
void OdtGenerator::closeTableRow ( )
void OdtGenerator::closeTextBox ( )
void OdtGenerator::closeUnorderedListLevel ( )
void OdtGenerator::defineCharacterStyle ( const WPXPropertyList &  )
void OdtGenerator::defineOrderedListLevel ( const WPXPropertyList &  propList)
void OdtGenerator::definePageStyle ( const WPXPropertyList &  )
void OdtGenerator::defineParagraphStyle ( const WPXPropertyList &  ,
const WPXPropertyListVector &   
)
void OdtGenerator::defineSectionStyle ( const WPXPropertyList &  ,
const WPXPropertyListVector &   
)
void OdtGenerator::defineUnorderedListLevel ( const WPXPropertyList &  propList)
void OdtGenerator::endDocument ( )
void OdtGenerator::insertBinaryObject ( const WPXPropertyList &  propList,
const WPXBinaryData &  data 
)
void OdtGenerator::insertCoveredTableCell ( const WPXPropertyList &  propList)
void OdtGenerator::insertEquation ( const WPXPropertyList &  propList,
const WPXString &  data 
)
void OdtGenerator::insertField ( const WPXString &  type,
const WPXPropertyList &  propList 
)
void OdtGenerator::insertLineBreak ( )
void OdtGenerator::insertSpace ( )
void OdtGenerator::insertTab ( )
void OdtGenerator::insertText ( const WPXString &  text)
void OdtGenerator::openComment ( const WPXPropertyList &  propList)
void OdtGenerator::openEndnote ( const WPXPropertyList &  propList)
void OdtGenerator::openFooter ( const WPXPropertyList &  propList)
void OdtGenerator::openFootnote ( const WPXPropertyList &  propList)
void OdtGenerator::openFrame ( const WPXPropertyList &  propList)
void OdtGenerator::openHeader ( const WPXPropertyList &  propList)
void OdtGenerator::openListElement ( const WPXPropertyList &  propList,
const WPXPropertyListVector &  tabStops 
)
void OdtGenerator::openOrderedListLevel ( const WPXPropertyList &  propList)
void OdtGenerator::openPageSpan ( const WPXPropertyList &  propList)
void OdtGenerator::openParagraph ( const WPXPropertyList &  propList,
const WPXPropertyListVector &  tabStops 
)
void OdtGenerator::openSection ( const WPXPropertyList &  propList,
const WPXPropertyListVector &  columns 
)
void OdtGenerator::openSpan ( const WPXPropertyList &  propList)
void OdtGenerator::openTable ( const WPXPropertyList &  propList,
const WPXPropertyListVector &  columns 
)
void OdtGenerator::openTableCell ( const WPXPropertyList &  propList)
void OdtGenerator::openTableRow ( const WPXPropertyList &  propList)
void OdtGenerator::openTextBox ( const WPXPropertyList &  propList)
void OdtGenerator::openUnorderedListLevel ( const WPXPropertyList &  propList)
OdtGenerator& OdtGenerator::operator= ( OdtGenerator const &  )
private
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
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
void OdtGenerator::setDocumentMetaData ( const WPXPropertyList &  propList)
void OdtGenerator::startDocument ( )

Member Data Documentation

OdtGeneratorPrivate* OdtGenerator::mpImpl
private

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

Generated for libodfgen by doxygen 1.8.3.1