MWAWHeader Class Reference

a function used by MWAWDocument to store the version of document More...

#include <MWAWHeader.hxx>

List of all members.

Public Types
typedef enum MWAWDocument::Type	Type
typedef enum MWAWDocument::Kind	Kind
Public Member Functions
	MWAWHeader (MWAWDocument::Type type=MWAWDocument::MWAW_T_UNKNOWN, int version=0, MWAWDocument::Kind kind=MWAWDocument::MWAW_K_TEXT)
	constructor given the input
virtual	~MWAWHeader ()
	destructor
void	reset (MWAWDocument::Type type, int vers, Kind kind=MWAWDocument::MWAW_K_TEXT)
	resets the data
int	getMajorVersion () const
	returns the major version
void	setMajorVersion (int version)
	sets the major version
Type	getType () const
	returns the document type
void	setType (Type type)
	sets the document type
Kind	getKind () const
	returns the document kind
void	setKind (Kind kind)
	sets the document kind
Static Public Member Functions
static std::vector< MWAWHeader >	constructHeader (MWAWInputStreamPtr input, shared_ptr< MWAWRSRCParser > rsrcParser)
	tests the input file and returns a header if the file looks like a MWAW document ( trying first to use the resource parsed if it exists )
Private Attributes
int	m_version
	the document version
Type	m_docType
	the document type
Kind	m_docKind
	the document kind

---

Detailed Description

a function used by MWAWDocument to store the version of document

This class is responsible for finding a list of potential formats corresponding to a file, this list will latter be checked by calling the corresponding parser's function checkHeader via MWAWDocument.

This class also allows to store the document type, king and version.

---

Member Typedef Documentation

typedef enum MWAWDocument::Kind MWAWHeader::Kind

typedef enum MWAWDocument::Type MWAWHeader::Type

---

Constructor & Destructor Documentation

MWAWHeader::MWAWHeader	(	MWAWDocument::Type	type = MWAWDocument::MWAW_T_UNKNOWN,
		int	version = 0,
		MWAWDocument::Kind	kind = MWAWDocument::MWAW_K_TEXT
	)

constructor given the input

Parameters:

type	the document type
version	the file version
kind	the document kind (default word processing document)

MWAWHeader::~MWAWHeader

(

)

[virtual]

destructor

---

Member Function Documentation

std::vector< MWAWHeader > MWAWHeader::constructHeader	(	MWAWInputStreamPtr	input,
		shared_ptr< MWAWRSRCParser >	rsrcParser
	)		[static]

tests the input file and returns a header if the file looks like a MWAW document ( trying first to use the resource parsed if it exists )

So far, we have identified.

Note:

this check phase can only be partial ; ie. we only test the first bytes of the file and/or the existence of some oles. This explains that MWAWDocument implements a more complete test to recognize the difference Mac Files which share the same type of header...

Referenced by MWAWDocumentInternal::getHeader().

Kind MWAWHeader::getKind

(

)

const [inline]

returns the document kind

Referenced by MWAWDocumentInternal::getGraphicParserFromHeader(), MWAWDocumentInternal::getPresentationParserFromHeader(), MWAWDocumentInternal::getSpreadsheetParserFromHeader(), MWAWDocumentInternal::getTextParserFromHeader(), and MWAWParserState::MWAWParserState().

int MWAWHeader::getMajorVersion

(

)

const [inline]

returns the major version

Referenced by MWAWDocumentInternal::getGraphicParserFromHeader(), MWAWDocumentInternal::getTextParserFromHeader(), and MWAWParserState::MWAWParserState().

Type MWAWHeader::getType

(

)

const [inline]

returns the document type

Referenced by MWAWDocumentInternal::getGraphicParserFromHeader(), MWAWDocumentInternal::getPresentationParserFromHeader(), MWAWDocumentInternal::getSpreadsheetParserFromHeader(), and MWAWDocumentInternal::getTextParserFromHeader().

void MWAWHeader::reset	(	MWAWDocument::Type	type,
		int	vers,
		Kind	kind = MWAWDocument::MWAW_K_TEXT
	)		[inline]

resets the data

Referenced by EDocParser::checkHeader(), MacDocParser::checkHeader(), TeachTxtParser::checkHeader(), MacPaintParser::checkHeader(), GreatWksBMParser::checkHeader(), MacWrtParser::checkHeader(), MsWrd1Parser::checkHeader(), SuperPaintParser::checkHeader(), MacDraftParser::checkHeader(), MacDrawParser::checkHeader(), ActaParser::checkHeader(), MsWksParser::checkHeader(), BeagleWksBMParser::checkHeader(), WingzParser::checkHeader(), BeagleWksParser::checkHeader(), LightWayTxtParser::checkHeader(), BeagleWksDRParser::checkHeader(), MindWrtParser::checkHeader(), BeagleWksDBParser::checkHeader(), NisusWrtParser::checkHeader(), GreatWksDocument::checkHeader(), RagTimeParser::checkHeader(), MacDrawProParser::checkHeader(), ClarisDrawParser::checkHeader(), BeagleWksSSParser::checkHeader(), WriterPlsParser::checkHeader(), FullWrtParser::checkHeader(), WriteNowParser::checkHeader(), MacWrtProParser::checkHeader(), RagTime5Parser::checkHeader(), ClarisWksDocument::checkHeader(), MoreParser::checkHeader(), ZWrtParser::checkHeader(), MsWrdParser::checkHeader(), HanMacWrdJParser::checkHeader(), MarinerWrtParser::checkHeader(), HanMacWrdKParser::checkHeader(), and MsWksDocument::checkHeader3().

void MWAWHeader::setKind

(

Kind

kind

)

[inline]

sets the document kind

Referenced by ClarisWksDocument::checkHeader().

void MWAWHeader::setMajorVersion

(

int

version

)

[inline]

sets the major version

void MWAWHeader::setType

(

Type

type

)

[inline]

sets the document type

---

Member Data Documentation

Kind MWAWHeader::m_docKind [private]

the document kind

Referenced by getKind(), reset(), and setKind().

Type MWAWHeader::m_docType [private]

the document type

Referenced by getType(), reset(), and setType().

int MWAWHeader::m_version [private]

the document version

Referenced by getMajorVersion(), reset(), and setMajorVersion().

---

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

• MWAWHeader.hxx
• MWAWHeader.cxx