Class CGridImg

class CGridImg : public CBase;

Description

Draws the contents of the grid.

Derivation

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

• CGridImg - Draws the contents of the grid.

Members

Defined in CGridImg:

• AddColToSelectedL(TInt,TSelectType)Adds a column to, or replaces, the currently selected region.
• AddRangeToSelectedL(const TRangeRef &,TSelectType)Adds the specified range to, or replaces, the currently selected region.
• AddRegionToSelectedL(const CArrayFix< TRangeRef > *,TSelectType)Adds the specified region to, or replaces, the currently selected region.
• AddRowToSelectedL(TInt,TSelectType)Adds a row to, or replaces, the currently selected region.
• AnchorPos()constGets the cursor's anchor position.
• CheckSideLabelWidth()Checks whether there has been a change in the width of the side label.
• CheckSideLabelWidthAndScrollL()Checks the side label width and, if changed, scrolls the screen.
• ClearTitleLineRegionL(const TPoint &)constClears the region where the the title lines are.
• CursorPos()constGets the current position of the cursor.
• DrawCellL(const TCellRef &)constDraws the content of the specified cell.
• DrawL(CGraphicsContext *)constDraws the entire grid and its contents.
• DrawL(CGraphicsContext *,const TRect &)constDraws the grid and its contents that are visible within the specified rectangle.
• DrawRangeL(const TRangeRef &)constDraws the rectangle corresponding to the specified range.
• DrawSelectedL()constDraws the currently selected region.
• DrawTitleLines()constDraws the title lines.
• EIsAbsoluteMoveIndicates that a new cell is being selected, without dragging.
• EIsAtBoundaryIndicates that the cursor is the edge of the grid.
• EIsColumnSelectedIndicates that a whole column is selected.
• EIsRowSelectedIndicates that a whole row is selected.
• EIsWithControlIndicates that the control modifier key has been pressed.
• EIsWithDragIndicates that a drag operation is in progress.
• EIsWithSelectIndicates that the selection state is to be maintained.
• EScaleOneToOneDefines a scale value of 100.
• ESelectAppendIndicates that a new region is to be appended to any existing selected region.
• ESelectOverwriteIndicates that an existing selected region is to be reset (i.e. emptied) before ...
• FinishLabelDragL()Deals with the end of a drag operation.
• FinishLabelResizeL(TBool)Completes the resizing of a row or column.
• GridLabelImg()constGets the the object that is used to draw a cell label.
• GridRect()constGets the rectangle containing the grid.
• MainPoint()constGets the position at which the visible range starts.
• MainRect()constGets the rectangle that corresponds to the visible range.
• MaxSideLabelWidthInPixels()constGets the maximum width of the side label.
• MoveCursorL(TMoveDirectionAndAmount,TUint)Moves the cursor to the specified position.
• NewCursorPos()constGets the new position of the cursor.
• NewL(CGraphicsDevice *,CGridCellImg *,CGridLay *)Creates a new grid image object.
• NewL(CGridCellImg *,CGridLay *)Creates a new grid image object suitable for printing.
• NotifyGridRangeResize()Resets the region boundary to the grid boundary.
• PrintGridLinesAndCellsInRangeL(CGraphicsContext *,const TRangeRef &,TInt)constPrints the grid lines and cells in the specified range.
• ResetReferencePoints()Resets the reference points.
• ResetSelectedL()Clears the selected region.
• ScrollL(const TPoint &)Scrolls the grid by the specified number of pixels.
• Selected()constGets the currently selected region.
• SetAnchorPosL(const TCellRef &)Sets the cursor's anchor position.
• SetCursorMoveCallBack(MGridCursorMoveCallBack *)Sets the cursor moved call-back object.
• SetCursorPosL(const TCellRef &)Sets the new position of the cursor.
• SetCursorWithPointerL(const TPoint &,TUint)Moves the cursor to an absolute position.
• SetGridLabelImg(CGridLabelImg *)Sets an object that draws a cell label.
• SetGridLay(CGridLay *)Sets the specified grid layout object.
• SetGridRect(const TRect &)Sets the rectangle that is to contain the grid.
• SetPrintGridRect(const TRect &)Sets the rectangle that is to contain the grid for the purpose of printing.
• SetWindow(RWindow *)Sets the specified window.
• SideLabelWidthInPixels()constGets the width of the side label.
• StartLabelDrag(const TPoint &)Deals with the start of a drag operation.
• StartLabelResize(TBool,TInt)Begins the resizing of a column or a row.
• TSelectType
• TitlePoint()constGets the position of the title.
• TopLabelHeightInPixels()constGets the height of the top labels.
• UpdateLabelDrag(const TPoint &)Deletes the dotted drag line and and redraws it at the new pointer position.
• UpdateLabelResize(TInt)Changes the size of the row or column currently being resized.
• anonymous
• anonymous
• ~CGridImg()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...

IMPORT_C virtual ~CGridImg();

Description

Destructor.

Frees resources before destruction of the object.

IMPORT_C static CGridImg* NewL(CGraphicsDevice *aGraphicsDevice, CGridCellImg *aGridCellImg, CGridLay *aGridLay);

Description

Creates a new grid image object.

Parameters

Return value

IMPORT_C static CGridImg* NewL(CGridCellImg *aGridCellImg, CGridLay *aGridLay);

Description

Creates a new grid image object suitable for printing.

Parameters

Return value

inline void SetGridLay(CGridLay *aGridLay);

Description

Sets the specified grid layout object.

Parameters

inline void SetWindow(RWindow *aWin);

Description

Sets the specified window.

Parameters

IMPORT_C void SetGridLabelImg(CGridLabelImg *aGridLabelImg);

Description

Sets an object that draws a cell label.

Parameters

inline void SetCursorMoveCallBack(MGridCursorMoveCallBack *aCursorMoveCallBack);

Description

Sets the cursor moved call-back object.

The call-back object encapsulates the implementation of a call-back function that is called whenever there is a change to the cursor position.

Parameters

inline const CGridCellRegion* Selected() const;

Description

Gets the currently selected region.

Return value

inline const CGridLabelImg* GridLabelImg() const;

Description

Gets the the object that is used to draw a cell label.

Return value

IMPORT_C void ScrollL(const TPoint &aOffset);

Description

Scrolls the grid by the specified number of pixels.

Draws the minimum necessary, i.e. grid labels, grid lines, grid cells, selected regions and the cursor.

Parameters

IMPORT_C void MoveCursorL(TMoveDirectionAndAmount aCursorMove, TUint aSelectState);

Description

Moves the cursor to the specified position.

The screen is scrolled as necessary.

Parameters

IMPORT_C void SetCursorWithPointerL(const TPoint &aPoint, TUint aFlagList);

Description

Moves the cursor to an absolute position.

Parameters

IMPORT_C void ResetSelectedL();

Description

Clears the selected region.

IMPORT_C void AddRangeToSelectedL(const TRangeRef &aRange, TSelectType aType=ESelectOverwrite);

Description

Adds the specified range to, or replaces, the currently selected region.

The range can be added to the existing selected region or it can replace the existing selected region.

Parameters

IMPORT_C void AddRegionToSelectedL(const CArrayFix< TRangeRef > *aCellRegion, TSelectType aType=ESelectOverwrite);

Description

Adds the specified region to, or replaces, the currently selected region.

The region can be added to the existing selected region, or it can replace the existing selected region.

Parameters

IMPORT_C void AddRowToSelectedL(TInt aRow, TSelectType aType=ESelectOverwrite);

Description

Adds a row to, or replaces, the currently selected region.

The row can be added to the existing selected region, or it can replace the existing selected region.

Parameters

IMPORT_C void AddColToSelectedL(TInt aCol, TSelectType aType=ESelectOverwrite);

Description

Adds a column to, or replaces, the currently selected region.

The column can be added to the existing selected region, or it can replace the existing selected region.

Parameters

IMPORT_C void DrawL(CGraphicsContext *aGc) const;

Description

Draws the entire grid and its contents.

Parameters

IMPORT_C void DrawL(CGraphicsContext *aGc, const TRect &aRect) const;

Description

Draws the grid and its contents that are visible within the specified rectangle.

Parameters

IMPORT_C void DrawCellL(const TCellRef &aCell) const;

Description

Draws the content of the specified cell.

Parameters

IMPORT_C void DrawRangeL(const TRangeRef &aRange) const;

Description

Draws the rectangle corresponding to the specified range.

Parameters

IMPORT_C void DrawSelectedL() const;

Description

Draws the currently selected region.

IMPORT_C void DrawTitleLines() const;

Description

Draws the title lines.

IMPORT_C void ClearTitleLineRegionL(const TPoint &aCrossPoint) const;

Description

Clears the region where the the title lines are.

Parameters

IMPORT_C void PrintGridLinesAndCellsInRangeL(CGraphicsContext *aPrinterGc, const TRangeRef &aRange, TInt aScaleFactor) const;

Description

Prints the grid lines and cells in the specified range.

Parameters

inline TCellRef CursorPos() const;

Description

Gets the current position of the cursor.

Return value

IMPORT_C void SetCursorPosL(const TCellRef &aCursorPos);

Description

Sets the new position of the cursor.

This is the proposed position that the cursor would occupy after a keypress.

Parameters

inline TCellRef NewCursorPos() const;

Description

Gets the new position of the cursor.

Return value

See also:

• CGridImg::SetCursorPosL(const TCellRef &)Sets the new position of the cursor.

inline TCellRef AnchorPos() const;

Description

Gets the cursor's anchor position.

This is the cell reference of the position that the cursor must return to after a series of selected movements have been made.

Return value

IMPORT_C void SetAnchorPosL(const TCellRef &aAnchorPos);

Description

Sets the cursor's anchor position.

Note that the cursor's anchor position is unchanged if the specified position lies outside the currently selected region.

Parameters

inline TRect GridRect() const;

Description

Gets the rectangle containing the grid.

Return value

IMPORT_C void SetGridRect(const TRect &aNewRect);

Description

Sets the rectangle that is to contain the grid.

Parameters

IMPORT_C void SetPrintGridRect(const TRect &aPrintRect);

Description

Sets the rectangle that is to contain the grid for the purpose of printing.

Parameters

inline TPoint TitlePoint() const;

Description

Gets the position of the title.

This is the point at the top left of the grid excluding the labels.

Return value

inline TPoint MainPoint() const;

Description

Gets the position at which the visible range starts.

Return value

inline TRect MainRect() const;

Description

Gets the rectangle that corresponds to the visible range.

Return value

IMPORT_C void ResetReferencePoints();

Description

Resets the reference points.

The reference points are the mainpoint and the titlepoint, i.e the point at which the visible range starts, and the point at the top left of the grid not including the labels.

IMPORT_C void NotifyGridRangeResize();

Description

Resets the region boundary to the grid boundary.

IMPORT_C void CheckSideLabelWidthAndScrollL();

Description

Checks the side label width and, if changed, scrolls the screen.

IMPORT_C TInt CheckSideLabelWidth();

Description

Checks whether there has been a change in the width of the side label.

Return value

IMPORT_C TInt SideLabelWidthInPixels() const;

Description

Gets the width of the side label.

Return value

IMPORT_C TInt MaxSideLabelWidthInPixels() const;

Description

Gets the maximum width of the side label.

Return value

IMPORT_C TInt TopLabelHeightInPixels() const;

Description

Gets the height of the top labels.

Return value

IMPORT_C void FinishLabelDragL();

Description

Deals with the end of a drag operation.

Typically, the function is called whan handling a pointer event in a control.

The function removes the dotted drag line indicating a drag operation, and, if necessary, updates the column width/row height, and then scrolls and redraws the necessary regions.

See also:

• CGridImg::StartLabelDrag(const TPoint &)Deals with the start of a drag operation.

IMPORT_C TBool StartLabelDrag(const TPoint &aPoint);

Description

Deals with the start of a drag operation.

Typically, the function is called whan handling a pointer event in a control.

The function checks that the pointer event is within 10 pixels of the boundary between label cells, and draws a dotted line along the row or column boundary together with pairs of arrows on either side of that line, and prepares for the continuation or end of a drag operation on the boundary separating a row or a column (to expand or contract that row or column).

The dotted line is a visual indication that a drag operation is in progress.

Parameters

Return value

IMPORT_C TBool UpdateLabelDrag(const TPoint &aPoint);

Description

Deletes the dotted drag line and and redraws it at the new pointer position.

Typically, the function is called whan handling a pointer event in a control.

Parameters

Return value

IMPORT_C TBool StartLabelResize(TBool aIsColumnLabel, TInt aIndex);

Description

Begins the resizing of a column or a row.

Parameters

Return value

IMPORT_C TBool UpdateLabelResize(TInt aDelta);

Description

Changes the size of the row or column currently being resized.

Parameters

Return value

IMPORT_C void FinishLabelResizeL(TBool aResize);

Description

Completes the resizing of a row or column.

Parameters

n/a

Description

n/a

Description

TSelectType

Description