BeagleWksText Class Reference

the main class to read the text part of BeagleWorks Text file More...

#include <BeagleWksText.hxx>

Public Member Functions

 BeagleWksText (BeagleWksParser &parser)
 constructor More...
 
virtual ~BeagleWksText ()
 destructor More...
 
int version () const
 returns the file version More...
 
int numPages () const
 returns the number of pages More...
 

Protected Member Functions

bool createZones (MWAWEntry &entry)
 try to create the text zones More...
 
bool sendMainText ()
 send a main zone More...
 
void flushExtra ()
 sends the data which have not yet been sent to the listener More...
 
void countPages ()
 update the number of pages and the number of page by section More...
 
std::shared_ptr< MWAWSubDocumentgetHeader (int page, int &numSimillar)
 return an header subdocument More...
 
std::shared_ptr< MWAWSubDocumentgetFooter (int page, int &numSimillar)
 return a footer subdocument More...
 
void updatePageSpanList (std::vector< MWAWPageSpan > &spanList)
 update the page span list More...
 
bool sendText (MWAWEntry const &entry)
 try to send a text zone More...
 
bool sendHF (int hfId, int sectId)
 try to send a header/footer id More...
 
MWAWFont getFont (BeagleWksTextInternal::Font const &ft) const
 returns the font More...
 
bool readFont (BeagleWksTextInternal::Font &font, long endPos)
 try to read a font properties More...
 
bool readParagraph (MWAWParagraph &para, long endPos, bool inSection=false)
 try to read a paragraph knowing end pos More...
 
bool readSection (MWAWEntry const &entry, BeagleWksTextInternal::Section &section)
 try to read a section More...
 

Protected Attributes

MWAWParserStatePtr m_parserState
 the parser state More...
 
std::shared_ptr< BeagleWksTextInternal::Statem_state
 the state More...
 
std::shared_ptr< BeagleWksStructManagerm_structureManager
 the structure manager More...
 
BeagleWksParserm_mainParser
 the main parser; More...
 

Private Member Functions

 BeagleWksText (BeagleWksText const &orig)=delete
 
BeagleWksTextoperator= (BeagleWksText const &orig)=delete
 

Friends

class BeagleWksParser
 
class BeagleWksTextInternal::SubDocument
 

Detailed Description

the main class to read the text part of BeagleWorks Text file

Constructor & Destructor Documentation

◆ BeagleWksText() [1/2]

BeagleWksText::BeagleWksText ( BeagleWksParser parser)
explicit

constructor

◆ ~BeagleWksText()

BeagleWksText::~BeagleWksText ( )
virtual

destructor

◆ BeagleWksText() [2/2]

BeagleWksText::BeagleWksText ( BeagleWksText const &  orig)
privatedelete

Member Function Documentation

◆ countPages()

void BeagleWksText::countPages ( )
protected

update the number of pages and the number of page by section

Referenced by numPages().

◆ createZones()

bool BeagleWksText::createZones ( MWAWEntry entry)
protected

try to create the text zones

◆ flushExtra()

void BeagleWksText::flushExtra ( )
protected

sends the data which have not yet been sent to the listener

◆ getFont()

MWAWFont BeagleWksText::getFont ( BeagleWksTextInternal::Font const &  ft) const
protected

returns the font

Referenced by sendText().

◆ getFooter()

std::shared_ptr< MWAWSubDocument > BeagleWksText::getFooter ( int  page,
int &  numSimillar 
)
protected

return a footer subdocument

◆ getHeader()

std::shared_ptr< MWAWSubDocument > BeagleWksText::getHeader ( int  page,
int &  numSimillar 
)
protected

return an header subdocument

◆ numPages()

int BeagleWksText::numPages ( ) const

returns the number of pages

◆ operator=()

BeagleWksText& BeagleWksText::operator= ( BeagleWksText const &  orig)
privatedelete

◆ readFont()

bool BeagleWksText::readFont ( BeagleWksTextInternal::Font font,
long  endPos 
)
protected

try to read a font properties

Referenced by countPages(), and sendText().

◆ readParagraph()

bool BeagleWksText::readParagraph ( MWAWParagraph para,
long  endPos,
bool  inSection = false 
)
protected

try to read a paragraph knowing end pos

Referenced by countPages(), readSection(), and sendText().

◆ readSection()

bool BeagleWksText::readSection ( MWAWEntry const &  entry,
BeagleWksTextInternal::Section section 
)
protected

try to read a section

Referenced by createZones().

◆ sendHF()

bool BeagleWksText::sendHF ( int  hfId,
int  sectId 
)
protected

try to send a header/footer id

Referenced by BeagleWksTextInternal::SubDocument::parse().

◆ sendMainText()

bool BeagleWksText::sendMainText ( )
protected

send a main zone

◆ sendText()

bool BeagleWksText::sendText ( MWAWEntry const &  entry)
protected

try to send a text zone

Referenced by flushExtra(), sendHF(), and sendMainText().

◆ updatePageSpanList()

void BeagleWksText::updatePageSpanList ( std::vector< MWAWPageSpan > &  spanList)
protected

update the page span list

◆ version()

int BeagleWksText::version ( ) const

returns the file version

Friends And Related Function Documentation

◆ BeagleWksParser

friend class BeagleWksParser
friend

◆ BeagleWksTextInternal::SubDocument

Member Data Documentation

◆ m_mainParser

BeagleWksParser* BeagleWksText::m_mainParser
protected

the main parser;

Referenced by readSection(), and sendText().

◆ m_parserState

MWAWParserStatePtr BeagleWksText::m_parserState
protected

◆ m_state

std::shared_ptr<BeagleWksTextInternal::State> BeagleWksText::m_state
protected

◆ m_structureManager

std::shared_ptr<BeagleWksStructManager> BeagleWksText::m_structureManager
protected

the structure manager

Referenced by getFont().


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

Generated on Fri Sep 18 2020 18:14:52 for libmwaw by doxygen 1.8.20