RagTime5Parser Class Referencefinal

the main class to parse a RagTime 5-6 file More...

#include <RagTime5Parser.hxx>

Inheritance diagram for RagTime5Parser:
MWAWTextParser MWAWParser

Public Member Functions

 RagTime5Parser (MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header)
 constructor
 ~RagTime5Parser () final
 destructor
bool checkHeader (MWAWHeader *header, bool strict=false) final
 checks if the document header is correct (or not)
void parse (librevenge::RVNGTextInterface *documentInterface) final
 virtual function used to parse the input
Public Member Functions inherited from MWAWTextParser
 ~MWAWTextParser () override
 destructor
Public Member Functions inherited from MWAWParser
virtual ~MWAWParser ()
 virtual destructor
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::RVNGTextInterface *documentInterface)
 creates the listener which will be associated to the document
void newPage (int number, bool softBreak)
 adds a new page
void sendFootnote (int zoneId)
 creates a document to send a footnote
Protected Member Functions inherited from MWAWTextParser
 MWAWTextParser (MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header)
 constructor (protected)
 MWAWTextParser (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< RagTime5ParserInternal::Statem_state
 the state
std::shared_ptr< RagTime5Documentm_document
 the main document manager

Friends

class RagTime5ParserInternal::SubDocument
class RagTime5Document

Detailed Description

the main class to parse a RagTime 5-6 file

Constructor & Destructor Documentation

◆ RagTime5Parser()

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

constructor

◆ ~RagTime5Parser()

RagTime5Parser::~RagTime5Parser ( )
final

destructor

Member Function Documentation

◆ checkHeader()

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

checks if the document header is correct (or not)

Implements MWAWParser.

Referenced by parse(), and RagTime5Document.

◆ createDocument()

void RagTime5Parser::createDocument ( librevenge::RVNGTextInterface * documentInterface)
protected

creates the listener which will be associated to the document

Referenced by parse(), and RagTime5Document.

◆ init()

void RagTime5Parser::init ( )
protected

inits all internal variables

Referenced by RagTime5Document, and RagTime5Parser().

◆ newPage()

void RagTime5Parser::newPage ( int number,
bool softBreak )
protected

adds a new page

Referenced by init(), and RagTime5Document.

◆ parse()

void RagTime5Parser::parse ( librevenge::RVNGTextInterface * documentInterface)
finalvirtual

virtual function used to parse the input

Implements MWAWTextParser.

Referenced by RagTime5Document.

◆ sendFootnote()

void RagTime5Parser::sendFootnote ( int zoneId)
protected

creates a document to send a footnote

Referenced by init(), and RagTime5Document.

◆ RagTime5Document

friend class RagTime5Document
friend

Referenced by init(), and RagTime5Document.

◆ RagTime5ParserInternal::SubDocument

Member Data Documentation

◆ m_document

std::shared_ptr<RagTime5Document> RagTime5Parser::m_document
protected

the main document manager

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

◆ m_state

std::shared_ptr<RagTime5ParserInternal::State> RagTime5Parser::m_state
protected

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

Generated on Sun Jun 29 2025 04:36:29 for libmwaw by doxygen 1.14.0