/*

* Copyright (c) 2002-2008 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:  Tab control for the status pane's navigation pane.

*

*/

#ifndef AKNTABGRP_H

#define AKNTABGRP_H

//  INCLUDES

#include <AknControl.h>

#include <coeccntx.h>

#include <coecobs.h>

#include <AknNaviDecoratorObserver.h>

#include "aknconsts.h"

#include "AknUtils.h"

#include <avkon.mbg>

// FORWARD DECLARATIONS

class CEikLabel;

class CEikImage;

class CAknTabGroup;

class CAknTabGroupExtension;

class MAknTabObserver;

class MAknNaviDecoratorObserver;

class TAknWindowLineLayout;

class CAknTabExtension;

/**

*  Tab item control used inside a tab group.

*

*  @lib avkon.lib

*  @since 0.9

*/

NONSHARABLE_CLASS( CAknTab ) : public CAknControl

    {

friend class CAknTabGroup;

public:

    /**

    * Indicates a tab title's type

    */

    enum TAknTabDataType

        {

        /** Tab title is empty.*/

        EAknTabNone,

        /** Tab title has only text. */

        EAknTabText,

        /** Tab title has only icon */

        EAknTabIcon,

        /** Tab title has both text and icon. */

        EAknTabTextAndIcon

        };

public:

    /**

    * Destructor

    */

    ~CAknTab();

    /**

    * Two-phased constructor.

    *

    * @param  aParent  Reference to parent control.

    * @param  aReader  Reference to resource reader.

    *

    * @return A pointer to constructed @c CAknTab object.

    */

    static CAknTab* NewL( const CCoeControl& aParent,

                          TResourceReader& aReader );

    /**

    * Two-phased constructor.

    *

    * @param  aParent  Reference to parent control.

    * @param  aReader  Reference to resource reader.

    *

    * @return A pointer to constructed @c CAknTab object.

    */

    static CAknTab* NewLC( const CCoeControl& aParent,

                           TResourceReader& aReader );

    /**

    * Two-phased constructor.

    *

    * @param  aId       Tab ID.

    * @param  aParent   Reference to parent control.

    * @param  aTabText  Reference to title text.

    *

    * @return A pointer to constructed @c CAknTab object.

    */

    static CAknTab* NewL( TInt aId,

                          const CCoeControl& aParent,

                          const TDesC& aTabText );

    /**

    * Two-phased constructor.

    *

    * @param  aId       Tab ID.

    * @param  aParent   Reference to parent control.

    * @param  aTabText  Reference to title text.

    *

    * @return A pointer to constructed @c CAknTab object.

    */

    static CAknTab* NewLC( TInt aId,

                           const CCoeControl& aParent,

                           const TDesC& aTabText );

    /**

    * Two-phased constructor.

    *

    * @param  aId         Tab ID.

    * @param  aParent     Reference to parent control.

    * @param  aTabText    Reference to title text.

    * @param  aTabBitmap  Bitmap for the tab. Ownership of the bitmap is taken.

    * @param  aMask       Bitmap's mask. Ownership of the mask is taken.

    *

    * @return A pointer to constructed @c CAknTab object.

    */

    static CAknTab* NewL( TInt aId,

                          const CCoeControl& aParent,

                          const TDesC& aTabText,

                          const CFbsBitmap* aTabBitmap,

                          const CFbsBitmap* aMask = NULL );

    /**

    * Two-phased constructor.

    *

    * @param  aId         Tab ID.

    * @param  aParent     Reference to parent control.

    * @param  aTabText    Reference to title text.

    * @param  aTabBitmap  Bitmap for the tab. Ownership of the bitmap is taken.

    * @param  aMask       Bitmap's mask. Ownership of the mask is taken.

    *

    * @return A pointer to constructed @c CAknTab object.

    */

    static CAknTab* NewLC( TInt aId,

                           const CCoeControl& aParent,

                           const TDesC& aTabText,

                           const CFbsBitmap* aTabBitmap,

                           const CFbsBitmap* aMask = NULL );

    /**

    * Two-phased constructor.

    *

    * @param  aId         Tab ID.

    * @param  aParent     Reference to parent control.

    * @param  aTabBitmap  Bitmap for the tab. Ownership of the bitmap is taken.

    * @param  aMask       Bitmap's mask. Ownership of the mask is taken.

    *

    * @return A pointer to constructed @c CAknTab object.

    */

    static CAknTab* NewL( TInt aId,

                          const CCoeControl& aParent,

                          const CFbsBitmap* aTabBitmap,

                          const CFbsBitmap* aMask = NULL );

    /**

    * Two-phased constructor.

    *

    * @param  aId         Tab ID.

    * @param  aParent     Reference to parent control.

    * @param  aTabBitmap  Bitmap for the tab. Ownership of the bitmap is taken.

    * @param  aMask       Bitmap's mask. Ownership of the mask is taken.

    *

    * @return A pointer to constructed @c CAknTab object.

    */

    static CAknTab* NewLC( TInt aId,

                           const CCoeControl& aParent,

                           const CFbsBitmap* aTabBitmap,

                           const CFbsBitmap* aMask = NULL );

    /**

    * Replace the tab title.

    *

    * @param  aTabText  New title text.

    */

    void ReplaceTextL( const TDesC& aTabText );

    /**

    * Activate or deactive this tab.

    *

    * @param  aActive   @c ETrue for activation, @c EFalse for deactivation.

    * @param  aDrawNow  Indicates whether control need to be redrawn.

    */

    void SetActive( TBool aActive, TDrawNow aDrawNow );

    /**

    * Determines whether this tab is active.

    *

    * @return @c ETrue if a tab is active, @c EFalse if not.

    */

    TBool Active() const;

    /**

    * Gets tab's ID.

    *

    * @return Tabs' ID.

    */

    TInt Id() const;

    /**

    * Gets this tab's type.

    *

    * @return Tab's type.

    */

    enum TAknTabDataType TabType() const;

    /**

    * Sets the total amount of tabs in the tabgroup where this tab belongs to.

    */

    void SetTotalAmountOfTabs( TInt aAmount );

    /**

    * Sets the narrow tab layout.

    * @internal Used by the UI framework.

    * Applications can set the narrow layout using @c CAknNaviDecorator class.

    */

    void SetNarrowTabLayout( TBool aNarrow );

    /**

    * Sets the flag indicating whether or not this tab contains

    * a multi-colored title icon.

    *

    * The multi-color mode should be used with color icons,

    * otherwise the tab icon is drawn using a color

    * defined in the current skin.

    * 

    * @param  aMultiColor  @c ETrue to set the multi-color mode on,

    *                      @c EFalse to turn it off.

    */

    void SetMultiColorMode( TBool aMultiColor );

    /**

    * Checks whether or not this tab is drawn using multi-color mode or not.

    *

    * @return @c ETrue if this tab contains a multi-color icon,

    *         @c EFalse otherwise.

    */

    TBool MultiColorMode() const;

    /**

    * Sets the long tab layout.

    * @internal Used by the UI framework.

    */

    void SetLongTabLayout( TBool aLongTab );

public: // From base class @c CCoeControl.

    /**

    * Gets the minimum size of the tab.

    *

    * @return Minimum size of the tab.

    */

    virtual TSize MinimumSize();

    /**

    * Sets the tab dimmed.

    *

    * @param  aDimmed  @c ETrue to dim the control,

    *                  @c EFalse to set the control as not dimmed.

    */

    virtual void SetDimmed( TBool aDimmed );

    /**

    * Gets the list of logical colors employed

    * in the drawing of the control, paired with an explanation of how

    * they are used. Appends the list into @c aColorUseList.

    *

    * @param[in,out]  aColorUseList  The color list.

    */

    virtual void GetColorUseListL(

        CArrayFix<TCoeColorUse>& aColorUseList ) const;

protected: // From base class @c CCoeControl.

    /**

    * Responds to size changes events to sets the size and

    * position of the contents of this control.

    */

    virtual void SizeChanged();

    /**

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

    *

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

    */

    virtual TInt CountComponentControls() const;

    /**

    * Gets the specified component of a compound control.

    *

    * @param  aIndex  The index of the control to get.

    *

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

    */

    virtual CCoeControl* ComponentControl( TInt aIndex ) const;

    /**

    * Handles pointer events.

    * This function is called by framework whenever a pointer event

    * occurs in the control.

    *

    * @param  aPointerEvent  The pointer event.

    */

    virtual void HandlePointerEventL( const TPointerEvent& aPointerEvent );

private: // From base class @c CAknControl.

    IMPORT_C void* ExtensionInterface( TUid aInterface );

private: // From base class @c CCoeControl.

    virtual void Draw( const TRect& aRect ) const;

private:

    CAknTab( TInt aId );

    void ConstructFromResourceL( TResourceReader& aReader );

    void ConstructL( const TDesC& aTabText );

    void ConstructL( const CFbsBitmap* aTabBitmap,

                     const CFbsBitmap* aMask = NULL );

    void LoadColorBitmapL();

    /**

    * Handles a change to the control's resources.

    *

    * @param  aType  The event type.

    */

    void HandleResourceChange( TInt aType );

    void SizeChangedInNormalLayout();

    void SizeChangedInFlatLayout();

    void SizeChangedInNarrowLayout();

    /**

     * Sets the flag to indicate the highlight status

     * 

     * @param  aHighlight  highlight status

     *                     default is EFalse

     */

    void SetHighlight(TBool aHighlight);

private:

    CEikLabel* iLabel;

    TInt       iId;

    TBool      iActive;

    const CFbsBitmap* iBitmap;

    const CFbsBitmap* iBitmapMask;

    TAknLayoutRect    iBitmapRect;

    CAknTabExtension* iExtension;

    typedef CArrayPtrFlat<CFbsBitmap> CAknTabColorBitmapArray;

    CAknTabColorBitmapArray* iColorBitmaps;

    };

/**

* Tab group functionality for navigation pane.

*

* @lib avkon.lib

* @since 0.9

*/

class CAknTabGroup : public CAknControl,

                     public MCoeControlObserver,

                     public MCoeControlContext,

                     public MAknNaviDecoratorObserver

    {

public:

    /**

    * Destructor.

    */

    IMPORT_C ~CAknTabGroup();

    /**

    * Creates new tab group.

    *

    * @param  aParent  Parent control.

    */

    IMPORT_C static CAknTabGroup* NewL( const CCoeControl& aParent );

    /**

    * Creates new tab group and pushes it to the clean up stack.

    *

    * @param  aParent  Parent control.

    */

    IMPORT_C static CAknTabGroup* NewLC( const CCoeControl& aParent );

public:

    /**

    * Add a tab to the tab group from resources.

    *

    * @param  aReader  Resource reader.

    *

    * @return ID of the added tab.

    */

    IMPORT_C TInt AddTabL( TResourceReader& aReader );

    /**

    * Add a tab to the tab group.

    *

    * @param  aTabId    ID of the tab to be added.

    * @param  aTabText  Text for the tab.

    */

    IMPORT_C void AddTabL( TInt aTabId, const TDesC& aText );

    /**

    * Add a tab to the tab group.

    *

    * @param  aTabId      ID of the tab.

    * @param  aTabText    Text for the tab.

    * @param  aTabBitmap  Bitmap for the tab. Ownership of the bitmap is taken.

    * @param  aMask       Bitmap's mask. Ownership of the mask is taken.

    */

    IMPORT_C void AddTabL( TInt aTabId,

                           const TDesC& aText,

                           const CFbsBitmap* aTabBitmap,

                           const CFbsBitmap* aMask = NULL );

    /**

    * Add a tab to the tab group.

    *

    * @param  aTabId      ID of the tab.

    * @param  aTabBitmap  Bitmap for the tab. Ownership of the bitmap is taken.

    * @param  aMask       Bitmap's mask. Ownership of the mask is taken.

    */

    IMPORT_C void AddTabL( TInt aTabId,

                           const CFbsBitmap* aTabBitmap,

                           const CFbsBitmap* aMask = NULL );

    /**

    * Replaces a tab with a new one from resources.

    * Tab with same ID is replaced.

    *

    * @param  aReader  Resource reader.

    */

    IMPORT_C void ReplaceTabL( TResourceReader& aReader );

    /**

    * Replaces a tab with a new one.

    *

    * @param  aTabId    ID of the tab to be replaced.

    * @param  aTabText  Text for the new tab.

    */

    IMPORT_C void ReplaceTabL( TInt aTabId, const TDesC& aText );

    /**

    * Replaces a tab with a new one.

    *

    * @param  aTabId      ID of the tab to be replaced.

    * @param  aTabText    Text for the new tab.

    * @param  aTabBitmap  Bitmap for the tab. Ownership of the bitmap is taken.

    * @param  aMask       Bitmap's mask. Ownership of the mask is taken.

    */

    IMPORT_C void ReplaceTabL( TInt aTabId,

                               const TDesC& aText,

                               const CFbsBitmap* aTabBitmap,

                               const CFbsBitmap* aMask = NULL );

    /**

    * Replaces a tab with a new one.

    *

    * @param  aTabId      ID of the tab to be replaced.

    * @param  aTabBitmap  Bitmap for the tab. Ownership of the bitmap is taken.

    * @param  aMask       Bitmap's mask. Ownership of the mask is taken.

    */

    IMPORT_C void ReplaceTabL( TInt aTabId,

                               const CFbsBitmap* aTabBitmap,

                               const CFbsBitmap* aMask = NULL );

    /**

    * Replaces a tab text with a new one.

    *

    * @param  aTabId    ID of the tab containing the text to be replaced.

    * @param  aTabText  New tab text.

    */

    IMPORT_C void ReplaceTabTextL( TInt aTabId, const TDesC& aTabText );

    /**

    * Delete a tab from the tab group.

    *

    * @param  aTabId  ID of the tab to be deleted.

    */

    IMPORT_C void DeleteTabL( TInt aTabId );

    /**

    * Activate (highlight) a tab.

    *

    * @param  aTabId  ID of the tab to be highlighted.

    */

    IMPORT_C void SetActiveTabById( TInt aTabId );

    /**

    * Activate (highlight) a tab.

    *

    * @param  aTabIndex  Index of the tab to be highlighted.

    */

    IMPORT_C void SetActiveTabByIndex( TInt aTabIndex );

    /**

    * Returns the ID of the currently active (highlighted) tab.