WKSContentListener Class Reference

#include <WKSContentListener.h>

Inheritance diagram for WKSContentListener:
WPSListener

List of all members.

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, ..
void insertUnicode (uint32_t character)
 adds an unicode character
void insertUnicodeString (librevenge::RVNGString const &str)
 adds a unicode string
void insertTab ()
 adds an unicode character to a string ( with correct encoding ).
void insertEOL (bool softBreak=false)
void insertBreak (const uint8_t breakType)
void setFont (const WPSFont &font)
 set the actual font
WPSFont const & getFont () const
 returns the actual font
bool isParagraphOpened () const
 returns true if a paragraph or a list is opened
void setParagraph (const WPSParagraph &para)
 sets the actual paragraph
WPSParagraph const & getParagraph () const
 returns the actual paragraph
void insertField (FieldType type)
 adds a field type
void insertDateTimeField (char const *format)
 insert a date/time field with given format (see strftime)
void insertComment (WPSSubDocumentPtr &subDocument)
 adds comment
void insertPicture (WPSPosition const &pos, const librevenge::RVNGBinaryData &binaryData, std::string type="image/pict", WPSGraphicStyle const &style=WPSGraphicStyle::emptyStyle())
 adds a picture in given position
void insertObject (WPSPosition const &pos, const WPSEmbeddedObject &obj, WPSGraphicStyle const &style=WPSGraphicStyle::emptyStyle())
 adds an object with replacement picture in given position
void insertPicture (WPSPosition const &pos, WPSGraphicShape const &shape, WPSGraphicStyle const &style)
 adds a picture in given position
void insertTextBox (WPSPosition const &pos, WPSSubDocumentPtr subDocument, WPSGraphicStyle const &frameStyle=WPSGraphicStyle::emptyStyle())
 adds a textbox in given position
void openSheet (std::vector< float > const &colWidth, librevenge::RVNGUnit unit, librevenge::RVNGString const &name="")
 open a sheet
void closeSheet ()
 closes this sheet
void openSheetRow (float h, librevenge::RVNGUnit unit, bool headerRow=false)
 open a row with given height.
void closeSheetRow ()
 closes this row
void openSheetCell (WPSCell const &cell, CellContent const &content, librevenge::RVNGPropertyList const &extras=librevenge::RVNGPropertyList())
 low level function to define a cell.
void closeSheetCell ()
 close a cell

Protected Member Functions

void _openPageSpan ()
void _closePageSpan ()
void _handleFrameParameters (librevenge::RVNGPropertyList &propList, WPSPosition const &pos)
bool _openFrame (WPSPosition const &pos, WPSGraphicStyle const &style)
void _closeFrame ()
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)
void _popParsingState ()
 resets the previous parsing state

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

Constructor & Destructor Documentation

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

Member Function Documentation

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

Referenced by _openParagraph().

void WKSContentListener::_closeFrame ( ) [protected]
void WKSContentListener::_closePageSpan ( ) [protected]

Referenced by endDocument().

Referenced by closeSheet(), and handleSubDocument().

void WKSContentListener::_handleFrameParameters ( librevenge::RVNGPropertyList &  propList,
WPSPosition const &  pos 
) [protected]

Referenced by _openFrame().

void WKSContentListener::_insertBreakIfNecessary ( librevenge::RVNGPropertyList &  propList) [protected]
bool WKSContentListener::_openFrame ( WPSPosition const &  pos,
WPSGraphicStyle const &  style 
) [protected]
void WKSContentListener::_openPageSpan ( ) [protected]

Referenced by _openParagraph(), and openSheet().

resets the previous parsing state

Referenced by closeSheet(), and handleSubDocument().

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().

Referenced by handleSubDocument(), and openSheet().

closes this sheet

Referenced by _endSubDocument(), and endDocument().

close a cell

Referenced by openSheetCell().

closes this row

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::insertBreak ( const uint8_t  breakType) [virtual]

Implements WPSListener.

void WKSContentListener::insertCharacter ( uint8_t  character) [virtual]

adds a basic character, ..

Implements WPSListener.

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.

adds a field type

Implements WPSListener.

adds an object with replacement picture in given position

void WKSContentListener::insertPicture ( WPSPosition const &  pos,
const librevenge::RVNGBinaryData &  binaryData,
std::string  type = "image/pict",
WPSGraphicStyle const &  style = WPSGraphicStyle::emptyStyle() 
)

adds a picture in given position

void WKSContentListener::insertPicture ( WPSPosition const &  pos,
WPSGraphicShape const &  shape,
WPSGraphicStyle const &  style 
)

adds a picture in given position

void WKSContentListener::insertTab ( ) [virtual]

adds an unicode character to a string ( with correct encoding ).

Implements WPSListener.

void WKSContentListener::insertTextBox ( WPSPosition const &  pos,
WPSSubDocumentPtr  subDocument,
WPSGraphicStyle const &  frameStyle = WPSGraphicStyle::emptyStyle() 
)

adds a textbox in given position

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,
librevenge::RVNGString const &  name = "" 
)

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.


Member Data Documentation

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

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