MsWksSSParser Class Referencefinal

the main class to read a Microsoft Works spreadsheet file More...

#include <MsWksSSParser.hxx>

Inheritance diagram for MsWksSSParser:
MWAWSpreadsheetParser MWAWParser

Public Member Functions

 MsWksSSParser (MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header)
 constructor
 
 ~MsWksSSParser () 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
 
bool createZones ()
 finds the different objects zones
 
bool readSSheetZone ()
 try to read the spreadsheet data zone
 
void sendNote (int id)
 try to send a note
 
bool sendSpreadsheet ()
 try to send the main spreadsheet
 
bool readEndHeader ()
 reads the end of the header
 
bool readCell (int sz, MWAWVec2i const &cellPos, MsWksSSParserInternal::Cell &cell)
 reads a cell content data
 
- 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< MsWksSSParserInternal::Statem_state
 the state
 
std::vector< MWAWEntrym_listZones
 the list of different Zones
 
std::shared_ptr< MsWksDocumentm_document
 the actual zone
 

Friends

class MsWksSSParserInternal::SubDocument
 

Detailed Description

the main class to read a Microsoft Works spreadsheet file

Constructor & Destructor Documentation

◆ MsWksSSParser()

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

constructor

◆ ~MsWksSSParser()

MsWksSSParser::~MsWksSSParser ( )
final

destructor

Member Function Documentation

◆ checkHeader()

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

checks if the document header is correct (or not)

Implements MWAWParser.

Referenced by parse().

◆ createDocument()

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

creates the listener which will be associated to the document

Referenced by parse().

◆ createZones()

bool MsWksSSParser::createZones ( )
protected

finds the different objects zones

Referenced by parse().

◆ init()

void MsWksSSParser::init ( )
protected

inits all internal variables

Referenced by MsWksSSParser().

◆ parse()

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

virtual function used to parse the input

Implements MWAWSpreadsheetParser.

◆ readCell()

bool MsWksSSParser::readCell ( int  sz,
MWAWVec2i const &  cellPos,
MsWksSSParserInternal::Cell cell 
)
protected

reads a cell content data

Referenced by readSSheetZone().

◆ readEndHeader()

bool MsWksSSParser::readEndHeader ( )
protected

reads the end of the header

◆ readSSheetZone()

bool MsWksSSParser::readSSheetZone ( )
protected

try to read the spreadsheet data zone

Referenced by createZones().

◆ sendNote()

void MsWksSSParser::sendNote ( int  id)
protected

try to send a note

◆ sendSpreadsheet()

bool MsWksSSParser::sendSpreadsheet ( )
protected

try to send the main spreadsheet

Referenced by parse().

Friends And Related Function Documentation

◆ MsWksSSParserInternal::SubDocument

Member Data Documentation

◆ m_document

std::shared_ptr<MsWksDocument> MsWksSSParser::m_document
protected

◆ m_listZones

std::vector<MWAWEntry> MsWksSSParser::m_listZones
protected

the list of different Zones

◆ m_state

std::shared_ptr<MsWksSSParserInternal::State> MsWksSSParser::m_state
protected

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