filters

Swinder::BoundSheetRecord Class Reference

#include <excel.h>

Inheritance diagram for Swinder::BoundSheetRecord:

Swinder::Record

List of all members.


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

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 = 0x0085

Member Enumeration Documentation

anonymous enum

Type of the sheet.

Definition at line 714 of file excel.h.


Constructor & Destructor Documentation

BoundSheetRecord::BoundSheetRecord (  ) 

Creates a new BoundSheet record.

Definition at line 1926 of file excel.cpp.

BoundSheetRecord::~BoundSheetRecord (  )  [virtual]

Destroys the BoundSheet record.

Definition at line 2002 of file excel.cpp.


Member Function Documentation

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.

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.

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.

void BoundSheetRecord::setVisible ( bool  visible  ) 

Sets the visibility of the sheet.

Definition at line 1972 of file excel.cpp.

bool BoundSheetRecord::visible (  )  const

Returns true if the sheet is visible.

Definition at line 1977 of file excel.cpp.

void BoundSheetRecord::setSheetName ( const UString name  ) 

Sets the name of the sheet.

Definition at line 1982 of file excel.cpp.

UString BoundSheetRecord::sheetName (  )  const

Returns the name of the sheet.

Definition at line 1987 of file excel.cpp.

void BoundSheetRecord::setBofPosition ( unsigned  pos  ) 

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

Definition at line 1992 of file excel.cpp.

unsigned BoundSheetRecord::bofPosition (  )  const

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

Definition at line 1997 of file excel.cpp.

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.

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

Returns the name of the record.

For debugging only.

Reimplemented from Swinder::Record.

Definition at line 767 of file excel.h.

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.


Member Data Documentation

const unsigned int BoundSheetRecord::id = 0x0085 [static]

Static ID of the record.

Subclasses should override this value with the id of the record they handle.

Reimplemented from Swinder::Record.

Definition at line 695 of file excel.h.


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