CAknGridView Class Reference

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Data Structures

Enumeration flags for grid.

Enumerator:

EPrimaryIsVertical	Vertical is primary direction.
ETopToBottom	From top to bottom.
ELeftToRight	From left to right.

Enumeration flags for pages.

Enumerator:

EPreviousPage	Previous page.
ENextPage	Next page.
EHome	First page.
EEnd	Last page.

Enumerator:

EPage	Page.
EColumn	Column.
EOppositeCorner	Opposite corner.

Enumeration for different scrolling types.

Enumerator:

EScrollFollowsItemsAndStops	Scrolling follows items and stops.
EScrollFollowsItemsAndLoops	Scrolling follows items and loops.
EScrollFollowsGrid	Scrolling follows grid.
EScrollStops	Scrolling stops.
EScrollIncrementLineAndStops	Scrolls one line and stops.
EScrollIncrementLineAndLoops	Scrolls one line and loops.

Default C++ constructor.

Destructor.

Returns the actual index of given listbox index.

Parameters:

aListBoxIndex

The index of the listbox.

Returns:

The actual data index.

This function has been overloaded to draw items correctly.

Recalculates the bottom item’s index. This is called by the list box control when either the size or the number of items in its model changes.

Reimplemented from CListBoxView.

Calculates the data width in columns.

iDataWidth is calculated based on model and drawer information.

Reimplemented from CListBoxView.

This function converts a row/column pair into the item index for that item.

Parameters:

	aItemIndex	Reference to the item index.
	aRowIndex	Row index of the item.
	aColIndex	Column index of the item.

This function gets the item the view would need to be moved to in order to make the specified item visible.

Parameters:

aItemIndex

The item to make visible.

Returns:

The item to scroll to to make aItemIndex visible.

Reimplemented from CListBoxView.

Converts an item index into the (row, column) pair describing that item.

Parameters:

	aItemIndex	The item index.
	aRowIndex	Reference to the row index.
	aColIndex	Reference the column index.

Gets the number of columns that this view would need to be scrolled by to make the specified item visible.

The function returns 0 if no scrolling is needed. ScrollToMakeItemVisible() uses this function.

Parameters:

aItemIndex

Item to make visible.

Returns:

The number of columns to scroll, or zero if no scrolling is needed.

This function clears each item’s rectangle between the specified start and finish item’s indexes.

Parameters:

	aStartItemIndex	The first item to clear.
	aEndItemIndex	The last item to clear.

This function gets the width of all columns in the view.

Returns:

The width of all columns in the view, in pixels.

Returns the current data index with respect to the ordering of the cells in the grid.

Returns:

Current data index.

From CListBoxView.

This function returns the current item in the grid and -1 if there is no current item,

Returns:

The current item.

Reimplemented from CListBoxView.

Converts a logical position on the grid, where the co-ordinates are with respect to the top left hand corner of the grid, to an index for the cell with respect to the ordering of the cells in the grid.

Parameters:

	aItemIndex	Reference to the index for the cell in the grid.
	aRowIndex	The row in the grid.
	aColIndex	The column in the grid.

This function handles movement routines.

Parameters:

	aCursorMovement	Handles cursor movements etc. ECursorNextItem and ECursorPreviousItem.
	aSelectionMode	Modes for modifying the selection.

This function draws every visible item into the specified rectangle.

As implemented in CListBoxView, this function's argument is ignored and the internal viewing rectangle is used. See SetViewRect().

Parameters:

@c

TRect* aClipRect = NULL The rectangle to draw into.

Reimplemented from CListBoxView.

Reimplemented in CAknGMSStyleGridView.

This function draws every item in every column between the start and end columns inclusively.

Parameters:

	aStartColIndex	The first column to draw.
	aEndColIndex	The last column to draw.

Draws empty grid list.

This has been overloaded to ensure that only valid cells are drawn and not the empty cells.

Parameters:

aItemIndex

Index number of the item to draw.

Reimplemented from CListBoxView.

This function draws every item between the start and end indices inclusively.

Parameters:

	aStartItemIndex	The first item to draw.
	aEndItemIndex	The final item to draw.

From CListBoxView.

Basically empty implementation of CListBoxView::DrawMatcherCursor.

Reimplemented from CListBoxView.

Returns the current grid dimensions.

Returns:

The size of the current grid.

This inline function is grid model helper.

Returns:

A pointer to CAknGridM object.

Returns ETrue if the primary dimension of the grid is vertical.

Returns:

if vertical is set as primary, otherwise EFalse.

This function tests whether an item exists.

Parameters:

aListBoxIndex

Index to test.

Returns:

ETrue if the specified item exists, EFalse otherwise.

This function gets the position of the top left corner of the specified item, in pixels.

Parameters:

aItemIndex

An item in the model.

Returns:

TPoint position of the top left corner of the item, in pixels.

Reimplemented from CListBoxView.

Gets the size of the specified item.

Parameters:

aItemIndex=0

The index of the item whose size this call is to get.

Returns:

TSize The size of the item in pixels.

Reimplemented from CListBoxView.

Returns the listbox index of given data index.

Parameters:

aDataIndex

The index of the actual data.

Returns:

The index in listbox.

Converts a CEikListBox index for a cell in the grid, given with respect to the snaking listbox top down, left to right structure underlying the grid structure, to a logical position on the grid, where the co-ordinates are with respect to the top left hand corner of the grid.

Parameters:

	aItemIndex	Reference to the index for the cell in the grid.
	aRowIndex	The row in the grid.
	aColIndex	The column in the grid.

Converts an index for a cell in the grid, given with respect to the ordering of the cells in the grid, to a logical position on the grid, where the co-ordinates are with respect to the top left hand corner of the grid.

Parameters:

	aItemIndex	The index for the cell in the grid.
	aRowIndex	Reference to the row in the grid.
	aColIndex	Reference to the column in the grid.

Converts a logical position on the grid, where the co-ordinates are with respect to the top left hand corner of the grid, to a CEikListBox index for the cell with respect to the snaking listbox top down, left to right structure underlying the grid structure.

Parameters:

	aItemIndex	The index for the cell in the grid.
	aRowIndex	Reference to the row in the grid.
	aColIndex	Reference to the column in the grid.

Overloaded MoveCursorL method to process cursor movement according to orientation of the grid.

Parameters:

	aCursorMovement	The cursor movement to apply etc. ECursorNextItem and ECursorPreviousItem.
	aSelectionMode	The selection mode of the calling list box.

Moves cursor with repeats.

Parameters:

	aNext	ETrue if next, EFalse if previous.
	aSelectionMode	selection mode.
	aAmount	Amount of steps to move.

This moves to the item and draws the grid in the right place.

Parameters:

	aItemIndex	The wanted item index.
	aSelectionMode	Mode for modifying the selection.

This function returns the number of visible columns.

Returns:

The number of visible columns in view.

This function returns the number of visible rows.

Returns:

The number of visible rows in view.

Makes the specified item visible by moving the view location and redrawing the control.

Index of the item to make visible.

Parameters:

aItemIndex

Index of the item to make visible.

Returns:

ETrue if the control was redrawn, EFalse if no redraw happened (i.e. the item was already visible, or redraw was disabled).

Reimplemented from CListBoxView.

This function sets the width of the grid column.

This should only be called via the selection box class's SetColumnWidth method.

Parameters:

aColumnWidth

The required width of all columns in the view, in pixels.

Sets the current data index with a value given with respect to the ordering of the cells in the grid.

Parameters:

aDataIndex

The index to be set.

Checks that number of cells in the grid is always enough to fill the current grid dimensions.

This method should be called after any method that may alter the amount of data within the grid.

Parameters:

aGridDimensions

Grid diemnsions.

Grid initialisation function.

Parameters:

aGridDetails

Struct of grid details.

This function sets item height in pixels.

Parameters:

aItemHeight

New height in pixels for this view’s items.

Reimplemented from CListBoxView.

Sets the form of scroll to activate upon reaching the limit when moving in the primary direction of grid, primary meaning whether the items are organised vertically or horizontally.

Parameters:

aScrollingType

The primary scrolling type.

Sets the form of scroll to activate upon reaching the limit when moving in the secondary direction of grid.

Parameters:

aSecondaryScrolling

The secondary scrolling type.

Sets the size of the spaces between items.

Parameters:

aSizeOfSpaceBetweenItems

The size of the spaces between items.

Sets which item appears at the top left corner of the view.

The function changes items displayed in the view appropriately.

Parameters:

aItemIndex

Index of the item to set at the top left.

Reimplemented from CListBoxView.

This function updates the horizontal scroll offset (iHScrollOffset) based on the top item’s index.

This function is called internally by CEikSnakingListBoxes when needed.

Gets the visible width of the specified rectangle in pixels.

Parameters:

aRect

Reference to the rectangle for which to get the visible width.

Returns:

Visible width of aRect in pixels.

Reimplemented from CListBoxView.

Converts a pixel position into an item index.

The function returns ETrue and sets aItemIndex to the index of the item whose bounding box contains aPosition. Returns EFalse if no such item exists.

Parameters:

	aPosition	A position relative to the origin of the list box control.
	aItemIndex	Is set to the item at that position.

Returns:

ETrue if there was an item at aPosition.

Reimplemented from CListBoxView.