filters

Public Types | Public Member Functions | Static Public Attributes | List of all members
Swinder::BOFRecord Class Reference

#include <excel.h>

Inheritance diagram for Swinder::BOFRecord:
Swinder::Record

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
Public Member Functions inherited from Swinder::Record
 Record ()
virtual ~Record ()
void setVersion (unsigned v)
unsigned version ()
void setPosition (unsigned pos)
unsigned position () const

Static Public Attributes

static const unsigned int id = 0x0809
Static Public Attributes inherited from Swinder::Record
static const unsigned int id = 0

Additional Inherited Members

Static Public Member Functions inherited from Swinder::Record
static Record * create (unsigned type)
Protected Attributes inherited from Swinder::Record
unsigned stream_position
unsigned ver

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 480 of file excel.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Supported BOF type.

Definition at line 496 of file excel.h.

Constructor & Destructor Documentation

◆ BOFRecord()

BOFRecord::BOFRecord ( )

Creates a new BOF record.

Definition at line 1704 of file excel.cpp.

◆ ~BOFRecord()

BOFRecord::~BOFRecord ( )
virtual

Destroys the record.

Definition at line 1717 of file excel.cpp.

Member Function Documentation

◆ dump()

void BOFRecord::dump ( std::ostream & out) const
virtual

Dumps record information to output stream.

For debugging only.

Reimplemented from Swinder::Record.

Definition at line 1796 of file excel.cpp.

◆ name()

virtual const char * Swinder::BOFRecord::name ( )
inlinevirtual

Returns the name of the record.

For debugging only.

Reimplemented from Swinder::Record.

Definition at line 533 of file excel.h.

◆ rtti()

unsigned int Swinder::BOFRecord::rtti ( )
inlinevirtual

Reimplemented from Swinder::Record.

Definition at line 489 of file excel.h.

◆ setData()

void BOFRecord::setData ( unsigned size,
const unsigned char * data )
virtual

Sets the data for this record.

Reimplemented from Swinder::Record.

Definition at line 1722 of file excel.cpp.

◆ type()

unsigned BOFRecord::type ( ) const

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

Definition at line 1764 of file excel.cpp.

◆ typeAsString()

const char * BOFRecord::typeAsString ( ) const

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

Definition at line 1780 of file excel.cpp.

◆ version()

unsigned 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.

Definition at line 1740 of file excel.cpp.

◆ versionAsString()

const char * BOFRecord::versionAsString ( ) const

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

Definition at line 1752 of file excel.cpp.

Member Data Documentation

◆ id

const unsigned int BOFRecord::id = 0x0809
static

Static ID of the BOF record.

Definition at line 487 of file excel.h.

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