filters
Swinder::BoundSheetRecord Class Reference
#include <excel.h>
Inheritance diagram for Swinder::BoundSheetRecord:

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.
Public Types | |
Worksheet = 0 | |
Chart = 2 | |
VBModule = 6 | |
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 |
Static Public Attributes | |
static const unsigned int | id |
Member Enumeration Documentation
Constructor & Destructor Documentation
Swinder::BoundSheetRecord::BoundSheetRecord | ( | ) |
Creates a new BoundSheet record.
virtual Swinder::BoundSheetRecord::~BoundSheetRecord | ( | ) | [virtual] |
Destroys the BoundSheet record.
Member Function Documentation
unsigned Swinder::BoundSheetRecord::bofPosition | ( | ) | const |
Returns the position of the BOF record associated with this BoundSheet.
virtual void Swinder::BoundSheetRecord::dump | ( | std::ostream & | out | ) | const [virtual] |
virtual const char* Swinder::BoundSheetRecord::name | ( | ) | [inline, virtual] |
void Swinder::BoundSheetRecord::setBofPosition | ( | unsigned | pos | ) |
Sets the position of the BOF record associated with this BoundSheet.
virtual void Swinder::BoundSheetRecord::setData | ( | unsigned | size, | |
const unsigned char * | data | |||
) | [virtual] |
void Swinder::BoundSheetRecord::setSheetName | ( | const UString & | name | ) |
Sets the name of the sheet.
void Swinder::BoundSheetRecord::setType | ( | unsigned | type | ) |
Sets the type of the BoundSheet.
Possible values are BoundSheet::Worksheet, BoundSheet::Chart and BoundSheet::VBModule.
void Swinder::BoundSheetRecord::setVisible | ( | bool | visible | ) |
Sets the visibility of the sheet.
UString Swinder::BoundSheetRecord::sheetName | ( | ) | const |
Returns the name of the sheet.
unsigned Swinder::BoundSheetRecord::type | ( | ) | const |
Returns the type of the BoundSheet.
Possible values are BoundSheet::Worksheet, BoundSheet::Chart and BoundSheet::VBModule.
const char* Swinder::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".
bool Swinder::BoundSheetRecord::visible | ( | ) | const |
Returns true if the sheet is visible.
Member Data Documentation
const unsigned int Swinder::BoundSheetRecord::id [static] |
Static ID of the record.
Subclasses should override this value with the id of the record they handle.
Reimplemented from Swinder::Record.
The documentation for this class was generated from the following file: