filters

Swinder::BOFRecord Class Reference

#include <excel.h>

Inheritance diagram for Swinder::BOFRecord:

Swinder::Record List of all members.

Detailed Description

Beginning of file/set of records.

Class BOFRecord represents BOF (Beginning of File) record, which is used to mark beginning of a set of records (following the BOF record). For each BOF record, there should also be one corresponding EOF record.

Note that the name "BOF" is rather misleading. This is because of historical reason only.

See also:
EOFRecord

Definition at line 473 of file excel.h.


Public Types

enum  {
  UnknownType = 0, Workbook, Worksheet, Chart,
  VBModule, MacroSheet, Workspace
}

Public Member Functions

unsigned int rtti ()
 BOFRecord ()
virtual ~BOFRecord ()
virtual void setData (unsigned size, const unsigned char *data)
unsigned version () const
const char * versionAsString () const
unsigned type () const
const char * typeAsString () const
virtual const char * name ()
virtual void dump (std::ostream &out) const

Static Public Attributes

static const unsigned int id

Member Enumeration Documentation

anonymous enum
 

Supported BOF type.

Definition at line 489 of file excel.h.


Constructor & Destructor Documentation

Swinder::BOFRecord::BOFRecord  ) 
 

Creates a new BOF record.

virtual Swinder::BOFRecord::~BOFRecord  )  [virtual]
 

Destroys the record.


Member Function Documentation

virtual void Swinder::BOFRecord::dump std::ostream &  out  )  const [virtual]
 

Dumps record information to output stream.

For debugging only.

Reimplemented from Swinder::Record.

virtual const char* Swinder::BOFRecord::name  )  [inline, virtual]
 

Returns the name of the record.

For debugging only.

Reimplemented from Swinder::Record.

Definition at line 526 of file excel.h.

virtual void Swinder::BOFRecord::setData unsigned  size,
const unsigned char *  data
[virtual]
 

Sets the data for this record.

Reimplemented from Swinder::Record.

unsigned Swinder::BOFRecord::type  )  const
 

Returns type of the BOF record, like Workbook, Chart, and so on.

const char* Swinder::BOFRecord::typeAsString  )  const
 

Returns BOF type as string, something like "Worksheet".

unsigned Swinder::BOFRecord::version  )  const
 

Returns the version, like Excel95, Excel97, and so on.

Note that it is possible to use expression like 'version() >= Excel97' but always do that carefully.

const char* Swinder::BOFRecord::versionAsString  )  const
 

Returns the version as string, something like "Excel97".


Member Data Documentation

const unsigned int Swinder::BOFRecord::id [static]
 

Static ID of the BOF record.

Reimplemented from Swinder::Record.

Definition at line 480 of file excel.h.


The documentation for this class was generated from the following file:
KDE Home | KDE Accessibility Home | Description of Access Keys