menufw/menufwui/mmwidgets/inc/mmgridview.h
branchRCL_3
changeset 54 1b758917cafc
parent 16 9674c1a575e9
equal deleted inserted replaced
50:137ebc85284b 54:1b758917cafc
    10 * Nokia Corporation - initial contribution.
    10 * Nokia Corporation - initial contribution.
    11 *
    11 *
    12 * Contributors:
    12 * Contributors:
    13 *
    13 *
    14 * Description:  CMmGridView declaration
    14 * Description:  CMmGridView declaration
    15 *  Version     : %version: MM_24.1.10 % << Don't touch! Updated by Synergy at check-out.
    15 *  Version     : %version: MM_24.1.11 % << Don't touch! Updated by Synergy at check-out.
    16 *
    16 *
    17 */
    17 */
    18 
    18 
    19 
    19 
    20 #ifndef C_MMGRIDVIEW_H
    20 #ifndef C_MMGRIDVIEW_H
    61      * Draws the grid within the given clipping rectangle.
    61      * Draws the grid within the given clipping rectangle.
    62      *
    62      *
    63      * @since S60 v3.0
    63      * @since S60 v3.0
    64      * @param aClipRect Clipping rectangle.
    64      * @param aClipRect Clipping rectangle.
    65      */
    65      */
    66 	void Draw( const TRect* aClipRect ) const;
    66   void Draw( const TRect* aClipRect ) const;
    67 
    67 
    68 	/**
    68   /**
    69      * Gets item position.
    69      * Gets item position.
    70      *
    70      *
    71      * This fuction from @c CAknGridView is overridden so that it
    71      * This fuction from @c CAknGridView is overridden so that it
    72      * returns 'mirrored' item positions when mirrored layout is
    72      * returns 'mirrored' item positions when mirrored layout is
    73      * used.
    73      * used.
    88      * @param aItemIndex Reference to the item index.
    88      * @param aItemIndex Reference to the item index.
    89      * @return Whether there was an item at aPosition.
    89      * @return Whether there was an item at aPosition.
    90      */
    90      */
    91     TBool XYPosToItemIndex(TPoint aPosition, TInt& aItemIndex) const;
    91     TBool XYPosToItemIndex(TPoint aPosition, TInt& aItemIndex) const;
    92 
    92 
    93 	/**
    93   /**
    94 	 * Returns this view's gc.
    94    * Returns this view's gc.
    95 	 *
    95    *
    96 	 * @return pointer to gc
    96    * @return pointer to gc
    97 	 */
    97    */
    98 	CWindowGc* Gc();
    98   CWindowGc* Gc();
    99 
    99 
   100     /**
   100     /**
   101      * @see CAknGridView::UpdateSelectionL
   101      * @see CAknGridView::UpdateSelectionL
   102      *
   102      *
   103      * This method of CAknGridView is overriden to so that
   103      * This method of CAknGridView is overriden to so that
   106      * Please note that it is necessary because of the hackish
   106      * Please note that it is necessary because of the hackish
   107      * solution used to draw items in mirrored layout.
   107      * solution used to draw items in mirrored layout.
   108      */
   108      */
   109     void UpdateSelectionL( TSelectionMode aSelectionMode );
   109     void UpdateSelectionL( TSelectionMode aSelectionMode );
   110 
   110 
   111 	/**
   111   /**
   112 	 * @see CAknGridView::MoveCursorL
   112    * @see CAknGridView::MoveCursorL
   113 	 *
   113    *
   114 	 * This method of CAknGridView is overriden to so that
   114    * This method of CAknGridView is overriden to so that
   115 	 * correct effects are displayed when moving highlight with
   115    * correct effects are displayed when moving highlight with
   116 	 * rocker key in mirrored layout.
   116    * rocker key in mirrored layout.
   117      * Please note that it is necessary because of the hackish
   117      * Please note that it is necessary because of the hackish
   118      * solution used to draw items in mirrored layout.
   118      * solution used to draw items in mirrored layout.
   119 	 */
   119    */
   120     void MoveCursorL( TCursorMovement aCursorMovement,
   120     void MoveCursorL( TCursorMovement aCursorMovement,
   121             TSelectionMode aSelectionMode );
   121             TSelectionMode aSelectionMode );
   122 
   122 
   123     /**
   123     /**
   124      * Gets the current widget vertical item offset.
   124      * Gets the current widget vertical item offset.
   126      * @since S60 v5.0
   126      * @since S60 v5.0
   127      * @return The current widget vertical item offset.
   127      * @return The current widget vertical item offset.
   128      */
   128      */
   129     TInt VerticalItemOffset() const;
   129     TInt VerticalItemOffset() const;
   130 
   130 
   131 	/**
   131   /**
   132 	* This function sets item height in pixels.
   132   * This function sets item height in pixels.
   133 	* @param aItemHeight New height in pixels for this view’s items.
   133   * @param aItemHeight New height in pixels for this view’s items.
   134 	*/
   134   */
   135     void SetItemHeight(TInt aItemHeight);
   135     void SetItemHeight(TInt aItemHeight);
   136 
   136 
   137     /**
   137     /**
   138      * Updates various member variables in this grid view and related objects
   138      * Updates various member variables in this grid view and related objects
   139      * with item dimensions taken from the template library.
   139      * with item dimensions taken from the template library.