WKSContentListener Class Reference

#include <WKSContentListener.h>

Inheritance diagram for WKSContentListener:
WPSListener

Classes

struct  CellContent
 small class use to define a sheet cell content More...
 
struct  FormulaInstruction
 small class use to define a formula instruction More...
 

Public Member Functions

 WKSContentListener (std::vector< WPSPageSpan > const &pageList, librevenge::RVNGSpreadsheetInterface *documentInterface)
 
virtual ~WKSContentListener ()
 
void setDocumentLanguage (int lcid)
 
void startDocument ()
 
void endDocument ()
 
void handleSubDocument (WPSSubDocumentPtr &subDocument, libwps::SubDocumentType subDocumentType)
 
void insertCharacter (uint8_t character)
 adds a basic character, .. More...
 
void insertUnicode (uint32_t character)
 adds an unicode character More...
 
void insertUnicodeString (librevenge::RVNGString const &str)
 adds a unicode string More...
 
void insertTab ()
 
void insertEOL (bool softBreak=false)
 
void insertBreak (const uint8_t breakType)
 
void setFont (const WPSFont &font)
 set the actual font More...
 
WPSFont const & getFont () const
 returns the actual font More...
 
bool isParagraphOpened () const
 returns true if a paragraph or a list is opened More...
 
void setParagraph (const WPSParagraph &para)
 sets the actual paragraph More...
 
WPSParagraph const & getParagraph () const
 returns the actual paragraph More...
 
void insertField (FieldType type)
 adds a field type More...
 
void insertDateTimeField (char const *format)
 insert a date/time field with given format (see strftime) More...
 
void insertComment (WPSSubDocumentPtr &subDocument)
 adds comment More...
 
void openSheet (std::vector< float > const &colWidth, librevenge::RVNGUnit unit)
 open a sheet More...
 
void closeSheet ()
 closes this sheet More...
 
void openSheetRow (float h, librevenge::RVNGUnit unit, bool headerRow=false)
 open a row with given height. More...
 
void closeSheetRow ()
 closes this row More...
 
void openSheetCell (WPSCell const &cell, CellContent const &content, librevenge::RVNGPropertyList const &extras=librevenge::RVNGPropertyList())
 low level function to define a cell. More...
 
void closeSheetCell ()
 close a cell More...
 
- Public Member Functions inherited from WPSListener
 WPSListener ()
 
virtual ~WPSListener ()
 

Protected Member Functions

void _openPageSpan ()
 
void _closePageSpan ()
 
void _startSubDocument ()
 
void _endSubDocument ()
 
void _openParagraph ()
 
void _closeParagraph ()
 
void _appendParagraphProperties (librevenge::RVNGPropertyList &propList, const bool isListElement=false)
 
void _resetParagraphState (const bool isListElement=false)
 
void _openSpan ()
 
void _closeSpan ()
 
void _flushText ()
 
void _flushDeferredTabs ()
 
void _insertBreakIfNecessary (librevenge::RVNGPropertyList &propList)
 
shared_ptr
< WKSContentParsingState
_pushParsingState ()
 creates a new parsing state (copy of the actual state) More...
 
void _popParsingState ()
 resets the previous parsing state More...
 

Protected Attributes

shared_ptr
< WKSDocumentParsingState
m_ds
 
shared_ptr
< WKSContentParsingState
m_ps
 
std::vector< shared_ptr
< WKSContentParsingState > > 
m_psStack
 
librevenge::RVNGSpreadsheetInterface * m_documentInterface
 

Private Member Functions

 WKSContentListener (const WKSContentListener &)
 
WKSContentListeneroperator= (const WKSContentListener &)
 

Additional Inherited Members

- Public Types inherited from WPSListener
enum  FieldType {
  None, PageNumber, Date, Time,
  Title, Link, Database
}
 Defines some basic type for field. More...
 
- Static Public Member Functions inherited from WPSListener
static void appendUnicode (uint32_t val, librevenge::RVNGString &buffer)
 adds an unicode character to a string ( with correct encoding ). More...
 

Constructor & Destructor Documentation

WKSContentListener::WKSContentListener ( std::vector< WPSPageSpan > const &  pageList,
librevenge::RVNGSpreadsheetInterface *  documentInterface 
)
WKSContentListener::~WKSContentListener ( )
virtual
WKSContentListener::WKSContentListener ( const WKSContentListener )
private

Member Function Documentation

void WKSContentListener::_appendParagraphProperties ( librevenge::RVNGPropertyList &  propList,
const bool  isListElement = false 
)
protected

Referenced by _openParagraph().

void WKSContentListener::_closePageSpan ( )
protected

Referenced by endDocument().

void WKSContentListener::_closeParagraph ( )
protected
void WKSContentListener::_closeSpan ( )
protected
void WKSContentListener::_endSubDocument ( )
protected

Referenced by closeSheet(), and handleSubDocument().

void WKSContentListener::_flushDeferredTabs ( )
protected
void WKSContentListener::_flushText ( )
protected
void WKSContentListener::_insertBreakIfNecessary ( librevenge::RVNGPropertyList &  propList)
protected
void WKSContentListener::_openPageSpan ( )
protected

Referenced by _openParagraph(), and openSheet().

void WKSContentListener::_openParagraph ( )
protected

Referenced by _openSpan(), and insertComment().

void WKSContentListener::_openSpan ( )
protected
void WKSContentListener::_popParsingState ( )
protected

resets the previous parsing state

Referenced by closeSheet(), and handleSubDocument().

shared_ptr< WKSContentParsingState > WKSContentListener::_pushParsingState ( )
protected

creates a new parsing state (copy of the actual state)

Returns
the old one

Referenced by handleSubDocument(), and openSheet().

void WKSContentListener::_resetParagraphState ( const bool  isListElement = false)
protected

Referenced by _openParagraph().

void WKSContentListener::_startSubDocument ( )
protected

Referenced by handleSubDocument(), and openSheet().

void WKSContentListener::closeSheet ( )

closes this sheet

Referenced by _endSubDocument(), and endDocument().

void WKSContentListener::closeSheetCell ( )

close a cell

Referenced by openSheetCell().

void WKSContentListener::closeSheetRow ( )

closes this row

void WKSContentListener::endDocument ( )
WPSFont const & WKSContentListener::getFont ( ) const
virtual

returns the actual font

Implements WPSListener.

WPSParagraph const & WKSContentListener::getParagraph ( ) const
virtual

returns the actual paragraph

Implements WPSListener.

void WKSContentListener::handleSubDocument ( WPSSubDocumentPtr subDocument,
libwps::SubDocumentType  subDocumentType 
)
void WKSContentListener::insertBreak ( const uint8_t  breakType)
virtual

Implements WPSListener.

void WKSContentListener::insertCharacter ( uint8_t  character)
virtual

adds a basic character, ..

Implements WPSListener.

void WKSContentListener::insertComment ( WPSSubDocumentPtr subDocument)

adds comment

void WKSContentListener::insertDateTimeField ( char const *  format)
virtual

insert a date/time field with given format (see strftime)

Implements WPSListener.

Referenced by insertField().

void WKSContentListener::insertEOL ( bool  softBreak = false)
virtual

Implements WPSListener.

void WKSContentListener::insertField ( WKSContentListener::FieldType  type)
virtual

adds a field type

Implements WPSListener.

void WKSContentListener::insertTab ( )
virtual

Implements WPSListener.

void WKSContentListener::insertUnicode ( uint32_t  character)
virtual

adds an unicode character

by convention if character=0xfffd(undef), no character is added

Implements WPSListener.

Referenced by insertCharacter().

void WKSContentListener::insertUnicodeString ( librevenge::RVNGString const &  str)
virtual

adds a unicode string

Implements WPSListener.

Referenced by insertDateTimeField(), and insertField().

bool WKSContentListener::isParagraphOpened ( ) const
virtual

returns true if a paragraph or a list is opened

Implements WPSListener.

void WKSContentListener::openSheet ( std::vector< float > const &  colWidth,
librevenge::RVNGUnit  unit 
)

open a sheet

void WKSContentListener::openSheetCell ( WPSCell const &  cell,
WKSContentListener::CellContent const &  content,
librevenge::RVNGPropertyList const &  extras = librevenge::RVNGPropertyList() 
)

low level function to define a cell.

Parameters
cellthe cell position, alignement, ...
contentthe cell content
extrasto be used to pass extra data, for instance spreadsheet data
void WKSContentListener::openSheetRow ( float  h,
librevenge::RVNGUnit  unit,
bool  headerRow = false 
)

open a row with given height.

If h<0, use min-row-heigth

WKSContentListener& WKSContentListener::operator= ( const WKSContentListener )
private
void WKSContentListener::setDocumentLanguage ( int  lcid)
virtual

Implements WPSListener.

void WKSContentListener::setFont ( const WPSFont font)
virtual

set the actual font

Implements WPSListener.

void WKSContentListener::setParagraph ( const WPSParagraph para)
virtual

sets the actual paragraph

Implements WPSListener.

void WKSContentListener::startDocument ( )

Referenced by _openPageSpan().

Member Data Documentation

std::vector<shared_ptr<WKSContentParsingState> > WKSContentListener::m_psStack
protected

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

Generated on Mon Nov 23 2015 07:09:19 for libwps by doxygen 1.8.5