FWEntry Struct Reference

the definition of a zone in the file More...

#include <FWParser.hxx>

Inheritance diagram for FWEntry:
MWAWEntry

Public Member Functions

 FWEntry (MWAWInputStreamPtr input)
 
 ~FWEntry ()
 
void update ()
 create a inputstream, ... if needed More...
 
void closeDebugFile ()
 write the debug file, ... More...
 
libmwaw::DebugFilegetAsciiFile ()
 returns a reference to the ascii file More...
 
bool operator== (const FWEntry &a) const
 basic operator== More...
 
bool operator!= (const FWEntry &a) const
 basic operator!= More...
 
- Public Member Functions inherited from MWAWEntry
 MWAWEntry ()
 constructor More...
 
virtual ~MWAWEntry ()
 
void setBegin (long off)
 sets the begin offset More...
 
void setLength (long l)
 sets the zone size More...
 
void setEnd (long off)
 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 () const
 returns true if the zone length is positive More...
 
bool operator== (const MWAWEntry &a) const
 basic operator== More...
 
bool operator!= (const MWAWEntry &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 &newType)
 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 &typ) 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 id More...
 
void setId (int newId)
 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...
 

Public Attributes

MWAWInputStreamPtr m_input
 the input More...
 
int m_nextId
 the next entry id More...
 
int m_type
 the zone type id find in DStruct More...
 
int m_typeId
 the type id (find in FZoneFlags) More...
 
int m_values [3]
 some unknown values More...
 
WPXBinaryData m_data
 the main data ( if the entry comes from several zone ) More...
 
shared_ptr< libmwaw::DebugFilem_asciiFile
 the debug file More...
 

Private Member Functions

 FWEntry (FWEntry const &)
 
FWEntryoperator= (FWEntry const &)
 

Friends

std::ostream & operator<< (std::ostream &o, FWEntry const &entry)
 operator<< More...
 

Additional Inherited Members

- Protected Attributes inherited from MWAWEntry
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
 an 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...
 

Detailed Description

the definition of a zone in the file

Constructor & Destructor Documentation

FWEntry::FWEntry ( MWAWInputStreamPtr  input)
FWEntry::~FWEntry ( )
FWEntry::FWEntry ( FWEntry const &  )
private

Member Function Documentation

void FWEntry::closeDebugFile ( )

write the debug file, ...

Referenced by ~FWEntry().

libmwaw::DebugFile & FWEntry::getAsciiFile ( )

returns a reference to the ascii file

bool FWEntry::operator!= ( const FWEntry a) const
inline

basic operator!=

FWEntry& FWEntry::operator= ( FWEntry const &  )
private
bool FWEntry::operator== ( const FWEntry a) const

basic operator==

Referenced by operator!=().

void FWEntry::update ( )

create a inputstream, ... if needed

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  o,
FWEntry const &  entry 
)
friend

operator<<

Member Data Documentation

shared_ptr<libmwaw::DebugFile> FWEntry::m_asciiFile

the debug file

Referenced by closeDebugFile(), getAsciiFile(), and update().

WPXBinaryData FWEntry::m_data

the main data ( if the entry comes from several zone )

Referenced by closeDebugFile(), and update().

MWAWInputStreamPtr FWEntry::m_input

the input

Referenced by operator==(), and update().

int FWEntry::m_nextId

the next entry id

Referenced by operator==().

int FWEntry::m_type

the zone type id find in DStruct

Referenced by operator<<(), and operator==().

int FWEntry::m_typeId

the type id (find in FZoneFlags)

Referenced by operator<<(), operator==(), and update().

int FWEntry::m_values[3]

some unknown values

Referenced by FWEntry(), operator<<(), and operator==().


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

Generated on Mon Jul 1 2013 23:58:00 for libmwaw by doxygen 1.8.4