STOFFParser Class Reference

virtual class which defines the ancestor of all main zone parser More...

#include <STOFFParser.hxx>

Inheritance diagram for STOFFParser:
STOFFGraphicParser STOFFSpreadsheetParser STOFFTextParser SDAParser SDGParser SDCParser SDWParser SDXParser

List of all members.

Public Member Functions

virtual ~STOFFParser ()
 virtual destructor
virtual bool checkHeader (STOFFHeader *header, bool strict=false)=0
 virtual function used to check if the document header is correct (or not)
int version () const
 returns the works version
STOFFParserStatePtr getParserState ()
 returns the parser state
STOFFHeadergetHeader ()
 returns the header
STOFFInputStreamPtrgetInput ()
 returns the actual input
STOFFPageSpan const & getPageSpan () const
 returns the actual page dimension
STOFFPageSpangetPageSpan ()
 returns the actual page dimension
STOFFGraphicListenerPtrgetGraphicListener ()
 returns the graphic listener
STOFFSpreadsheetListenerPtrgetSpreadsheetListener ()
 returns the spreadsheet listener
STOFFTextListenerPtrgetTextListener ()
 returns the text listener
libstoff::DebugFileascii ()
 a DebugFile used to write what we recognize when we parse the document

Protected Member Functions

 STOFFParser (STOFFParserState::Type type, STOFFInputStreamPtr input, STOFFHeader *header)
 constructor (protected)
 STOFFParser (STOFFParserStatePtr state)
 constructor using a state
void setVersion (int vers)
 sets the document's version
void setGraphicListener (STOFFGraphicListenerPtr &listener)
 sets the graphic listener
void resetGraphicListener ()
 resets the graphic listener
void setSpreadsheetListener (STOFFSpreadsheetListenerPtr &listener)
 sets the spreadsheet listener
void resetSpreadsheetListener ()
 resets the spreadsheet listener
void setTextListener (STOFFTextListenerPtr &listener)
 sets the text listener
void resetTextListener ()
 resets the text listener
void setAsciiName (char const *name)
 Debugging: change the default ascii file.
std::string const & asciiName () const
 return the ascii file name

Private Member Functions

 STOFFParser (const STOFFParser &)
 private copy constructor: forbidden
STOFFParseroperator= (const STOFFParser &)
 private operator=: forbidden

Private Attributes

STOFFParserStatePtr m_parserState
 the parser state
std::string m_asciiName
 the debug file name

Detailed Description

virtual class which defines the ancestor of all main zone parser


Constructor & Destructor Documentation

virtual destructor

STOFFParser::STOFFParser ( STOFFParserState::Type  type,
STOFFInputStreamPtr  input,
STOFFHeader header 
) [protected]

constructor (protected)

STOFFParser::STOFFParser ( STOFFParserStatePtr  state) [inline, explicit, protected]

constructor using a state

STOFFParser::STOFFParser ( const STOFFParser ) [private]

private copy constructor: forbidden


Member Function Documentation

a DebugFile used to write what we recognize when we parse the document

Referenced by SDAParser::parse(), SDXParser::parse(), SDWParser::parse(), SDGParser::parse(), and SDCParser::parse().

std::string const& STOFFParser::asciiName ( ) const [inline, protected]

return the ascii file name

virtual bool STOFFParser::checkHeader ( STOFFHeader header,
bool  strict = false 
) [pure virtual]

virtual function used to check if the document header is correct (or not)

Implemented in SDAParser, SDCParser, SDGParser, SDWParser, and SDXParser.

returns the header

returns the actual page dimension

returns the text listener

Referenced by SDWParser::parse(), and resetTextListener().

STOFFParser& STOFFParser::operator= ( const STOFFParser ) [private]

private operator=: forbidden

void STOFFParser::resetGraphicListener ( ) [protected]

resets the graphic listener

Referenced by SDAParser::parse(), and SDGParser::parse().

resets the spreadsheet listener

Referenced by SDCParser::parse().

void STOFFParser::resetTextListener ( ) [protected]

resets the text listener

Referenced by SDWParser::parse().

void STOFFParser::setAsciiName ( char const *  name) [inline, protected]

Debugging: change the default ascii file.

Referenced by SDXParser::init().

void STOFFParser::setGraphicListener ( STOFFGraphicListenerPtr listener) [protected]

sets the graphic listener

Referenced by SDAParser::createDocument(), and SDGParser::createDocument().

sets the spreadsheet listener

Referenced by SDCParser::createDocument().

void STOFFParser::setTextListener ( STOFFTextListenerPtr listener) [protected]

sets the text listener

Referenced by SDWParser::createDocument().

void STOFFParser::setVersion ( int  vers) [inline, protected]

sets the document's version

int STOFFParser::version ( ) const [inline]

returns the works version


Member Data Documentation

std::string STOFFParser::m_asciiName [private]

the debug file name

Referenced by asciiName(), and setAsciiName().


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