akngrid.h

00001 /*
00002 * =============================================================================
00003 *  Name        : AknGrid.h
00004 *  Part of     : Avkon
00005 *
00006 *  Description : 
00007 *     This is a concrete class for the handling of a grid. The class handles a
00008 *     rectangular grid arrangement of items held in any linear ordering i.e 
00009 *     cells ordered top to bottom and left, left to right and down etc.
00010 *
00011 *  Version     : 
00012 *
00013 *  Copyright © 2002-2004 Nokia. All rights reserved.
00014 *  This material, including documentation and any related 
00015 *  computer programs, is protected by copyright controlled by 
00016 *  Nokia. All rights are reserved. Copying, including 
00017 *  reproducing, storing, adapting or translating, any 
00018 *  or all of this material requires the prior written consent of 
00019 *  Nokia. This material also contains confidential 
00020 *  information which may not be disclosed to others without the 
00021 *  prior written consent of Nokia.
00022 * =============================================================================
00023 */
00025 #if !defined(__AKNGRID_H__)
00026 #define __AKNGRID_H__
00027 
00028 // INCLUDES
00029 #include <eiktxlbx.h>
00030 #include <eiklbv.h>
00031 #include <eikfrlbd.h>
00032 #include <eikfrlb.h>
00034 #include <AknGridM.h>
00035 #include <AknGridView.h>
00036 #include <Aknappui.h>
00038 // CLASS PREDEFINITIONS
00039 class CAknGridExtension;
00041 // CLASS DECLARATION
00049 class CAknGrid : public CEikListBox
00050     {
00051 private:// enums
00052     enum TIndicatorEvent
00053         {
00054         EMove,
00055         EChangeNumOfItems,
00056         EResize
00057         };
00058 public:
00064     IMPORT_C CAknGrid();
00069     IMPORT_C virtual ~CAknGrid();
00081     IMPORT_C void SetModel(CAknGridM* aModel);
00091     IMPORT_C void ConstructL(const CCoeControl* aParent, TInt aFlags = 0);
00105     IMPORT_C void ConstructFromResourceL(TResourceReader& aReader);
00123     IMPORT_C void SetLayoutL(TBool aVerticalOrientation,
00124                              TBool aLeftToRight,
00125                              TBool aTopToBottom,
00126                              TInt aNumOfItemsInPrimaryOrient,
00127                              TInt aNumOfItemsInSecondaryOrient,
00128                              TSize aSizeOfItems,
00129                              TInt aWidthOfSpaceBetweenItems=0,
00130                              TInt aHeightOfSpaceBetweenItems=0);
00140     IMPORT_C void SetLayoutFromResourceL(TResourceReader& aReader);
00150     IMPORT_C void SetPrimaryScrollingType(CAknGridView::TScrollingType aScrollingType);
00159     IMPORT_C void SetSecondaryScrollingType(CAknGridView::TScrollingType aSecondaryScrolling);
00171     IMPORT_C void SetStartPositionL(TPoint aGridStartPosition);
00183     IMPORT_C TInt CurrentDataIndex() const;
00189     IMPORT_C void SetCurrentDataIndex(TInt aDataIndex);
00198     IMPORT_C TInt IndexOfPosition(TPoint aGridPosition) const;
00206     IMPORT_C TPoint PositionAtIndex(TInt aItemIndex) const;
00212     IMPORT_C CFormattedCellListBoxItemDrawer* ItemDrawer() const;
00220     IMPORT_C void SetEmptyGridTextL(const TDesC& aText);
00226     inline const TDesC* EmptyGridText() const;
00228 public:
00235     IMPORT_C virtual CListBoxView* MakeViewClassInstanceL();
00244     IMPORT_C void SetColumnWidth(TInt aColumnWidth);
00250     IMPORT_C TInt ColumnWidth() const;
00252 public: //from CEikListBox
00259     IMPORT_C virtual void UpdateScrollBarsL();
00266     IMPORT_C void HandleItemAdditionL();
00273     IMPORT_C void HandleItemRemovalL();
00282     IMPORT_C virtual TKeyResponse OfferKeyEventL(const TKeyEvent& aKeyEvent,TEventCode aType);
00292     IMPORT_C void SetItemHeightL(TInt aHeight);
00298     IMPORT_C void SizeChanged();
00305     IMPORT_C CTextListBoxModel* Model() const;
00311     IMPORT_C void SetRect(const TRect& aRect);
00319     IMPORT_C virtual void HandleViewRectSizeChangeL();
00325     IMPORT_C virtual void SetTopItemIndex(TInt aItemIndex) const;
00332     IMPORT_C virtual void HandleResourceChange(TInt aType);
00340     IMPORT_C void FocusChanged(TDrawNow aDrawNow);
00342 public: // From CCoeControl
00343     IMPORT_C void HandlePointerEventL(const TPointerEvent& aPointerEvent);
00345 protected: // from CEikListBox
00352     IMPORT_C virtual TInt HorizontalNudgeValue() const;
00359     IMPORT_C virtual TInt HorizScrollGranularityInPixels() const;
00368     IMPORT_C virtual void AdjustTopItemIndex() const;
00376     IMPORT_C virtual void HandleDragEventL(TPoint aPointerPos);
00386     IMPORT_C virtual void RestoreClientRectFromViewRect(TRect& aClientRect) const;
00393     IMPORT_C virtual TInt AdjustRectHeightToWholeNumberOfItems(TRect& aRect) const;
00399     IMPORT_C virtual void UpdateScrollBarThumbs() const;
00405     IMPORT_C virtual TInt CountComponentControls() const;
00407 protected:
00414     IMPORT_C void MoveToNextOrPreviousItemL(TPoint aPoint);
00423     IMPORT_C virtual void CalcGridSizeL();
00429     IMPORT_C virtual void CreateItemDrawerL();
00431 private:
00432     __DECLARE_TEST;
00434     // grid model helper
00435     inline CAknGridM* GridModel() const;
00437     // grid view helper
00438     inline CAknGridView* GridView() const;
00452     void DoSetLayoutL(TInt aOrientation,
00453                       TInt aHorizontal,
00454                       TInt aVertical,
00455                       TInt aNumOfItemsInPrimaryOrient,
00456                       TInt aNumOfItemsInSecondaryOrient,
00457                       TSize aSizeOfItems,
00458                       TInt aWidthOfSpaceBetweenItems=0,
00459                       TInt aHeightOfSpaceBetweenItems=0);
00461 private:
00465     IMPORT_C void* ExtensionInterface( TUid aInterface );
00466 private: // from MListBoxModel
00467     IMPORT_C virtual TAny* MListBoxModel_Reserved();
00469 protected: 
00479     IMPORT_C virtual void HandleScrollEventL(CEikScrollBar* aScrollBar, TEikScrollEvent aEventType);
00492     IMPORT_C virtual TTypeUid::Ptr MopSupplyObject(TTypeUid aId);
00495 private:
00496     TInt  iMinColWidth;
00497     TBool iCurrentIsValid;
00498     TInt  iNumOfColsInView;
00499     TInt  iNumOfRowsInView;
00500     TSize iSpaceBetweenItems;
00501         TInt  iSpare; // was iNumOfItemsInPrimaryOrient;
00502     TBitFlags iOrientationFlags;
00503     TBitFlags iHorizontalFlags;
00504     TBitFlags iVerticalFlags;
00505     CAknGridExtension *iExtension; // spare taken to use as extension class
00506     };
00511 inline CAknGridM* CAknGrid::GridModel() const
00512     {
00513     return STATIC_CAST(CAknGridM*,iModel);
00514     }
00519 inline CAknGridView* CAknGrid::GridView() const
00520     {
00521     return STATIC_CAST(CAknGridView*,iView);
00522     }
00527 inline const TDesC* CAknGrid::EmptyGridText() const
00528     {
00529     return STATIC_CAST(CAknGridView*,iView)->EmptyListText();
00530     }
00532 #endif //__AKNGRID_H__
00533