SpringBoardParser Class Referencefinal

the main class to read a SpringBoard v1 file More...

#include <SpringBoardParser.hxx>

Inheritance diagram for SpringBoardParser:
MWAWGraphicParser MWAWParser

Public Member Functions

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

Protected Member Functions

void createDocument (librevenge::RVNGDrawingInterface *documentInterface)
 creates the listener which will be associated to the document More...
 
bool parsePageNumbering (MWAWEntry const &entry)
 try to parse the page numbering zone More...
 
bool parseDataList (int id, MWAWEntry const &entry)
 try to parse a list of data More...
 
bool parseLastZone (int id, MWAWEntry const &entry)
 try to parse a second entry zones More...
 
bool parseFrames (int page, long pos)
 try to parse a list of frames corresponding to a page More...
 
bool parseData (int id, MWAWEntry const &entry, MWAWVec2i const &indices)
 try to parse some data More...
 
bool parseParagraphStyle (MWAWEntry const &entry, MWAWVec2i const &indices)
 try to parse a list of paragraph style: zone8 More...
 
bool parseShape (long pos, std::pair< int, int > const &pageId)
 try to parse a shape More...
 
bool createZones ()
 finds the different objects zones More...
 
bool readFont (MWAWFont &font, int szFieldSize)
 try to read a font More...
 
bool sendHeaderFooter (int hfId)
 try to send a header/footer text More...
 
bool sendFrame (std::pair< int, int > const &pageId)
 try to send a frame (with a shape) More...
 
bool sendTextShape (std::pair< int, int > const &pageId, int minParagraph=0, int maxParagraph=-1)
 try to send a shape text More...
 
bool sendLinkShape (std::pair< int, int > const &linkId, bool isTop)
 try to send a link text More...
 
bool isPositionValid (long pos) const
 returns true if the position is a valid file positions, ie. More...
 
bool isEntryValid (MWAWEntry const &entry) const
 returns true if the zone is a valid zone positions, ie. More...
 
- Protected Member Functions inherited from MWAWGraphicParser
 MWAWGraphicParser (MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header)
 constructor (protected) More...
 
 MWAWGraphicParser (MWAWParserStatePtr const &state)
 constructor using a state More...
 
- Protected Member Functions inherited from MWAWParser
 MWAWParser (MWAWParserState::Type type, MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header)
 constructor (protected) More...
 
 MWAWParser (MWAWParserStatePtr const &state)
 constructor using a state More...
 
void setVersion (int vers)
 sets the document's version More...
 
void setGraphicListener (MWAWGraphicListenerPtr &listener)
 sets the graphic listener More...
 
void resetGraphicListener ()
 resets the listener More...
 
void setPresentationListener (MWAWPresentationListenerPtr &listener)
 sets the presentation listener More...
 
void resetPresentationListener ()
 resets the listener More...
 
void setSpreadsheetListener (MWAWSpreadsheetListenerPtr &listener)
 sets the spreadsheet listener More...
 
void resetSpreadsheetListener ()
 resets the listener More...
 
void setTextListener (MWAWTextListenerPtr &listener)
 sets the text listener More...
 
void resetTextListener ()
 resets the listener More...
 
void setAsciiName (char const *name)
 Debugging: change the default ascii file. More...
 
std::string const & asciiName () const
 return the ascii file name More...
 

Protected Attributes

std::shared_ptr< SpringBoardParserInternal::Statem_state
 the state More...
 

Friends

class SpringBoardParserInternal::SubDocument
 

Detailed Description

the main class to read a SpringBoard v1 file

Constructor & Destructor Documentation

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

constructor

SpringBoardParser::~SpringBoardParser ( )
final

destructor

Member Function Documentation

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

checks if the document header is correct (or not)

Implements MWAWParser.

Referenced by parse().

void SpringBoardParser::createDocument ( librevenge::RVNGDrawingInterface *  documentInterface)
protected

creates the listener which will be associated to the document

Referenced by parse().

bool SpringBoardParser::createZones ( )
protected

finds the different objects zones

Referenced by parse().

bool SpringBoardParser::isEntryValid ( MWAWEntry const &  entry) const
protected

returns true if the zone is a valid zone positions, ie.

exists in the file and not in a already parsed zone

Referenced by createZones(), isPositionValid(), and parseDataList().

bool SpringBoardParser::isPositionValid ( long  pos) const
protected

returns true if the position is a valid file positions, ie.

exists in the file and not in a already parsed zone

Referenced by parseLastZone(), and parseShape().

void SpringBoardParser::parse ( librevenge::RVNGDrawingInterface *  documentInterface)
finalvirtual

virtual function used to parse the input

Implements MWAWGraphicParser.

bool SpringBoardParser::parseData ( int  id,
MWAWEntry const &  entry,
MWAWVec2i const &  indices 
)
protected

try to parse some data

Referenced by parseDataList().

bool SpringBoardParser::parseDataList ( int  id,
MWAWEntry const &  entry 
)
protected

try to parse a list of data

Referenced by createZones().

bool SpringBoardParser::parseFrames ( int  page,
long  pos 
)
protected

try to parse a list of frames corresponding to a page

Referenced by parseLastZone().

bool SpringBoardParser::parseLastZone ( int  id,
MWAWEntry const &  entry 
)
protected

try to parse a second entry zones

Referenced by createZones().

bool SpringBoardParser::parsePageNumbering ( MWAWEntry const &  entry)
protected

try to parse the page numbering zone

Referenced by createZones().

bool SpringBoardParser::parseParagraphStyle ( MWAWEntry const &  entry,
MWAWVec2i const &  indices 
)
protected

try to parse a list of paragraph style: zone8

Referenced by parseDataList().

bool SpringBoardParser::parseShape ( long  pos,
std::pair< int, int > const &  pageId 
)
protected

try to parse a shape

Referenced by parseLastZone().

bool SpringBoardParser::readFont ( MWAWFont font,
int  szFieldSize 
)
protected

try to read a font

Referenced by parseData(), parsePageNumbering(), and sendTextShape().

bool SpringBoardParser::sendFrame ( std::pair< int, int > const &  pageId)
protected

try to send a frame (with a shape)

Referenced by parse().

bool SpringBoardParser::sendHeaderFooter ( int  hfId)
protected

try to send a header/footer text

bool SpringBoardParser::sendLinkShape ( std::pair< int, int > const &  linkId,
bool  isTop 
)
protected

try to send a link text

bool SpringBoardParser::sendTextShape ( std::pair< int, int > const &  pageId,
int  minParagraph = 0,
int  maxParagraph = -1 
)
protected

try to send a shape text

Friends And Related Function Documentation

Member Data Documentation


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

Generated on Thu May 30 2024 13:09:15 for libmwaw by doxygen 1.8.10