/*

* Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of "Eclipse Public License v1.0"

* which accompanies this distribution, and is available

* at the URL "http://www.eclipse.org/legal/epl-v10.html".

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description:  Hierarchical list view.

*

*/

#ifndef C_AKNTREELISTVIEW_H

#define C_AKNTREELISTVIEW_H

#include <AknControl.h> // CAknControl

#include <eiksbobs.h>   // MEikScrollBarObserver

#include <AknsEffectAnim.h>

#include <AknsItemID.h>

#include <babitflags.h>

#include <eikcmobs.h>

#include <akntreelistobserver.h>

#include <akncollection.h>

#include <aknlongtapdetector.h>

#include "akntreeobserver.h"

#include "akntreelistviewitem.h"

class CAknTreeNode;

class CAknTreeList;

class TAknWindowComponentLayout;

class CAknsBasicBackgroundControlContext;

class CEikScrollBarFrame;

class CAknTreeListPhysicsHandler;

class CAknItemActionMenu;

/**

 *  Hierarchical list view.

 *

 *  The hierarchical list view is responsible of maintaining the set of tree

 *  view items representing which of the tree items are currently visible,

 *  handling pointer and keyboard events, and drawing the requested part of

 *  the view.

 *

 *  @lib aknhlist.lib

 *  @since S60 v3.2

 */

NONSHARABLE_CLASS( CAknTreeListView ) : public CAknControl,

                                        public MEikScrollBarObserver,

                                        public MAknTreeObserver,

                                        public MAknsEffectAnimObserver,

                                        public MEikCommandObserver,

                                        public MAknCollection,

    {

public:

    /**

     * Two-phased constructor.

     *

     * @param aContainer Container for the view.

     *

     * @param aTree Reference to the tree structure.

     *

     * @param aList Reference to the list.

     *

     * @return Pointer to newly constructed object.

     */

    static CAknTreeListView* NewL( const CCoeControl& aContainer,

        CAknTree& aTree, CAknTreeList& aList );

    /**

     * Destructor.

     */

    virtual ~CAknTreeListView();

    /**

     * Utility method for calculating the rectangle of a layout component.

     *

     * @param aParent Parent rectangle for the required rectangle.

     *

     * @param aComponentLayout Component layout for the required component.

     *

     * @return Required rectangle.

     */

    static TRect RectFromLayout( const TRect& aParent,

        const TAknWindowComponentLayout& aComponentLayout );

    /**

     * Sets the focused item and its position in the view. 

     *

     * @param aItem The item to be focused. @c NULL, if no item is focused.

     *

     * @param aIndex Position of the focused item in the view as an index. If

     *      the index is less than zero or greater than or equal to the number

     *      of items in the view, the focused item is changed, but the items

     *      in the view are not changed.

     *

     * @param aDrawNow @c ETrue to redraw the view after the focused item has

     *      been changed.

     */

    void SetFocusedItem( CAknTreeItem* aItem, TInt aIndex, TBool aDrawNow );

    /**

     * Sets the focused item and its position in the view. Moves view so that 

     * focused item is allways visible.

     *

     * @param aItem The item to be focused.

     *

     */

    void SetFocusedItemAndView( CAknTreeItem* aItem );

    /**

     * Gets the index of the focused item on the screen. Possible values are

     * from 0 to max. number of visible lines - 1. Value -1 is

     * returned if no item is focused or focused item is not visible. 

     *

     * @return index of the focused item on the screen.

     */

    TInt FocusedItemIndex() const;

    TInt VisibleItemIndex( CAknTreeItem* aItem ) const;

    /**

     * Sets focus behaviour after sorting. 

     *

     * @c ESaveFocus saves focus in the item where it was before sorting, 

     * @c EMoveFocusToFirstItem changes view to the beginning of the list

     * and moves focus to the first item.  

     *

     * @return index of the focused item on the screen.

     */

    void SetFocusBehaviour( TBool saveFocus );

    /**

     * Returns pointer to the focused item.

     *

     * @return Pointer to the focused item. @c NULL, if no item is focused.

     */

    CAknTreeItem* FocusedItem() const;

    /**

     * Returns the highlight rectangle for the currently focused item. The

     * returned rectangle is empty, if no visible item is highlighted.

     *

     * @return Highlight rectangle.

     */

    TRect HighlightRect() const;

    /**

     * Returns whether the list is looping or non-looping.

     *

     * @return @c ETrue, if the list is looping.

     */

    TBool IsLooping() const;

    /**

     * Sets the list looping or non-looping.

     *

     * @param aLooping @c ETrue to set list looping, @c EFalse to set list

     *      non-looping.

     */

    void SetLooping( TBool aLooping );

    /**

     * Returns whether the list structure lines are visible.

     *

     * @return @c ETrue, if the tree structure lines are set visible.

     */

    TBool StructureLines() const;

    /**

     * Sets the visibility of structure lines.

     *

     * @param aVisible @c ETrue to set the tree structure lines visible,

     *       @c EFalse to set them invisible.

     */

    void SetStructureLineVisibility( TBool aVisible );

    /**

     * Returns whether the indention of list items is enabled.

     *

     * @return @c ETrue, if indention is enabled.

     */

    TBool Indention() const;

    /**

     * Sets the indention of list items enabled or disabled.

     *

     * @param aEnabled @c ETrue ot enable indention, @c EFalse to disable it.

     */

    void EnableIndention( TBool aEnable );

    /**

     * Returns the width of single indention step.

     *

     * @return Width of indention step. Negative value is returned when

     *      the default indention step width is to be used.

     */

    TInt IndentionWidth() const;

    /**

     * Sets the width of one indention step.

     *

     * @param aIndentionWidth The size of the indention step. Negative value

     *      can be used to use the default indention step width in current

     *      layout, which is based on the structure line segment width.

     */

    void SetIndentionWidth( TInt aIndentionWidth );

    /**

     * Checks whether marking is enabled. When marking is enabled, the list

     * items can be marked and unmarked with pointer and key events specified

     * for markable lists.

     *

     * @return @c ETrue, if marking of list items is enabled.

     */

    TBool IsMarkable() const;

    /**

     * Enables or disables the marking of list items.

     *

     * @param aEnable @c ETrue to enable marking, @c EFalse to disable it.

     */

    void EnableMarking( TBool aEnable );

    /**

     * Sets text for the empty list. This text is visible if the list box 

     * has no items.

     *

     * @param aText The text for the empty list.

     */

    void SetEmptyTextL(const TDesC& aText);

    /**

     * Initializes physics.

     */

    void InitPhysicsL();

    /**

     * Sets highlight to item to be focused.

     *

     * @param aItemToBeFocused Focused item.

     * @param aIndexToBeFocused Focused item index.

     */

    void SetHighlight( CAknTreeItem* aItemToBeFocused,

                       const TInt& aIndexToBeFocused );

    /**

     * Selects the item.

     *

     * @param aSelectedItem Item to be selected.

     */

    void SelectItem( CAknTreeItem* aSelectedItem );

    /**

     * Returns the count how many visible items fits to screen.

     *

     * @return Visible items count.

     */

    TInt VisibleItemCount() const;

    /**

     * Sets the pressed down state.

     * 

     * @param aPressedDown ETrue if highlight should be 

     * drawn in pressed-down state.

     */

    void SetPressedDownState( const TBool& aPressedDown );

    /**

     * Updates the tree list view.

     */

    void UpdateTreeListView( const TInt& aFirstItem, const TBool& aDrawNow );

    /**

     * Returns the offset value.

     *

     * @return Offset value.

     */

    TInt Offset() const;

    /**

     * Changes the marking of specified item when marking is enabled.

     *

     * @param aItem Pointer to the marked item.

     *

     * @param aMarked @c ETrue to mark item, @c EFalse to unmark it.

     *

     * @param aDrawNow @c ETrue to request redraw.

     */

    void MarkItem( CAknTreeItem* aItem, TBool aMarked, TBool aDrawNow );

    /**

     * Changes the marking of specified set of items when marking is enabled.

     *

     * @param aItem Pointer to the first of the marked items.

     *

     * @param aLast Pointer to the last of the marked items.

     *

     * @param aMarked @c ETrue to mark thee specified items, @c EFalse to

     *      unmark them.

     *

     * @param aDrawNow @c ETrue to request redraw.

     */

    void MarkItems( CAknTreeItem* aFirst, CAknTreeItem* aLast, TBool aMarked,

        TBool aDrawNow );

// from base class CCoeControl

    /**

     * From CCoeControl.

     * Handles key events.

     *

     * @param aKeyEvent Key event.

     *

     * @param aType The type of key event: @c EEventKey, @c EEventKeyUp or 

     *      @c EEventKeyDown.

     */

    TKeyResponse OfferKeyEventL( const TKeyEvent& aKeyEvent,

        TEventCode aType );

    /**

     * From CCoeControl.

     * Changes the visibility of the hierarchical list.

     *

     * @param aVisible @c ETrue to make the list visible, @c EFalse to make

     *      it invisible.

     */

    void MakeVisible( TBool aVisible );

    /**

     * From CCoeControl.

     * Sets the control's containing window by copying it from aContainer.

     *

     * @param aContainer Container.

     */

    void SetContainerWindowL( const CCoeControl& aContainer );

    /**

     * From CCoeControl.

     * Handles a change to the control's resources.

     *

     * @param aType A message UID value. 

     */

    void HandleResourceChange( TInt aType );

    /**

     * From CCoeControl.

     * Handles pointer events.

     *

     * @param aPointerEvent Pointer event.

     */

    void HandlePointerEventL( const TPointerEvent& aPointerEvent );

    /** 

     * From CCoeControl.

     * Gets the number of controls contained in a compound control.

     *

     * @return The number of component controls contained by this control.

     */

    TInt CountComponentControls() const;

    /**

     * From CCoeControl.

     * Gets an indexed component of a compound control.

     *

     * @param aIndex The index of the control.

     *

     * @return The component control with an index of aIndex.

     */

    CCoeControl* ComponentControl( TInt aIndex ) const;

// from base class MEikScrollBarObserver

    /**

     * From MEikScrollBarObserver.

     * Handles events from scroll bar.

     *

     * @param aScrollBar Pointer to the scrollbar.

     *

     * @param aEventType Event type.

     */

    void HandleScrollEventL( CEikScrollBar* aScrollBar,

        TEikScrollEvent aEventType );

// from base class MAknTreeObserver

    /**

     * From MAknTreeObserver.

     * Handles event from the tree structure.

     *

     * @param aEvent Tree event.

     *

     * @param aItem Tree item targeted by the specified event.

     *

     * @param aDrawNow @c ETrue, when the view should be redrawn.

     */

    void HandleTreeEvent( TEvent aEvent, CAknTreeItem* aItem,

        TBool aDrawNow );

// from base class MAknsEffectAnimObserver

    /**

     * From MAknsEffectAnimObserver.

     * Animation frame is ready to be drawn.

     *

     * @param aError @c KErrNone, if frame has been succesfully created and

     *      is available for drawing. Otherwise animation has internally

     *      failed and will not be used by the tree list view anymore.

     *

     * @param aAnimId Not currently used.

     */

    void AnimFrameReady( TInt aError, TInt aAnimId );

// from base class MEikCommandObserver

    /**

     * From MEikCommandObserver.

     * Handles user commands.

     *

     * @param ID of the commmand to respond to.

     */

    void ProcessCommandL( TInt aCommandId );

#ifdef RD_UI_TRANSITION_EFFECTS_LIST

// ---------------------------------------------------------------------------

// Sets the tfxgc for effects

// ---------------------------------------------------------------------------

//

void SetGc( CWindowGc* aGc);

TInt& ItemCountLimit();

TInt& HighlightIndex();

TInt& TopIndex();

TInt& BottomIndex();

TInt iItemCountLimit;

TInt iHighlightIndex;

TInt iTopIndex;

#endif //RD_UI_TRANSITION_EFFECTS_LIST

public:  // new method

    /**

     * Report event to tree list observers. Use it to aviod dependency of 

     * @c CAknTreeList

     * 

     * @param aEvent The event to be notified.

     * 

     * @param aItem ID of the tree item related to the event.

     */

    void ReportTreeListEvent( MAknTreeListObserver::TEvent aEvent, 

                              TAknTreeItemID aItem);

protected:

// from base class CCoeControl

    /**

     * From CCoeControl.

     * Handles focus change.

     *

     * @param aDrawNow @c EDrawNow to redraw the list.

     */

    void FocusChanged( TDrawNow aDrawNow );

    /**

     * From CCoeControl.

     * Responds to changes to the size and position of this control.

     */

    void SizeChanged();

    /**

     * From CCoeControl.

     * Responds to changes in the position of this control.

     */

    void PositionChanged();

    /**

     * From CCoeControl.

     * Retrieves an object of the same type as that encapsulated in aId.

     *

     * @param aId An encapsulated object type ID.

     *

     * @return Encapsulates the pointer to the object provided. Note that the

     *      encapsulated pointer may be NULL

     */

    TTypeUid::Ptr MopSupplyObject( TTypeUid aId );

private:

    /**

     * C++ constructor.

     *

     * @param aTree Reference to the tree structure.

     */

    CAknTreeListView( CAknTree& aTree, CAknTreeList& aList );

    /**

     * Second phase constructor.

     *

     * @param aContainer Container for the view.

     */

    void ConstructL( const CCoeControl& aContainer );

    /**

     * Handes an addition of item to the tree structure.

     *

     * @param aItem Pointer to the added tree item.

     */