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

#include <STOFFHeader.hxx>

Public Types
typedef enum STOFFDocument::Kind	Kind
Public Member Functions
	STOFFHeader (int version=0, STOFFDocument::Kind kind=STOFFDocument::STOFF_K_TEXT)
	constructor given the input
virtual	~STOFFHeader ()
	destructor
void	reset (int vers, Kind kind=STOFFDocument::STOFF_K_TEXT)
	resets the data
int	getVersion () const
	returns the major version
void	setVersion (int version)
	sets the major version
Kind	getKind () const
	returns the document kind
void	setKind (Kind kind)
	sets the document kind
bool	isEncrypted () const
	returns true if the file is encypted
void	setEncrypted (bool encrypted)
	set the encryption mode
Static Public Member Functions
static std::vector< STOFFHeader >	constructHeader (STOFFInputStreamPtr input)
	tests the input file and returns a header if the file looks like a STOFF document ( trying first to use the resource parsed if it exists )
Private Attributes
int	m_version
	the document version
Kind	m_docKind
	the document kind
bool	m_isEncrypted
	flag to know if the file is encrypted

Detailed Description

a function used by STOFFDocument 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 STOFFDocument.

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

Member Typedef Documentation

typedef enum STOFFDocument::Kind STOFFHeader::Kind

Constructor & Destructor Documentation

STOFFHeader::STOFFHeader	(	int	version = `0`,
		STOFFDocument::Kind	kind = `STOFFDocument::STOFF_K_TEXT`
	)

constructor given the input

Parameters:

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

Referenced by constructHeader().

STOFFHeader::~STOFFHeader ( ) [virtual]

destructor

Member Function Documentation

std::vector< STOFFHeader > STOFFHeader::constructHeader ( STOFFInputStreamPtr input ) [static]

tests the input file and returns a header if the file looks like a STOFF 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 STOFFDocument implements a more complete test to recognize the difference Mac Files which share the same type of header...

Referenced by STOFFDocumentInternal::getHeader().

Kind STOFFHeader::getKind ( ) const [inline]

returns the document kind

Referenced by STOFFDocumentInternal::getGraphicParserFromHeader(), STOFFDocumentInternal::getSpreadsheetParserFromHeader(), STOFFDocumentInternal::getTextParserFromHeader(), and STOFFParserState::STOFFParserState().

int STOFFHeader::getVersion ( ) const [inline]

returns the major version

Referenced by STOFFParserState::STOFFParserState().

bool STOFFHeader::isEncrypted ( ) const [inline]

returns true if the file is encypted