akntreelist.h

00001 /*
00002 * ============================================================================
00003 *  Name        : akntreelist.h
00004 *  Part of     : UI Framework Core / Avkon
00005 *  Description : Abstract base class for hierarchical lists.
00006 *  Version     : %version: 7 %
00007 *
00008 *  Copyright © 2006, 2007 Nokia.  All rights reserved.
00009 *  This material, including documentation and any related computer
00010 *  programs, is protected by copyright controlled by Nokia.  All
00011 *  rights are reserved.  Copying, including reproducing, storing,
00012 *  adapting or translating, any or all of this material requires the
00013 *  prior written consent of Nokia.  This material also contains
00014 *  confidential information which may not be disclosed to others
00015 *  without the prior written consent of Nokia.
00016 * ============================================================================
00017 * Template version: 4.1
00018 */
00020 #ifndef C_AKNTREELIST_H
00021 #define C_AKNTREELIST_H
00022 
00024 #include <akncontrol.h>
00025 #include <w32std.h>
00026 #include <akntreelistobserver.h>
00027 #include <akniconutils.h> // TScaleMode
00029 class CAknTree;
00030 class CAknTreeListView;
00031 class MAknCustomTreeOrdering;
00032 class TAknsItemID;
00035 const TUint32 KAknTreeListLooping = 0x0001;
00038 const TUint32 KAknTreeListNoStructureLines = 0x0002;
00041 const TUint32 KAknTreeListMarqueeScrolling = 0x0004;
00045 const TUint32 KAknTreeListNoIndention = 0x0008;
00051 const TUint32 KAknTreeListMarkable = 0x0010;
00096 NONSHARABLE_CLASS( CAknTreeList ) : public CAknControl
00097     {
00099 public:
00102         // for focus handling after Sort
00103    enum TFocusBehaviour
00104             {
00105             ESaveFocus,
00106             EMoveFocusToFirstItem
00107             };
00112     virtual ~CAknTreeList();
00128     IMPORT_C virtual void SetFlags( TUint32 aFlags );
00135     IMPORT_C TUint32 Flags() const;
00171     IMPORT_C void MoveItemL( TAknTreeItemID aItem, TAknTreeItemID aTargetNode,
00172         TBool aDrawNow );
00194     IMPORT_C void RemoveItem( TAknTreeItemID aItem, TBool aDrawNow );
00219     IMPORT_C void ExpandNode( TAknTreeItemID aNode, TBool aDrawNow );
00244     IMPORT_C void CollapseNode( TAknTreeItemID aNode, TBool aDrawNow );
00257     IMPORT_C TBool IsExpanded( TAknTreeItemID aNode ) const;
00265     IMPORT_C TAknTreeItemID FocusedItem() const;
00287     IMPORT_C void SetFocusedItem( TAknTreeItemID aItem, TInt aIndex,
00288         TBool aDrawNow );
00298     IMPORT_C TRect HighlightRect() const;
00328     IMPORT_C TInt AddIconL( const TAknsItemID& aId, const TDesC& aFilename,
00329         TInt aBitmapId, TInt aMaskId, TScaleMode aScaleMode );
00352     IMPORT_C TInt AddIconL( CFbsBitmap* aIcon, CFbsBitmap* aMask,
00353         TBool aTransferOwnership, TScaleMode aScaleMode );
00388     IMPORT_C TInt AddColorIconL( const TAknsItemID& aId,
00389         const TAknsItemID& aColorId, TInt aColorIndex, const TDesC& aFilename,
00390         TInt aBitmapId, TInt aMaskId, TRgb aDefaultColor,
TScaleMode aScaleMode );
00421     IMPORT_C void AssignIconL( TInt aIconId, const TAknsItemID& aId,
00422         const TDesC& aFilename, TInt aBitmapId, TInt aMaskId,
TScaleMode aScaleMode );
00450     IMPORT_C void AssignIconL( TInt aIconId, CFbsBitmap* aIcon,
00451         CFbsBitmap* aMask, TBool aTransferOwnership, TScaleMode aScaleMode );
00488     IMPORT_C void AssignColorIconL( TInt aIconId, const TAknsItemID& aId,
00489         const TAknsItemID& aColorId, TInt aColorIndex, const TDesC& aFilename,
00490         TInt aBitmapId, TInt aMaskId, TRgb aDefaultColor,
TScaleMode aScaleMode );
00503     IMPORT_C void RemoveIconL( TInt aIconId );
00519     IMPORT_C TInt ChildCount( TAknTreeItemID aNode ) const;
00537     IMPORT_C TAknTreeItemID Child( TAknTreeItemID aNode, TInt aIndex ) const;
00551     IMPORT_C TAknTreeItemID Parent( TAknTreeItemID aItem ) const;
00562     IMPORT_C TBool Contains( TAknTreeItemID aItem ) const;
00573     IMPORT_C TBool IsNode( TAknTreeItemID aItem ) const;
00584     IMPORT_C TBool IsLeaf( TAknTreeItemID aItem ) const;
00595     IMPORT_C TBool IsMarked( TAknTreeItemID aItem ) const;
00614     IMPORT_C void SetMarked( TAknTreeItemID aItem, TBool aMarked,
00615         TBool aDrawNow );
00635     IMPORT_C void EnableMarking( TAknTreeItemID aItem, TBool aEnable );
00645     IMPORT_C void GetMarkedItemsL( RArray<TAknTreeItemID>& aMarkedItems ) const;
00663     IMPORT_C void GetMarkedItemsL( TAknTreeItemID aNode,
00664         RArray<TAknTreeItemID>& aMarkedItems ) const;
00682     IMPORT_C TBool IsEmpty( TAknTreeItemID aNode ) const;
00698     IMPORT_C void SetNonEmpty( TAknTreeItemID aNode, TBool aNonEmpty,
00699         TBool aDrawNow );
00714     IMPORT_C TBool IsPersistent( TAknTreeItemID aItem ) const;
00726     IMPORT_C void SetPersistent( TAknTreeItemID aItem,
00727         TBool aPersistent );
00748     IMPORT_C void Sort( MAknCustomTreeOrdering* aOrdering, TBool aDrawNow );
00770     IMPORT_C void Sort( TAknTreeItemID aNode, TBool aSortDescendants,
00771         TBool aDrawNow );
00787     IMPORT_C void AddObserverL( MAknTreeListObserver* aObserver );
00794     IMPORT_C void RemoveObserver( MAknTreeListObserver* aObserver );
00804     void NotifyObservers( MAknTreeListObserver::TEvent aEvent,
TAknTreeItemID aItem );
00812     IMPORT_C TBool TabModeFunctionIndicators() const;
00825     IMPORT_C void EnableTabModeFunctionIndicatorsL( TBool aEnable );
00850         IMPORT_C void SetFocusedItem( TAknTreeItemID aItem );
00859         IMPORT_C TInt FocusedItemIndex() const;
00868         IMPORT_C TInt VisibleItemIndex( TAknTreeItemID aItem ) const;
00885         IMPORT_C void Sort( MAknCustomTreeOrdering* aOrdering, TFocusBehaviour aFocusBehaviour, TBool aDrawNow );
00912         IMPORT_C void Sort( TAknTreeItemID aNode, TFocusBehaviour aFocusBehaviour, TBool aSortDescendants, TBool aDrawNow );
00920         IMPORT_C void SetEmptyTextL(const TDesC& aText);
00923 // From base class CCoeControl
00935     TKeyResponse OfferKeyEventL( const TKeyEvent& aKeyEvent, TEventCode aType );
00944     void MakeVisible( TBool aVisible );
00952     void SetDimmed( TBool aDimmed );
00961     void SetContainerWindowL( const CCoeControl& aContainer );
00967     void ActivateL();
00975     void HandleResourceChange( TInt aType );
00983     TCoeInputCapabilities InputCapabilities() const;
00991     void HandlePointerEventL( const TPointerEvent& aPointerEvent );
00999     TInt CountComponentControls() const;
01009     CCoeControl* ComponentControl( TInt aIndex ) const;
01011 protected:
CAknTreeList();
01023     void BaseConstructL();
01030     void BaseConstructL( const CCoeControl& aContainer );
01037     CAknTree& Tree();
01044     const CAknTree& Tree() const;
01051     CAknTreeListView& View();
01058     const CAknTreeListView& View() const;
01060 // from base class CCoeControl
01068     void FocusChanged( TDrawNow aDrawNow );
01074     void SizeChanged();
01080     void PositionChanged();
01091     TTypeUid::Ptr MopSupplyObject( TTypeUid aId );
01093 private:
01095 // from base class CCoeControl
01103     void Draw( const TRect& aRect ) const;
01105 private: // data
01110     TUint32 iFlags;
01116     CAknTree* iTree;
01122     CAknTreeListView* iView;
01128     RPointerArray<MAknTreeListObserver> iObservers;
01133     TInt iIndex;
01135     };
01138 #endif // C_AKNTREELIST_H