CAknGrid Class Reference

This function handles drag events. If a leave occurs the framework generates a Symbian Leave code.

This function should be called after one or more items have been added to the grid. If a leave occurs the framework generates a Symbian Leave code.

This function should be called after one or more items have been removed from the grid. If a leave occurs the framework generates a Symbian Leave code.

Handling of pointer event within the CEikListBox. Used for e.g. selecting an item from the list box.

From MEikScrollBarObserver

This function handles scroll events caused by scroll bar. It updates grid's view by event and new thumb position.

This function is called when the grid's items, item's data and scroll bars has been changed. This implementation ensures that the current item is visible after resize. If a leave occurs the framework generates a Symbian Leave code.

This function gets the granularity for horizontal scrolls. The granularity is the minimum size of a horizontal move of the client area.

This function scroll horizontal by one column when the left/right scroll arrows (i.e. the nudge buttons) are tapped.

The grid position function. Gives the data index by using grid's position. The position must be given from the top left corner. If the function returns -1 the item's position is invalid.

Item drawer. Gets the pointer to the grid class.

This function creates a new object and returns pointer to it. If the leave occurs the framework generates a Symbian Leave code.

This function creates a new object and returns pointer to CTextListBoxModel class.

From MObjectProvider.

Retrieves an object of the same type as that encapsulated in aId. This function is used to allow controls to ask their owners for access to other objects that they own.

Moves to the next or previous item on the grid. If a leave occurs the framework generates a Symbian Leave code.

This function is from CEikAppUi, handles key events. If a leave occurs the framework generates a Symbian Leave code.

The grid position function. Gives the data item's co-ordinate values by using item's index value.

This function calculates the client area. This method is called by various functions of this class to recalculate the extent of the client area from iViewRect. This implementation takes into account any rounding of the viewing rectangle made to fit a whole number of items.

This function sets the column width of the grid. Column width cannot be set in a horizontal grid since the number of columns in the grid is defined by the initialising call to SetLayoutL. The column width cannot be larger than the width of the viewing rectangle.

Moves the cursor to the required grid data index.

This function sets the row height of the grid. Row height cannot be set in a vertical grid since the number of rows in the grid is defined by the initialising call to SetLayoutL. The row height cannot be larger than the height of the viewing rectangle. If a leave occurs the framework generates a Symbian Leave code.

Sets the layout from a resource. Layout includes orientation (either vertical or horizontal), horizontal and vertical direction of numbering, the number of items in the primary and secondary orientation, and the primary and secondary scrolling types. If a leave occurs the framework generates a Symbian Leave code.

Sets the orientation of the grid, either vertical or horizontal, the ordering of the data and the size of the primary dimension of the grid. The value for the parameter aNumOfItemsInPrimaryOrient must be greater than zero since this determines the number of items (be it rows or columns) in the primary orientation of the grid. If a leave occurs the framework generates a Symbian Leave code.

This function gives CAknGridM class pointer to CAknGrid class. Usually, the CAknGridM class object is instantiated automatically during the construction phase of the CAknGrid object. If an application programmer provides their own grid model class, the application programmer must instantiate their own grid model class object and give it to the CAknGrid object using the SetModel function before calling the ConstructL/ConstructFromResourceL function.

Sets the movement of the cursor with respect to scrolling when the end item in the current row or column, whichever is the primary orientation of the data items, is encountered. The movement maybe either stop, loop back to same row or column or move onto the next logical data item in the sequence.

This function handles viewable rectangle.

Sets the movement of the cursor with respect to scrolling when the end item in the secondary dimension of the grid is encountered. The movement maybe either stop, loop back back to same row or column or move onto the next logical data item in the sequence.

Sets the starting position of the data within the grid. A blank page cannot be accessed (since cannot move into empty cells) so a totally blank page is the same as if the page never existed since the user cannot scroll into it. For this reason it is suggested that the start position be no more than one page into the grid. If a leave occurs the framework generates a Symbian Leave code.

This function sets top item index.

This function handles size changes. This routine assumes that SetLayoutL has been called to set up the grid.

Updates the position of grids scroll bars thumbs to reflect the vertical position of selector.

This function updates the scrollbars, including item position. This function is called when the size of the scrollbars or data changes. If the leave occurs the framework generates a Symbian Leave code.