Class CShgWorkSheet

class CShgWorkSheet : public CBase, public MShgCellReader;

Description

A spreadsheet engine worksheet.

Derivation

• MShgCellReader - Interface to read a specified cell.
• CBase - Base class for all classes to be instantiated on the heap.

• CShgWorkSheet - A spreadsheet engine worksheet.

Members

Defined in CShgWorkSheet:

• AddCellInsideEditOperationL(const TShgCell &)Adds a cell to a worksheet, assuming an edit operation is in progress.
• BottomRight()constGets the cell at the bottom right of the worksheet.
• CellWasChangedByLastEditOperation(const TCellRef &)constTests if a specified cell was changed by the last edit operation.
• ClearL(const CArrayFix< TRangeRef > *,TUint32)Clears an array of ranges.
• ClearL(const TCellRef &,TUint32)Clears a cell.
• CopyL(CStreamStore &,CStreamDictionary &,const CArrayFix< TRangeRef > *)constCopies an array of ranges to the clipboard.
• CopyL(CStreamStore &,CStreamDictionary &,const TCellRef &)constCopies a cell to the clipboard.
• DefaultAdditionalData()constGets default additional data for the worksheet.
• DeleteCellInsideEditOperationL(const TCellRef &)Deletes a cell from a worksheet, assuming an edit operation is in progress.
• EClearAdditionalDataClear cell additional data.
• EClearAllClear cell contents and additional data.
• EClearContentsClear cell contents.
• EDeleteCellsInRangeObliteratedAllow existing cells to be overwritten.
• EDisallowCellsInRangeObliteratedDo not allow existing cells to be overwritten.
• EPasteActionAddResult is the addition of the copied values to the existing values.
• EPasteActionDivideResult is the division of the existing values by the copied values.
• EPasteActionMultiplyResult is the multiplication of the copied values by the existing values.
• EPasteActionOverwriteOverwrite existing data.
• EPasteActionSubtractResult is the subtraction of the copied values from the existing values.
• EPasteAdditionalDataPaste additional data only.
• EPasteAllPaste all.
• EPasteFormulaPaste formula only.
• EPasteValuePaste value only.
• ESearchDirectionBackwardsSearch backwards.
• ESearchDirectionForwardsSearch forwards.
• ESearchOrderByColumnSearch by columns.
• ESearchOrderByRowSearch by rows.
• ESearchThroughAllSearch formulae and values.
• ESearchThroughFormulaeSearch formulae only.
• ESearchThroughValuesSearch values only.
• EShiftHorizontallyShift horizontally.
• EShiftVerticallyShift vertically.
• ESortOrientationLeftToRightSort horizontally.
• ESortOrientationTopToBottomSort vertically.
• EffectiveCharFormat(const TCellRef &,const TShgCell *)constGets the character layer formatting that applies to a cell, specified by referen...
• EffectiveCharFormatRead(const TCellRef &)constGets the character layer formatting that applies to a specified cell.
• EffectiveNumberFormat(const TCellRef &,const TShgCell *)constGets the number format for a cell, specified by reference or by object.
• EffectiveNumberFormatRead(const TCellRef &)constGets the number format for a specified cell.
• EffectiveParaFormat(const TCellRef &,const TShgCell *)constGets the paragraph layer formatting that applies to a cell, specified by referen...
• EffectiveParaFormatRead(const TCellRef &)constGets the paragraph layer formatting that applies to a specified cell.
• GridLay()constGets the worksheet as a Grid API layer object.
• GridTable()constGets the worksheet as a Grid API table.
• IsAnyCellInRangeProtected(const TRangeRef &)constTests if any cell in a specified range is protected.
• IsCellProtected(const TCellRef &)constTests if a specified cell is protected.
• IsLocked()constTests if the worksheet is locked.
• Lock(TBool)Locks/unlocks the worksheet.
• MShgReadCell(const TCellRef &)constGets a specified cell.
• Name()constGets the worksheet name.
• PasteL(TRangeRef &,const TRangeRef &,const CStreamStore &,const CStreamDictionary &,TBool,TUint32,TPasteAction)Paste data from the clipboard into the worksheet.
• ProtectL(const CArrayFix< TRangeRef > *,TBool)Protects a specified array of ranges.
• ProtectL(const TCellRef &,TBool)Sets a specified cell to be protected.
• ReadFormulaCellTextL(const TShgCell &)constGets the formula text for a specified cell.
• ReadShgCell(const TCellRef &)constGets a specified cell.
• SSortKeyDefines keys for sorting operations.
• SearchL(const TDesC &,const CArrayFix< TRangeRef > *,const TCellRef &,TBool,TBool,TSearchOrder,TSearchDirection,TUint32,TBool,TBool)constSearches an array of ranges for some specified text.
• SearchL(const TDesC &,const TRangeRef &,const TCellRef &,TBool,TBool,TSearchOrder,TSearchDirection,TUint32,TBool,TBool)constSearches a range for some specified text.
• SetCellL(const TCellRef &,const TDesC &)Sets cell contents.
• SetNameL(const TDesC &)Sets the worksheet name.
• SetShowZeros(TBool)Sets whether zero values should be displayed.
• SheetEngine()constGets the spreadsheet engine used by the worksheet.
• ShiftCellsL(const TCellRef &,TInt,TInt,TShiftDirection,TShiftRule)Shifts some specified rows or columns.
• ShowZeros()constGets whether zero values should be displayed.
• SortL(const TRangeRef &,const CArrayFix< SSortKey > *,TSortOrientation)Sorts a range of cells.
• TClearParametersCell clear operation flags.
• TPasteActionCell paste action flags.
• TPasteWhatCell paste operation content flags.
• TSearchDirectionSearch direction.
• TSearchOrderSearch order.
• TSearchThroughWhatSearch content flags.
• TShiftDirectionCell shift operation directions.
• TShiftRuleCell shift operation rules.
• TSortOrientationSort orientation flags.
• UpdateAdditionalDataL(const CArrayFix< TRangeRef > *,const CShgCellAdditionalData *)Updates additional data for a specified array of ranges.
• UpdateAdditionalDataL(const TCellRef &,const CShgCellAdditionalData *)Updates additional data (formatting information) for a specified cell.
• WorkSheetNo()constGets the worksheet number.
• ~CShgWorkSheet()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 ~CShgWorkSheet();

Description

Destructor.

IMPORT_C TShgError SortL(const TRangeRef &aRangeRef, const CArrayFix< SSortKey > *aArrayOfSortKeys, TSortOrientation aSortOrientation);

Description

Sorts a range of cells.

Parameters

Return value

IMPORT_C const TShgCell* SearchL(const TDesC &aTextToFind, const CArrayFix< TRangeRef > *aRangeArrayToSearchIn, const TCellRef &aStartCell, TBool aIncludeStartCell, TBool aSearchCyclically, TSearchOrder aSearchOrder, TSearchDirection aSearchDirection, TUint32 aWhatToSearchThrough, TBool aMatchCase, TBool aFindEntireCellOnly) const;

Description

Searches an array of ranges for some specified text.

Parameters

Return value

IMPORT_C const TShgCell* SearchL(const TDesC &aTextToFind, const TRangeRef &aRangeToSearchIn, const TCellRef &aStartCell, TBool aIncludeStartCell, TBool aSearchCyclically, TSearchOrder aSearchOrder, TSearchDirection aSearchDirection, TUint32 aWhatToSearchThrough, TBool aMatchCase, TBool aFindEntireCellOnly) const;

Description

Searches a range for some specified text.

Parameters

Return value

IMPORT_C TShgError ShiftCellsL(const TCellRef &aReferenceCell, TInt aShiftAmount, TInt aExtentOfBlockShifted, TShiftDirection aShiftDirection, TShiftRule aShiftRule);

Description

Shifts some specified rows or columns.

The rows/columns to move are specified by an origin cell, plus the number of rows/columns from this point. The movement is specified by an amount and a direction.

!! disable undo until the grid-lay part can be undone too (V1.1?)

Parameters

Return value

IMPORT_C TShgError ClearL(const TCellRef &aCell, TUint32 aWhatToClear=EClearAll);

Description

Clears a cell.

Parameters

Return value

IMPORT_C TShgError ClearL(const CArrayFix< TRangeRef > *aRangeArray, TUint32 aWhatToClear=EClearAll);

Description

Clears an array of ranges.

Parameters

Return value

IMPORT_C TBool CellWasChangedByLastEditOperation(const TCellRef &aCellRef) const;

Description

Tests if a specified cell was changed by the last edit operation.

Parameters

Return value

IMPORT_C TShgError UpdateAdditionalDataL(const TCellRef &aCell, const CShgCellAdditionalData *aData);

Description

Updates additional data (formatting information) for a specified cell.

Parameters

Return value

IMPORT_C TShgError UpdateAdditionalDataL(const CArrayFix< TRangeRef > *aRangeArray, const CShgCellAdditionalData *aData);

Description

Updates additional data for a specified array of ranges.

Parameters

Return value

IMPORT_C const CParaFormatLayer* EffectiveParaFormatRead(const TCellRef &aCell) const;

Description

Gets the paragraph layer formatting that applies to a specified cell.

Parameters

Return value

IMPORT_C const CParaFormatLayer* EffectiveParaFormat(const TCellRef &aCell, const TShgCell *aShgCell) const;

Description

Gets the paragraph layer formatting that applies to a cell, specified by reference or by object.

Parameters

Return value

IMPORT_C const CCharFormatLayer* EffectiveCharFormatRead(const TCellRef &aCell) const;

Description

Gets the character layer formatting that applies to a specified cell.

Parameters

Return value

IMPORT_C const CCharFormatLayer* EffectiveCharFormat(const TCellRef &aCell, const TShgCell *aShgCell) const;

Description

Gets the character layer formatting that applies to a cell, specified by reference or by object.

Parameters

Return value

IMPORT_C TShgNumberFormat EffectiveNumberFormatRead(const TCellRef &aCell) const;

Description

Gets the number format for a specified cell.

Parameters

Return value

IMPORT_C TShgNumberFormat EffectiveNumberFormat(const TCellRef &aCell, const TShgCell *aShgCell) const;

Description

Gets the number format for a cell, specified by reference or by object.

Parameters

Return value

IMPORT_C TShgError ProtectL(const TCellRef &aCell, TBool aProtected);

Description

Sets a specified cell to be protected.

Parameters

Return value

IMPORT_C TShgError ProtectL(const CArrayFix< TRangeRef > *aRangeArray, TBool aProtected);

Description

Protects a specified array of ranges.

Parameters

Return value

IMPORT_C TBool IsCellProtected(const TCellRef &aCell) const;

Description

Tests if a specified cell is protected.

Parameters

Return value

IMPORT_C TBool IsAnyCellInRangeProtected(const TRangeRef &aRange) const;

Description

Tests if any cell in a specified range is protected.

Parameters

Return value

IMPORT_C void Lock(TBool aLocked);

Description

Locks/unlocks the worksheet.

Parameters

IMPORT_C TBool IsLocked() const;

Description

Tests if the worksheet is locked.

Return value

IMPORT_C void SetShowZeros(TBool aShowZeros);

Description

Sets whether zero values should be displayed.

Parameters

IMPORT_C TBool ShowZeros() const;

Description

Gets whether zero values should be displayed.

Return value

IMPORT_C MGridTable* GridTable() const;

Description

Gets the worksheet as a Grid API table.

Return value

IMPORT_C CSheetEngine* SheetEngine() const;

Description

Gets the spreadsheet engine used by the worksheet.

Return value

IMPORT_C TShgCell* ReadShgCell(const TCellRef &aCellRef) const;

Description

Gets a specified cell.

Parameters

Return value

IMPORT_C TPtrC ReadFormulaCellTextL(const TShgCell &aCell) const;

Description

Gets the formula text for a specified cell.

The function panics if the cell does not contain a formula.

Parameters

Return value

IMPORT_C TShgError SetCellL(const TCellRef &aCellRef, const TDesC &aText);

Description

Sets cell contents.

Parameters

Return value

IMPORT_C TShgError AddCellInsideEditOperationL(const TShgCell &aCell);

Description

Adds a cell to a worksheet, assuming an edit operation is in progress.

It assumes that CSheetEngine::StartEditOperation() and CSheetEngine::EndEditOperationL(TShgError) are called around this.

Parameters

Return value

IMPORT_C TShgError DeleteCellInsideEditOperationL(const TCellRef &aCellRef);

Description

Deletes a cell from a worksheet, assuming an edit operation is in progress.

Parameters

Return value

IMPORT_C void SetNameL(const TDesC &aName);

Description

Sets the worksheet name.

Parameters

IMPORT_C const TPtrC Name() const;

Description

Gets the worksheet name.

Return value

IMPORT_C TInt WorkSheetNo() const;

Description

Gets the worksheet number.

Return value

IMPORT_C TCellRef BottomRight() const;

Description

Gets the cell at the bottom right of the worksheet.

Return value

IMPORT_C CGridLay* GridLay() const;

Description

Gets the worksheet as a Grid API layer object.

Return value

IMPORT_C const CShgCellAdditionalData* DefaultAdditionalData() const;

Description

Gets default additional data for the worksheet.

Return value

IMPORT_C TShgError PasteL(TRangeRef &aBounds, const TRangeRef &aDestination, const CStreamStore &aStore, const CStreamDictionary &aDictionary, TBool aSkipBlanks=EFalse, TUint32 aWhatToPaste=EPasteAll, TPasteAction aPasteAction=EPasteActionOverwrite);

Description

Paste data from the clipboard into the worksheet.

The data can be plain text or spreadsheet engine cells.

Parameters

Return value

IMPORT_C void CopyL(CStreamStore &aStore, CStreamDictionary &aDictionary, const TCellRef &aCell) const;

Description

Copies a cell to the clipboard.

Parameters

IMPORT_C void CopyL(CStreamStore &aStore, CStreamDictionary &aDictionary, const CArrayFix< TRangeRef > *aRangeArray) const;

Description

Copies an array of ranges to the clipboard.

Parameters

virtual TShgCell* MShgReadCell(const TCellRef &aCellRef) const;

Description

Gets a specified cell.

Parameters

Return value

struct SSortKey;

Description

Defines keys for sorting operations.

Members

Defined in CShgWorkSheet::SSortKey:

• EDirectionAscendingAscending sort order.
• EDirectionDescendingDescending sort order.
• TDirectionSort order.
• iCaseSensitiveIf true, sorting is case-sensitive
• iCellRefDimensionPerpendicularToSortNumber of row or column, depending on which is perpendicular to the sort.
• iDirectionSort order.

Member enumerations

Enum TDirection

TDirection

Description

Sort order.

Member data

iCellRefDimensionPerpendicularToSort

TInt iCellRefDimensionPerpendicularToSort;

Description

Number of row or column, depending on which is perpendicular to the sort.

iDirection

TDirection iDirection;

Description

Sort order.

iCaseSensitive

TBool iCaseSensitive;

Description

If true, sorting is case-sensitive

TSearchOrder

Description

Search order.

TSearchDirection

Description

Search direction.

TSearchThroughWhat

Description

Search content flags.

TShiftDirection

Description

Cell shift operation directions.

TShiftRule

Description

Cell shift operation rules.

TClearParameters

Description

Cell clear operation flags.

TPasteWhat

Description

Cell paste operation content flags.

TPasteAction

Description

Cell paste action flags.

TSortOrientation

Description

Sort orientation flags.