Class CShgWorkBook

class CShgWorkBook : public CBase;

Description

A spreadsheet engine workbook.

A workbook defines an array of worksheets (CShgWorkSheet).

Derivation

• CBase - Base class for all classes to be instantiated on the heap

• CShgWorkBook - A spreadsheet engine workbook

Members

Defined in CShgWorkBook:
ChangeNameL(), Count(), CreateWorkSheetL(), CurrentWorkSheet(), CurrentWorkSheetNo(), DeleteWorkSheetL(), EShgBadCharAsterisk, EShgBadCharBackSlash, EShgBadCharColon, EShgBadCharForwardSlash, EShgBadCharOpenSquareBracket, EShgBadCharWorkSheetNameDelimiter, EditOperationComplete(), RestoreL(), SetCurrentWorkSheet(), SheetEngine(), StartEditOperation(), StoreL(), TShgInvalidWorkSheetNameChars, WorkSheet(), WorkSheet(), WorkSheetNo(), ~CShgWorkBook()

Inherited from CBase:
Delete(), Extension_(), operator new()

virtual ~CShgWorkBook();

Description

Destructor.

inline CSheetEngine *SheetEngine() const;

Description

Gets the spreadsheet engine set for this object.

Return value

CSheetEngine * Spreadsheet engine

IMPORT_C TStreamId StoreL(CStreamStore &aStore) const;

Description

Stores the object.

Parameters

CStreamStore &aStore Store to write to

Return value

TStreamId ID of the root stream

IMPORT_C void RestoreL(const CStreamStore &aStore, TStreamId aStreamId);

Description

Restores the object.

Parameters

const CStreamStore &aStore Store to read from TStreamId aStreamId ID of the root stream

IMPORT_C CShgWorkSheet *WorkSheet(const TDesC &aName) const;

Description

Gets a worksheet specified by name.

Parameters

const TDesC &aName Worksheet name

Return value

CShgWorkSheet * Worksheet named aName

IMPORT_C CShgWorkSheet *WorkSheet(TInt aWorkSheetNo) const;

Description

Gets a worksheet specified by index.

Parameters

TInt aWorkSheetNo Worksheet index

Return value

CShgWorkSheet * Worksheet with index aWorkSheetNo

IMPORT_C void SetCurrentWorkSheet(const TDesC &aName);

Description

Sets the current worksheet.

Parameters

const TDesC &aName Worksheet name

IMPORT_C CShgWorkSheet *CurrentWorkSheet() const;

Description

Gets the current worksheet.

Return value

CShgWorkSheet * Current worksheet

IMPORT_C TShgError CreateWorkSheetL(const TDesC &aName);

Description

Creates a new worksheet.

Parameters

const TDesC &aName Worksheet name

Return value

TShgError EShgNoError or another error code

IMPORT_C TShgError DeleteWorkSheetL(const TDesC &aName);

Description

Deletes a worksheet.

Parameters

const TDesC &aName Worksheet name

Return value

TShgError EShgNoError or other error code

IMPORT_C void ChangeNameL(const TDesC &aOldName, const TDesC &aNewName);

Description

Renames a worksheet.

Parameters

const TDesC &aOldName Current worksheet name const TDesC &aNewName New worksheet name

IMPORT_C void StartEditOperation();

Description

Marks the start of an edit operation.

IMPORT_C void EditOperationComplete();

Description

Marks the completion of an edit operation.

IMPORT_C TInt Count() const;

Description

Gets the number of worksheets in the workbook.

Return value

TInt Number of worksheets in the workbook

IMPORT_C TInt WorkSheetNo(const TDesC &aName) const;

Description

Gets the index of a named worksheet.

Parameters

const TDesC &aName Worksheet name

Return value

TInt Index of the named worksheet, or KErrNotFound.

IMPORT_C TInt CurrentWorkSheetNo() const;

Description

Gets the index of the current worksheet.

Return value

TInt Index of the current worksheet

TShgInvalidWorkSheetNameChars

Description

Specifies characters that are not allowed in worksheet names.

EShgBadCharAsterisk Asterisk. EShgBadCharForwardSlash Forward slash. EShgBadCharBackSlash Back slash. EShgBadCharColon Colon, EShgBadCharOpenSquareBracket Open square bracket. This is allowed unless at the start of a name. EShgBadCharWorkSheetNameDelimiter Single quote. This is allowed unless at the start or end of a name.