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(const TDesC &,const TDesC &)Renames a worksheet.
• Count()constGets the number of worksheets in the workbook.
• CreateWorkSheetL(const TDesC &)Creates a new worksheet.
• CurrentWorkSheet()constGets the current worksheet.
• CurrentWorkSheetNo()constGets the index of the current worksheet.
• DeleteWorkSheetL(const TDesC &)Deletes a worksheet.
• EShgBadCharAsteriskAsterisk.
• EShgBadCharBackSlashBack slash.
• EShgBadCharColonColon,
• EShgBadCharForwardSlashForward slash.
• EShgBadCharOpenSquareBracketOpen square bracket.
• EShgBadCharWorkSheetNameDelimiterSingle quote.
• EditOperationComplete()Marks the completion of an edit operation.
• RestoreL(const CStreamStore &,TStreamId)Restores the object.
• SetCurrentWorkSheet(const TDesC &)Sets the current worksheet.
• SheetEngine()constGets the spreadsheet engine set for this object.
• StartEditOperation()Marks the start of an edit operation.
• StoreL(CStreamStore &)constStores the object.
• TShgInvalidWorkSheetNameCharsSpecifies characters that are not allowed in worksheet names.
• WorkSheet(TInt)constGets a worksheet specified by index.
• WorkSheet(const TDesC &)constGets a worksheet specified by name.
• WorkSheetNo(const TDesC &)constGets the index of a named worksheet.
• ~CShgWorkBook()Destructor.

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

virtual ~CShgWorkBook();

Description

Destructor.

inline CSheetEngine* SheetEngine() const;

Description

Gets the spreadsheet engine set for this object.

Return value

IMPORT_C TStreamId StoreL(CStreamStore &aStore) const;

Description

Stores the object.

Parameters

Return value

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

Description

Restores the object.

Parameters

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

Description

Gets a worksheet specified by name.

Parameters

Return value

IMPORT_C CShgWorkSheet* WorkSheet(TInt aWorkSheetNo) const;

Description

Gets a worksheet specified by index.

Parameters

Return value

IMPORT_C void SetCurrentWorkSheet(const TDesC &aName);

Description

Sets the current worksheet.

Parameters

IMPORT_C CShgWorkSheet* CurrentWorkSheet() const;

Description

Gets the current worksheet.

Return value

IMPORT_C TShgError CreateWorkSheetL(const TDesC &aName);

Description

Creates a new worksheet.

Parameters

Return value

IMPORT_C TShgError DeleteWorkSheetL(const TDesC &aName);

Description

Deletes a worksheet.

Parameters

Return value

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

Description

Renames a worksheet.

Parameters

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

IMPORT_C TInt WorkSheetNo(const TDesC &aName) const;

Description

Gets the index of a named worksheet.

Parameters

Return value

IMPORT_C TInt CurrentWorkSheetNo() const;

Description

Gets the index of the current worksheet.

Return value

TShgInvalidWorkSheetNameChars

Description

Specifies characters that are not allowed in worksheet names.