/*

* Copyright (c) 2006 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:  MPX Collection view container implementation

*

*/

#ifndef CMPXCOLLECTIONVIEWHGCONTAINER_H

#define CMPXCOLLECTIONVIEWHGCONTAINER_H

// INCLUDES

#include <coecntrl.h>

#include <ganes/HgScrollBufferObserverIface.h>

#include <ganes/HgSelectionObserverIface.h>

#include <ganes/HgVgMediaWallObserverIface.h>

#include <ganes/HgItem.h>

#include <mpxcommonframeworkdefs.h> // TMPXItemId

#include "mpxcollectionviewhgtnloader.h"

#include "mpxcommonlistboxarrayobserver.h"

#include "mpxcommonlistboxarraybase.h"

// FORWARD DECLARATION

class CAknContextPane;

class CAknIconArray;

class CAknsBasicBackgroundControlContext;

class CEikMenuPane;

class CHgScroller;

class CHgScroller;

class CHgVgMediaWall;

class CMPXCollectionViewHgPlaylistHelper;

class CMPXCommonUiHelper;

class CMPXMediaArray;

class MCoeControlObserver;

class MEikCommandObserver;

class MEikListBoxObserver;

class MMPXCollectionUiHelper;

class MMPXCollectionUtility;

class MMPXPlaybackUtility;

class MMpxCbaHandler;

class TAknsItemID;

class CAsyncOneShot;

// CLASS DECLARATION

/**

 *  MPX Collection view container.

 *

 *  @lib mpxcollectionviewhg.lib

 *  @since S60 v5.0

 */

NONSHARABLE_CLASS( CMPXCollectionViewHgContainer )

    : public CCoeControl

    , public MCoeControlObserver

    , public MMPXCommonListBoxArrayObserver

	, public MHgScrollBufferObserver

	, public MHgSelectionObserver

    , public MMPXCollectionFindObserver

    , public MHgVgMediaWallObserver

    , public MMpxTNLoaderObserver

    , public MCoeForegroundObserver

	{

public:

    /**

     * Two-phased constructor.

     *

     * @since 5.1

     * @param aView Command observer.

     * @param aObserver MEikListBoxObserver

     * @param aIsEmbedded ETrue to indicate that view is embedded

     * @return Pointer to newly created object.

     */

    static CMPXCollectionViewHgContainer* NewL(

        MEikCommandObserver* aView,

        MEikListBoxObserver* aObserver,

        TBool aIsEmbedded );

    /**

     * Destructor.

     */

    virtual ~CMPXCollectionViewHgContainer();

    /**

     * Sets playback status with item id

     *

     * @param aId item id of the song

     * @param aStatus status of the song

     */

    void SetPlaybackStatusByIdL( TMPXItemId aId, TMPXPlaybackState aStatus, TInt aIndex = 0 );

    /**

     * Get current playback index

     *

     * @return Current playback index, KErrNotFound if nothing is playing

     */

    TInt PlaybackIndex();

    /**

     * Activates reorder mode

     *

     * @param aEnable ETrue to enable reorder mode, EFalse to disable

     */

    void ActivateReorderMode( TBool aEnable );

    /**

     * Set reorder mode

     *

     * @param aEnable ETrue to enable reorder mode, EFalse to disable reorder mode

     * @param aIndex current selected index

     */

    void SetReorderGrabbedMode( TBool aEnable, TInt aIndex = 0 );

    /**

     * Determines if it's currently in reorder mode

     *

     * @return ETrue if in reorder mode, EFalse otherwise

     */

    TBool IsInReorderMode();

    /**

     * Move current reorder index relatively

     *

     * @param aDirection +1 to move down, -1 to move up

     */

    void MoveReorderIndex( TInt aDirection );

    /**

     * Set current reorder index

     *

     * @param aIndex current reorder index

     */

    void SetReorderIndex( TInt aIndex );

    /**

     * Confirm reorder

     */

    void ConfirmReorderL();

    /**

     * Cancel reorder

     */

    void CancelReorder();

    /**

     * Gets original index of currently selected item in reorder mode

     */

    TInt GetOriginalIndex();

    /**

     * Update Titlepane icon to reorder image

     */

    void UpdateReorderTitleIconL();

    /**

     * Update titlepane to use original icon

     */

    void RestoreOriginalTitleIconL();

    /**

     * Content is ready

     */

    void ContentIsReady( TBool aReady );

    /**

     * Returns list box array, ownership not transfered

     *

     * @since 3.1

     * @return A pointer to the list box array

     */

    CMPXCommonListBoxArrayBase* ListBoxArray() const;

    /**

     * Return number of listbox items shown in the current listbox.

     *

     * @since 3.1

     * @return The number of items shown in the list box

     */

    TInt CurrentListItemCount() const;

    /**

     * Return total number of listbox items in the listbox.

     *

     * @since 3.1

     * @return Total items in the list box

     */

    TInt TotalListItemCount() const;

    /**

     * Gets top listbox item index (relative to the original listbox).

     * @return Top listbox item index

     *

     * @since 3.1

     */

    TInt TopLbxItemIndex() const;

    /**

     * Gets bottom listbox item index (relative to the original listbox).

     * @return Bottom listbox item index

     *

     * @since 3.1

     */

    TInt BottomLbxItemIndex() const;

    /**

     * Gets current listbox item index (relative to the original listbox).

     * @return Current listbox item index

     *

     * @since 3.1

     */

    TInt CurrentLbxItemIndex() const;

    /**

     * Get current selected listbox items indices (relative to the original

     * listbox). Ownership not transferred.

     *

     * @since 3.1

     * @return Current listbox item indices

     */

    const CArrayFix<TInt>* CurrentSelectionIndicesL() const;

    /**

     * Sewt current selected listbox items indices

     *

     * @since 3.1

     * @param aIndices Array of selection indices, ownership not transfered

     */

    void SetCurrentSelectionIndicesL( CArrayFix<TInt>* aIndices ) const;

    /**

     * Set top listbox item index.

     *

     * @since 3.1

     * @param aIndex Actual listbox index.

     */

    void SetLbxTopItemIndex( TInt aIndex );

    /**

     * Set current listbox item index.

     *

     * @since 3.1

     * @param aIndex Actual listbox index.

     */

    void SetLbxCurrentItemIndex( TInt aIndex );

    /**

     * Set current listbox item index and highlight it.

     *

     * @since 3.1

     * @param aIndex Actual listbox index.

     */

    void SetLbxCurrentItemIndexAndDraw( TInt aIndex );

    /**

     * Clear listbox selection.

     *

     * @since 3.1

     */

    void ClearLbxSelection();

    /**

     * Sets list box backround text. This text is visible if the list box

     * has no items.

     *

     * @param aText The text for the empty list box background.

     * @since 3.2

     */

	void SetLbxEmptyTextL( const TDesC& aText );

    /**

     * Draws list box item index

     *

     * @since 3.2

     */

    void DrawLbxItemL( TInt aIndex );

    /**

     * Set Find box's focus.

     *

     * @since 3.1

     * @param aFocus ETrue if set focus on FindBox. Otherwise, EFalse.

     */

    void SetFindBoxFocus( TBool aFocus );

    /**

     * Handle listbox item addition.

     *

     * @since 3.1

     */

    void HandleLbxItemAdditionL();

    /**

     * Handle listbox item addition, preserving the current display index.

     *

     * @since 3.1

     */

    void HandleLbxItemAdditionPreserveIndexL();

    /**

     * Handle listbox item removal.

     *

     * @since 3.1

     */

    void HandleLbxItemRemovalL();

    /**

     * Show/hide find box

     *

     * @since 3.1

     * @param aIsVisible ETrue to set findbox visible. Otherwise, EFalse

     */

    void SetFindBoxVisibilityL( TBool aIsVisible );

    /**

     * Determine find box visibility

     *

     * @since 3.1

     * @return ETrue if find box is currently visible, EFalse otherwise

     */

    TBool FindBoxVisibility();

    /**

     * Restore the PopupCBA of find box

     */

    void RestoreFindBoxPopupCBA();

    /**

     * Calculate the top index of the visible items

     *

     * @since 3.1

     * @param aBottomIndex the bottom index of the visible items

     * @return top index

     */

    TInt CalculateTopIndex( TInt aBottomIndex );

    /**

     * Enable/disable find box

     *

     * @since 3.1

     * @aEnable ETrue to enable find box, EFalse to disable

     */

    void EnableFindBox( TBool aEnable );

    /**

     * Enable/disable marking

     *

     * @since 3.1

     * @aEnable ETrue to enable marking, EFalse to disable

     */

    void EnableMarking( TBool aEnable );

    /**

     * Custom handling of commands for markable lists.

     */

    void HandleMarkableListProcessCommandL( TInt aCommand );

    /**

     * Custom handling of menu pane for markable lists

     */

    void HandleMarkableListDynInitMenuPane(

        TInt aResourceId,

        CEikMenuPane* aMenuPane );

// from base class MMPXViewContainer

    /**

     * Handles key events.

     *

     * @param aKeyEvent The key event.

     * @param aType The type of key event.

     */

    TKeyResponse HandleKeyEventL(

        const TKeyEvent& aKeyEvent,

        TEventCode aType );

    /**

     * Handles the retrieval of the view container's help context.

     *

     * @param aContext The control's help context.

     */

    void HandleHelpContext( TCoeHelpContext& aContext ) const;

    /**

     * Returns the indicators for the specified item within the view container

     *

     * @param aIndex specified array index

     * @return Indicator icon indices

     */

    RArray<TInt> IndicatorsL( TInt aIndex );

    void SetCbaHandler( MMpxCbaHandler* aCbaHandler );

// from base class CCoeControl

    /**

     * From CCoeControl.

     * Handles key events.

     *

     * @param aKeyEvent The key event.

     * @param aType The type of key event.

     */

    TKeyResponse OfferKeyEventL(

        const TKeyEvent& aKeyEvent,

        TEventCode aType );

    /**

     * From CCoeControl.

     * Gets the control's help context.

     *

     * @param aContext The control's help context.

     */

    void GetHelpContext( TCoeHelpContext& aContext ) const;

    /**

     * From CoeControl.

     * Handles a change to the control's resources.

     *

     * @param aType A message UID value.

     */

    void HandleResourceChange( TInt aType );

    /**

     * From CoeControl.

     * Draw this application's view to the screen

     *

     * @param aRect the rectangle of this view that needs updating

     */

    void Draw( const TRect& aRect ) const;

    /**

     * From CoeControl.

     * Get the control input capabilities

     */

	TCoeInputCapabilities InputCapabilities() const;

    TTypeUid::Ptr MopSupplyObject(TTypeUid aId);

    void HandleGainingForeground();

    void HandleLosingForeground();

// from base class MCoeControlObserver

    /**

    * From MCoeControlObserver, Acts upon changes in the hosted control's state.

    * This class's implementation is trivial and should be able to be safely

    * re-implemented in directly client-derived classes. For non-base setting

    * page classes, a call to the base class should be made.

    * @param aControl Control that caused the event. (not used in default implementation)

    * @param aEventType Type of the event.

    */

    void HandleControlEventL(CCoeControl* aControl, TCoeEvent aEventType);

    /**

     * From MMPXCommonListBoxArrayObserver.

     * Handle listbox array events

     *

     *  @param aEvent list box event

     */

    void HandleListBoxArrayEventL(

        MMPXCommonListBoxArrayObserver::TMPXCommonListBoxArrayEvents aEvent );

// from base class MHgScrollBufferObserver

    /**

     * from MHgScrollBufferObserver

     * Buffer position changed.

     * The items between the aBufferStart and aBufferEnd should be loaded as soon as possible.

     *

     * @param aBufferStart The index of the first item in buffer.

     * @param aBufferEnd The index of the last item in buffer.

     * @param aDirection report direction of scrolling

     */

    void Request(TInt aBufferStart, TInt aBufferEnd, THgScrollDirection aDirection);

// from base class MHgBufferOwner

    /**

     * from MHgBufferOwner

     *

     *

     */

    void Release(TInt aReleaseStart, TInt aReleaseEnd);

// from base class MHgSelectionObserver

    /**

     * Handle selection.

     *

     * @param aIndex Selected item index.

     */

    void HandleSelectL( TInt aIndex );

    void HandleSelectL( TInt aIndex, CCoeControl* aControl );

    /**

     * Handle opening.

     *

     * @param aIndex Opened item index.

     */

    void HandleOpenL( TInt aIndex );

    void HandleOpenL( TInt aIndex, CCoeControl* aControl );

    /**

     *  From MMPXCollectionFindObserver

     *  Handle callback for "find" operation

     *