WPSEntry Class Reference

basic class to store an entry in a file This contained : More...

`#include <WPSEntry.h>`

Inheritance diagram for WPSEntry:

## Public Member Functions

| WPSEntry ()
| constructor More...
virtual | ~WPSEntry ()
void | setBegin (long off)
| sets the begin offset More...
void | setLength (long l)
| sets the zone size More...
void | setEnd (long e)
| sets the end offset More...
long | begin () const
| returns the begin offset More...
long | end () const
| returns the end offset More...
long | length () const
| returns the length of the zone More...
bool | valid (bool checkId=false) const
| returns true if the zone length is positive More...
bool | operator== (const WPSEntry &a) const
| basic operator== More...
bool | operator!= (const WPSEntry &a) const
| basic operator!= More...
bool | isParsed () const
| a flag to know if the entry was parsed or not More...
void | setParsed (bool ok=true) const
| sets the flag m_parsed to true or false More...
void | setType (std::string const tp)
| sets the type of the entry: BTEP,FDPP, BTEC, FDPC, PLC , TEXT, ... More...
std::string const & | type () const
| returns the type of the entry More...
bool | hasType (std::string const tp) const
| returns true if the type entry == type More...
void | setName (std::string const &nam)
| sets the name of the entry More...
std::string const & | name () const
| name of the entry More...
bool | hasName (std::string const &nam) const
| checks if the entry name is equal to name More...
int | id () const
| returns the entry id More...
void | setId (int i)
| sets the id More...
std::string const & | extra () const
| retrieves the extra string More...
void | setExtra (std::string const &s)
| sets the extra string More...

## Protected Attributes

long | m_begin
| the begin of the entry. More...
long | m_length
| the size of the entry More...
std::string | m_type
| the entry type More...
std::string | m_name
| the name More...
int | m_id
| the identificator More...
bool | m_parsed
| a bool to store if the entry is or not parsed More...
std::string | m_extra
| an extra string More...

## Friends

std::ostream & | operator<< (std::ostream &o, WPSEntry const &ent)

## Detailed Description

basic class to store an entry in a file This contained :

- its begin and end positions
- its type, its name and an identificator
- a flag used to know if the file is or not parsed

## Constructor & Destructor Documentation

WPSEntry::WPSEntry | ( |  | ) |

inline

constructor

virtual WPSEntry::~WPSEntry | ( |  | ) |

inline virtual

## Member Function Documentation

long WPSEntry::begin | ( |  | ) | const

inline

returns the begin offset

Referenced by WPS8TextStyle::findFDPStructures(), WPS4Text::findFDPStructuresByHand(), WPS4Parser::findZones(), WPS8Text::getFooterEntry(), WPS8Text::getHeaderEntry(), WPS8Text::numPages(), WPS4Text::numPages(), WPS4TextInternal::operator<<(), WPS4Parser::parseEntry(), WPS8Parser::parseHeaderIndexEntry(), WPS8Graph::readBDR(), WPS8Parser::readDocProperties(), WPS4Parser::readDocWindowsInfo(), WPS4Text::readDosLink(), WPS4Text::readEntries(), WPSTextParser::readFDP(), WPS8TextStyle::readFontNames(), WPS4Text::readFontNames(), WPS8Parser::readFRAM(), WPS8Graph::readIBGF(), WPS8Table::readMCLD(), WPS8Text::readNotes(), WPS4Graph::readObject(), WPS8Graph::readPICT(), WPS4Text::readPLC(), WPS8Text::readPLC(), WPS4Parser::readPrnt(), WPS8TextStyle::readSGP(), WPS8Text::readStructures(), WPS8TextStyle::readSTSH(), WPS8Parser::readSYID(), WPS8Text::readText(), WPS4Text::readText(), and WPS8Parser::readWNPR().

long WPSEntry::end | ( |  | ) | const

inline

returns the end offset

Referenced by WPS4Text::findFDPStructuresByHand(), WPS4Parser::findZones(), WPS8Text::numPages(), WPS4Text::numPages(), WPS4TextInternal::operator<<(), WPS4Parser::parseEntry(), WPS8Parser::parseHeaderIndexEntry(), WPS8Graph::readBDR(), WPS8Parser::readDocProperties(), WPS4Parser::readDocWindowsInfo(), WPS4Text::readEntries(), WPSTextParser::readFDP(), WPS8TextStyle::readFontNames(), WPS4Text::readFontNames(), WPS8Parser::readFRAM(), WPS8Table::readMCLD(), WPS8Text::readNotes(), WPS4Graph::readObject(), WPS8Graph::readPICT(), WPS8Text::readPLC(), WPS8TextStyle::readSGP(), WPS8Text::readStructures(), WPS8TextStyle::readSTSH(), WPS8Text::readText(), WPS4Text::readText(), and WPS8Parser::readWNPR().

std::string const& WPSEntry::extra | ( |  | ) | const

inline

retrieves the extra string

Referenced by WPS8Graph::readBDR().

bool WPSEntry::hasName | ( | std::string const & | nam | ) | const

inline

checks if the entry name is equal to name

Referenced by WPS8Parser::createStructures(), WPS8TextStyle::findFDPStructures(), WPS8TextStyle::findFDPStructuresByHand(), WPS8TextStyle::readStructures(), WPS8Text::readStructures(), WPS8Table::readStructures(), WPS8Graph::readStructures(), and WPS8Graph::sendIBGF().

bool WPSEntry::hasType | ( | std::string const | tp | ) | const

inline

returns true if the type entry == type

Referenced by WPS8Parser::createStructures(), WPS8TextStyle::findFDPStructures(), WPS8TextStyle::findFDPStructuresByHand(), WPS8Graph::readBDR(), WPS8Parser::readDocProperties(), WPSTextParser::readFDP(), WPS8TextStyle::readFontNames(), WPS8Parser::readFRAM(), WPS8Graph::readIBGF(), WPS8Table::readMCLD(), WPS8Text::readNotes(), WPS8Graph::readPICT(), WPS8Text::readPLC(), WPS8TextStyle::readSGP(), WPS8TextStyle::readStructures(), WPS8Text::readStructures(), WPS8Table::readStructures(), WPS8Graph::readStructures(), WPS8TextStyle::readSTSH(), WPS8Parser::readSYID(), WPS8Parser::readWNPR(), and WPS4Parser::send().

int WPSEntry::id | ( |  | ) | const

inline

returns the entry id

Referenced by WPS8Text::createNotesCorrespondance(), WPS8Text::flushExtra(), WPS8TextInternal::State::getTextZones(), WPS8ParserInternal::operator<<(), WPS8Graph::readBDR(), WPS8Graph::readIBGF(), WPS8Text::readNotes(), WPS4Graph::readObject(), WPS8Graph::readPICT(), WPS8Text::readPLC(), WPS8Text::readStructures(), WPS8Text::readText(), WPS4Text::readText(), and WPS8Graph::sendIBGF().

bool WPSEntry::isParsed | ( |  | ) | const

inline

a flag to know if the entry was parsed or not

Referenced by WPS8Text::flushExtra(), WPS4ParserInternal::SubDocument::parse(), and WPS8ParserInternal::SubDocument::parse().

long WPSEntry::length | ( |  | ) | const

inline

returns the length of the zone

Referenced by WPS8Text::getFooterEntry(), WPS8Text::getHeaderEntry(), WPS4Parser::parseEntry(), WPS8Parser::parseHeaderIndexEntry(), WPS8Graph::readBDR(), WPS8Parser::readDocProperties(), WPS4Parser::readDocWindowsInfo(), WPS4Text::readDosLink(), WPSTextParser::readFDP(), WPS8TextStyle::readFontNames(), WPS8Parser::readFRAM(), WPS8Graph::readIBGF(), WPS8Table::readMCLD(), WPS8Text::readNotes(), WPS4Graph::readObject(), WPS4Text::readPLC(), WPS8Text::readPLC(), WPS4Parser::readPrnt(), WPS8TextStyle::readSGP(), WPS8TextStyle::readSTSH(), WPS8Parser::readSYID(), WPS8Text::readTextInCell(), and WPS8Parser::readWNPR().

std::string const& WPSEntry::name | ( |  | ) | const

inline

name of the entry

Referenced by WPS8ParserInternal::operator<<(), WPS8Graph::readBDR(), WPS8Parser::readDocProperties(), WPS8TextStyle::readFontNames(), WPS8Parser::readFRAM(), WPS8Graph::readIBGF(), WPS8Table::readMCLD(), WPS8Text::readNotes(), WPS8Graph::readPICT(), WPS8Text::readPLC(), WPS8TextStyle::readSGP(), WPS8TextStyle::readSTSH(), WPS8Parser::readSYID(), and WPS8Parser::readWNPR().

bool WPSEntry::operator!= | ( | const WPSEntry & | a | ) | const

inline

basic operator!=

bool WPSEntry::operator== | ( | const WPSEntry & | a | ) | const

inline

basic operator==

Referenced by operator!=().

void WPSEntry::setBegin | ( | long | off | ) |

inline

sets the begin offset

Referenced by WPS4Text::bkmkDataParser(), WPS4Text::findFDPStructures(), WPS4Text::findFDPStructuresByHand(), WPS4Parser::findZones(), WPS8TextInternal::Notes::getCorrespondanceEntry(), WPS8TextInternal::State::getTCDZone(), WPS4Text::objectDataParser(), WPS4Parser::parseEntry(), WPS8Parser::parseHeaderIndexEntry(), WPS4Text::readDosLink(), WPS4Text::readEntries(), WPS4Text::readFootNotes(), WPS4Text::readStructures(), and WPS8Text::textZonesDataParser().

void WPSEntry::setEnd | ( | long | e | ) |

inline

sets the end offset

Referenced by WPS4Text::bkmkDataParser(), WPS8TextInternal::Notes::getCorrespondanceEntry(), WPS8TextInternal::State::getTCDZone(), WPS4Text::readDosLink(), WPS4Text::readEntries(), WPS4Text::readFootNotes(), WPS4Text::readStructures(), and WPS8Text::textZonesDataParser().

void WPSEntry::setExtra | ( | std::string const & | s | ) |

inline

sets the extra string

Referenced by WPS8Parser::parseHeaderIndexEntryEnd().

void WPSEntry::setId | ( | int | i | ) |

inline

sets the id

Referenced by WPS4Text::bkmkDataParser(), WPS4Parser::findZones(), WPS8TextInternal::Notes::getCorrespondanceEntry(), WPS4Text::getFooterEntry(), WPS4Text::getHeaderEntry(), WPS4Text::objectDataParser(), WPS8Parser::parseHeaderIndexEntry(), WPS4Text::readDosLink(), WPS4Text::readEntries(), WPS4Text::readFootNotes(), WPS8Graph::readIBGF(), WPS8Text::readStructures(), WPS4Text::readStructures(), WPS4Text::readText(), and WPS8Text::textZonesDataParser().

void WPSEntry::setLength | ( | long | l | ) |

inline

sets the zone size

Referenced by WPS4Text::findFDPStructures(), WPS4Text::findFDPStructuresByHand(), WPS4Parser::findZones(), WPS4Text::objectDataParser(), WPS4Parser::parseEntry(), and WPS8Parser::parseHeaderIndexEntry().

void WPSEntry::setName | ( | std::string const & | nam | ) |

inline

sets the name of the entry

Referenced by WPS8Parser::parseHeaderIndexEntry(), and WPS8Graph::readIBGF().

void WPSEntry::setParsed | ( | bool | ok = `true` | ) | const

inline

sets the flag m_parsed to true or false

Referenced by WPS4ParserInternal::SubDocument::parse(), WPS8ParserInternal::SubDocument::parse(), WPS8Graph::readBDR(), WPS8Parser::readDocProperties(), WPSTextParser::readFDP(), WPS8TextStyle::readFontNames(), WPS8Parser::readFRAM(), WPS8Graph::readIBGF(), WPS8Table::readMCLD(), WPS8Text::readNotes(), WPS8Graph::readPICT(), WPS8Text::readPLC(), WPS8TextStyle::readSGP(), WPS8TextStyle::readSTSH(), WPS8Parser::readSYID(), and WPS8Parser::readWNPR().

void WPSEntry::setType | ( | std::string const | tp | ) |

inline

sets the type of the entry: BTEP,FDPP, BTEC, FDPC, PLC , TEXT, ...

Referenced by WPS4Text::findFDPStructures(), WPS4Text::findFDPStructuresByHand(), WPS4Parser::findZones(), WPS8TextInternal::Notes::getCorrespondanceEntry(), WPS4Text::getFooterEntry(), WPS4Text::getHeaderEntry(), WPS4Parser::parseEntry(), WPS8Parser::parseHeaderIndexEntry(), WPS4Text::readEntries(), WPS4Text::readFootNotes(), WPS4Text::readStructures(), WPS4Text::readText(), and WPS8Text::textZonesDataParser().

std::string const& WPSEntry::type | ( |  | ) | const

inline

returns the type of the entry

Referenced by WPS4Parser::findZones(), WPS4ParserInternal::SubDocument::parse(), WPS8ParserInternal::SubDocument::parse(), WPS4Parser::parseEntry(), WPS8Graph::readBDR(), WPS8Parser::readDocProperties(), WPS4Text::readEntries(), WPSTextParser::readFDP(), WPS8TextStyle::readFontNames(), WPS8Parser::readFRAM(), WPS8Graph::readIBGF(), WPS8Table::readMCLD(), WPS8Text::readNotes(), WPS8Graph::readPICT(), WPS4Text::readPLC(), WPS8Text::readPLC(), WPS8TextStyle::readSGP(), WPS8TextStyle::readSTSH(), WPS8Parser::readSYID(), WPS8Parser::readWNPR(), and WPS4Parser::send().

bool WPSEntry::valid | ( | bool | checkId = `false` | ) | const

inline

returns true if the zone length is positive

Referenced by WPS8Parser::createListener(), WPS4Parser::createListener(), WPS8Text::flushExtra(), WPS8Text::getFooterEntry(), WPS8Text::getHeaderEntry(), WPS8TextInternal::State::getTextZones(), WPS8ParserInternal::operator<<(), WPS4TextInternal::operator<<(), WPS4Parser::parse(), WPS8Parser::parse(), WPS4ParserInternal::SubDocument::parse(), WPS8ParserInternal::SubDocument::parse(), WPS8TextInternal::SubDocument::parse(), WPS4Parser::parseEntry(), WPS4Parser::readDocWindowsInfo(), WPS4Text::readDosLink(), WPS4Text::readEntries(), WPS4Text::readFontNames(), WPS4Text::readFootNotes(), WPS4Graph::readObject(), WPS4Parser::readPrnt(), and WPS4Text::readText().

## Friends And Related Function Documentation

std::ostream& operator<< | ( | std::ostream & | o,
|  | WPSEntry const & | ent
| ) |  |

friend

## Member Data Documentation

long WPSEntry::m_begin

protected

the begin of the entry.

Referenced by begin(), end(), operator==(), setBegin(), setEnd(), and valid().

std::string WPSEntry::m_extra

protected

an extra string

Referenced by extra(), and setExtra().

int WPSEntry::m_id

protected

the identificator

Referenced by id(), operator==(), setId(), and valid().

long WPSEntry::m_length

protected

the size of the entry

Referenced by end(), length(), operator==(), setEnd(), setLength(), and valid().

std::string WPSEntry::m_name

protected

the name

Referenced by hasName(), name(), operator==(), and setName().

bool WPSEntry::m_parsed

mutable protected

a bool to store if the entry is or not parsed

Referenced by isParsed(), and setParsed().

std::string WPSEntry::m_type

protected

the entry type

Referenced by hasType(), operator==(), setType(), and type().

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

- WPSEntry.h