filters

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

#include <excel.h>

Inheritance diagram for Swinder::BoundSheetRecord:
Swinder::Record

Public Types

enum  { Worksheet =0 , Chart =2 , VBModule =6 }

Public Member Functions

unsigned int rtti ()
 BoundSheetRecord ()
virtual ~BoundSheetRecord ()
void setType (unsigned type)
unsigned type () const
const char * typeAsString () const
void setVisible (bool visible)
bool visible () const
void setSheetName (const UString &name)
UString sheetName () const
void setBofPosition (unsigned pos)
unsigned bofPosition () const
virtual void setData (unsigned size, const unsigned char *data)
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 = 0x0085
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

Sheet information.

Class BoundSheetRecord represents BoundSheet record, which defines a sheet within the workbook. There must be exactly one BoundSheet record for each sheet.

BoundSheet record stores information about sheet type, sheet name, and the corresponding BOF record.

See also
BOFRecord

Definition at line 691 of file excel.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Type of the sheet.

Definition at line 714 of file excel.h.

Constructor & Destructor Documentation

◆ BoundSheetRecord()

BoundSheetRecord::BoundSheetRecord ( )

Creates a new BoundSheet record.

Definition at line 1926 of file excel.cpp.

◆ ~BoundSheetRecord()

BoundSheetRecord::~BoundSheetRecord ( )
virtual

Destroys the BoundSheet record.

Definition at line 2002 of file excel.cpp.

Member Function Documentation

◆ bofPosition()

unsigned BoundSheetRecord::bofPosition ( ) const

Returns the position of the BOF record associated with this BoundSheet.

Definition at line 1997 of file excel.cpp.

◆ dump()

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

Dumps record information to output stream.

For debugging only.

Reimplemented from Swinder::Record.

Definition at line 2027 of file excel.cpp.

◆ name()

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

Returns the name of the record.

For debugging only.

Reimplemented from Swinder::Record.

Definition at line 767 of file excel.h.

◆ rtti()

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

Reimplemented from Swinder::Record.

Definition at line 697 of file excel.h.

◆ setBofPosition()

void BoundSheetRecord::setBofPosition ( unsigned pos)

Sets the position of the BOF record associated with this BoundSheet.

Definition at line 1992 of file excel.cpp.

◆ setData()

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

Sets the data for this record.

Reimplemented from Swinder::Record.

Definition at line 2007 of file excel.cpp.

◆ setSheetName()

void BoundSheetRecord::setSheetName ( const UString & name)

Sets the name of the sheet.

Definition at line 1982 of file excel.cpp.

◆ setType()

void BoundSheetRecord::setType ( unsigned type)

Sets the type of the BoundSheet.

Possible values are BoundSheet::Worksheet, BoundSheet::Chart and BoundSheet::VBModule.

Definition at line 1935 of file excel.cpp.

◆ setVisible()

void BoundSheetRecord::setVisible ( bool visible)

Sets the visibility of the sheet.

Definition at line 1972 of file excel.cpp.

◆ sheetName()

UString BoundSheetRecord::sheetName ( ) const

Returns the name of the sheet.

Definition at line 1987 of file excel.cpp.

◆ type()

unsigned BoundSheetRecord::type ( ) const

Returns the type of the BoundSheet.

Possible values are BoundSheet::Worksheet, BoundSheet::Chart and BoundSheet::VBModule.

Definition at line 1946 of file excel.cpp.

◆ typeAsString()

const char * BoundSheetRecord::typeAsString ( ) const

Returns the type of the BoundSheet as string.

For example, if type of BoundSheet is BoundSheet::Chart, then this function returns "Chart".

Definition at line 1959 of file excel.cpp.

◆ visible()

bool BoundSheetRecord::visible ( ) const

Returns true if the sheet is visible.

Definition at line 1977 of file excel.cpp.

Member Data Documentation

◆ id

const unsigned int BoundSheetRecord::id = 0x0085
static

Definition at line 695 of file excel.h.

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