RagTime5Zone Class Reference

main zone in a RagTime v5-v6 document More...

#include <RagTime5StructManager.hxx>

List of all members.

Public Types

enum  FileType { F_Main, F_Data, F_Empty, F_Unknown }
 the zone file type More...

Public Member Functions

 RagTime5Zone (MWAWInputStreamPtr input, libmwaw::DebugFile &asc)
 constructor
virtual ~RagTime5Zone ()
 destructor
std::string getZoneName () const
 returns the zone name
bool isHeaderZone () const
 returns true if the zone is a header zone(header, list zone, ...)
std::string getKindLastPart (bool main=true) const
 returns the main type
MWAWInputStreamPtr getInput ()
 returns the current input
void setInput (MWAWInputStreamPtr input)
 reset the current input
bool isMainInput () const
 returns true if the input correspond to the basic file
libmwaw::DebugFileascii ()
 returns the current ascii file
void setAsciiFileName (std::string const &name)
 defines the ascii name
void createAsciiFile ()
 creates the ascii file

Public Attributes

FileType m_fileType
 the zone file type
int m_subType
 the zone sub type
long m_defPosition
 the position of the definition in the main zones
std::string m_kinds [2]
 the zone types: normal and packing
MWAWEntry m_entry
 the zone entry
std::string m_name
 the zone name ( mainly used for debugging)
bool m_hiLoEndian
 true if the endian is hilo
int m_ids [3]
 the zone id
int m_idsFlag [3]
 the zone flag
std::vector< MWAWEntrym_entriesList
 the list of original entries
std::string m_extra
 extra data
int m_variableD [2]
 the content of the zone D if it exists
bool m_isParsed
 a flag to know if the zone is parsed

Protected Attributes

MWAWInputStreamPtr m_input
 the main input
bool m_defaultInput
 a flag used to know if the input is or not the default input
std::string m_asciiName
 the ascii file name ( used if we need to create a ascii file)
libmwaw::DebugFilem_asciiFile
 the ascii file corresponding to an input
shared_ptr< libmwaw::DebugFilem_localAsciiFile
 the local ascii file ( if we need to create a new input)

Private Member Functions

 RagTime5Zone (RagTime5Zone const &orig)
RagTime5Zoneoperator= (RagTime5Zone const &orig)

Friends

std::ostream & operator<< (std::ostream &o, RagTime5Zone const &z)
 operator<<

Detailed Description

main zone in a RagTime v5-v6 document


Member Enumeration Documentation

the zone file type

Enumerator:
F_Main 
F_Data 
F_Empty 
F_Unknown 

Constructor & Destructor Documentation

constructor

virtual RagTime5Zone::~RagTime5Zone ( ) [inline, virtual]

destructor

RagTime5Zone::RagTime5Zone ( RagTime5Zone const &  orig) [private]

Member Function Documentation

creates the ascii file

Referenced by ascii().

std::string RagTime5Zone::getZoneName ( ) const

returns the zone name

Referenced by operator<<(), and RagTime5Parser::update().

bool RagTime5Zone::isHeaderZone ( ) const [inline]

returns true if the zone is a header zone(header, list zone, ...)

Referenced by RagTime5Parser::update().

bool RagTime5Zone::isMainInput ( ) const [inline]

returns true if the input correspond to the basic file

Referenced by RagTime5Graph::readPicture().

RagTime5Zone& RagTime5Zone::operator= ( RagTime5Zone const &  orig) [private]
void RagTime5Zone::setAsciiFileName ( std::string const &  name) [inline]

defines the ascii name

Referenced by RagTime5Parser::update().

void RagTime5Zone::setInput ( MWAWInputStreamPtr  input) [inline]

reset the current input

Referenced by RagTime5Parser::unpackZone(), and RagTime5Parser::update().


Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  o,
RagTime5Zone const &  z 
) [friend]

operator<<


Member Data Documentation

the ascii file corresponding to an input

Referenced by ascii().

std::string RagTime5Zone::m_asciiName [protected]

the ascii file name ( used if we need to create a ascii file)

Referenced by setAsciiFileName().

bool RagTime5Zone::m_defaultInput [protected]

a flag used to know if the input is or not the default input

Referenced by ascii(), isMainInput(), and setInput().

the list of original entries

Referenced by operator<<(), and RagTime5Parser::update().

the main input

Referenced by getInput(), and setInput().

the local ascii file ( if we need to create a new input)

Referenced by ascii().

std::string RagTime5Zone::m_name

the zone name ( mainly used for debugging)

Referenced by RagTime5Graph::readPictureList(), and RagTime5Graph::readPictureMatch().

the zone sub type

the content of the zone D if it exists

Referenced by operator<<(), RagTime5Zone(), and RagTime5Graph::readPictureList().


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