STOFFHeader Class Reference

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< STOFFHeaderconstructHeader (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

◆ Kind

Constructor & Destructor Documentation

◆ STOFFHeader()

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

constructor given the input

Parameters
versionthe file version
kindthe document kind (default word processing document)

Referenced by constructHeader().

◆ ~STOFFHeader()

STOFFHeader::~STOFFHeader ( )
virtual

destructor

Member Function Documentation

◆ constructHeader()

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().

◆ getKind()

◆ getVersion()

int STOFFHeader::getVersion ( ) const
inline

returns the major version

Referenced by STOFFParserState::STOFFParserState().

◆ isEncrypted()

bool STOFFHeader::isEncrypted ( ) const
inline

returns true if the file is encypted

◆ reset()

void STOFFHeader::reset ( int vers,
Kind kind = STOFFDocument::STOFF_K_TEXT )
inline

◆ setEncrypted()

void STOFFHeader::setEncrypted ( bool encrypted)
inline

set the encryption mode

Referenced by SDAParser::checkHeader(), SDCParser::checkHeader(), and SDWParser::checkHeader().

◆ setKind()

void STOFFHeader::setKind ( Kind kind)
inline

sets the document kind

◆ setVersion()

void STOFFHeader::setVersion ( int version)
inline

sets the major version

Member Data Documentation

◆ m_docKind

Kind STOFFHeader::m_docKind
private

the document kind

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

◆ m_isEncrypted

bool STOFFHeader::m_isEncrypted
private

flag to know if the file is encrypted

Referenced by isEncrypted(), and setEncrypted().

◆ m_version

int STOFFHeader::m_version
private

the document version

Referenced by getVersion(), reset(), and setVersion().


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

Generated on Mon Apr 22 2024 12:48:55 for libstaroffice by doxygen 1.10.0