ClarisWksSSParser Class Referencefinal

the main class to read a AppleWorks/ClarisWorks spreadsheet file More...

#include <ClarisWksSSParser.hxx>

Inheritance diagram for ClarisWksSSParser:
MWAWSpreadsheetParser MWAWParser

Public Member Functions

 ClarisWksSSParser (MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header)
 constructor
 
 ~ClarisWksSSParser () final
 destructor
 
bool checkHeader (MWAWHeader *header, bool strict=false) final
 checks if the document header is correct (or not)
 
void parse (librevenge::RVNGSpreadsheetInterface *documentInterface) final
 virtual function used to parse the input
 
- Public Member Functions inherited from MWAWSpreadsheetParser
 ~MWAWSpreadsheetParser () override
 destructor
 
virtual void parse (librevenge::RVNGSpreadsheetInterface *documentInterface)=0
 virtual function used to parse the input
 
- Public Member Functions inherited from MWAWParser
virtual ~MWAWParser ()
 virtual destructor
 
virtual bool checkHeader (MWAWHeader *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
 
MWAWParserStatePtr getParserState ()
 returns the parser state
 
MWAWHeadergetHeader ()
 returns the header
 
MWAWInputStreamPtrgetInput ()
 returns the actual input
 
MWAWListenerPtr getMainListener ()
 returns the main listener
 
MWAWGraphicListenerPtrgetGraphicListener ()
 returns the graphic listener
 
MWAWPresentationListenerPtrgetPresentationListener ()
 returns the presentation listener
 
MWAWSpreadsheetListenerPtrgetSpreadsheetListener ()
 returns the spreadsheet listener
 
MWAWTextListenerPtrgetTextListener ()
 returns the text listener
 
MWAWFontConverterPtrgetFontConverter ()
 returns the font converter
 
MWAWFontManagerPtrgetFontManager ()
 returns the font manager
 
MWAWPageSpan const & getPageSpan () const
 returns the actual page dimension
 
MWAWPageSpangetPageSpan ()
 returns the actual page dimension
 
double getFormLength () const
 returns the form length
 
double getFormWidth () const
 returns the form width
 
double getPageLength () const
 returns the page length (form length without margin )
 
double getPageWidth () const
 returns the page width (form width without margin )
 
MWAWRSRCParserPtrgetRSRCParser ()
 returns the rsrc parser
 
libmwaw::DebugFileascii ()
 a DebugFile used to write what we recognize when we parse the document
 

Protected Member Functions

void init ()
 inits all internal variables
 
void createDocument (librevenge::RVNGSpreadsheetInterface *documentInterface)
 creates the listener which will be associated to the document
 
void sendFootnote (int zoneId)
 creates a document to send a footnote
 
- Protected Member Functions inherited from MWAWSpreadsheetParser
 MWAWSpreadsheetParser (MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header)
 constructor (protected)
 
 MWAWSpreadsheetParser (MWAWParserStatePtr const &state)
 constructor using a state
 
- Protected Member Functions inherited from MWAWParser
 MWAWParser (MWAWParserState::Type type, MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header)
 constructor (protected)
 
 MWAWParser (MWAWParserStatePtr const &state)
 constructor using a state
 
void setVersion (int vers)
 sets the document's version
 
void setGraphicListener (MWAWGraphicListenerPtr &listener)
 sets the graphic listener
 
void resetGraphicListener ()
 resets the listener
 
void setPresentationListener (MWAWPresentationListenerPtr &listener)
 sets the presentation listener
 
void resetPresentationListener ()
 resets the listener
 
void setSpreadsheetListener (MWAWSpreadsheetListenerPtr &listener)
 sets the spreadsheet listener
 
void resetSpreadsheetListener ()
 resets the listener
 
void setTextListener (MWAWTextListenerPtr &listener)
 sets the text listener
 
void resetTextListener ()
 resets the listener
 
void setAsciiName (char const *name)
 Debugging: change the default ascii file.
 
std::string const & asciiName () const
 return the ascii file name
 

Protected Attributes

std::shared_ptr< ClarisWksSSParserInternal::Statem_state
 the state
 
std::shared_ptr< ClarisWksDocumentm_document
 the main document manager
 

Friends

class ClarisWksSSParserInternal::SubDocument
 
class ClarisWksDocument
 

Detailed Description

the main class to read a AppleWorks/ClarisWorks spreadsheet file

Constructor & Destructor Documentation

◆ ClarisWksSSParser()

ClarisWksSSParser::ClarisWksSSParser ( MWAWInputStreamPtr const &  input,
MWAWRSRCParserPtr const &  rsrcParser,
MWAWHeader header 
)

constructor

◆ ~ClarisWksSSParser()

ClarisWksSSParser::~ClarisWksSSParser ( )
final

destructor

Member Function Documentation

◆ checkHeader()

bool ClarisWksSSParser::checkHeader ( MWAWHeader header,
bool  strict = false 
)
finalvirtual

checks if the document header is correct (or not)

Implements MWAWParser.

Referenced by parse().

◆ createDocument()

void ClarisWksSSParser::createDocument ( librevenge::RVNGSpreadsheetInterface *  documentInterface)
protected

creates the listener which will be associated to the document

Referenced by parse().

◆ init()

void ClarisWksSSParser::init ( )
protected

inits all internal variables

Referenced by ClarisWksSSParser().

◆ parse()

void ClarisWksSSParser::parse ( librevenge::RVNGSpreadsheetInterface *  documentInterface)
finalvirtual

virtual function used to parse the input

Implements MWAWSpreadsheetParser.

◆ sendFootnote()

void ClarisWksSSParser::sendFootnote ( int  zoneId)
protected

creates a document to send a footnote

Referenced by init().

Friends And Related Function Documentation

◆ ClarisWksDocument

friend class ClarisWksDocument
friend

Referenced by init().

◆ ClarisWksSSParserInternal::SubDocument

Member Data Documentation

◆ m_document

std::shared_ptr<ClarisWksDocument> ClarisWksSSParser::m_document
protected

the main document manager

Referenced by checkHeader(), createDocument(), init(), and parse().

◆ m_state

std::shared_ptr<ClarisWksSSParserInternal::State> ClarisWksSSParser::m_state
protected

the state

Referenced by checkHeader(), createDocument(), and init().


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

Generated on Thu Jan 19 2023 00:00:00 for libmwaw by doxygen 1.9.6