/*

* Copyright (c) 2002-2005 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:  drop-down list control

*

*/

#ifndef C_CFEPCTRLDROPDOWNLIST_H

#define C_CFEPCTRLDROPDOWNLIST_H

// INCLUDES

#include <e32std.h>

#include <w32std.h>

#include <barsread.h>

#include <peninputdropdownlistcontext.h>

#include <peninputlayoutbasecontrol.h>

#include <AknsUtils.h>

/** class forward decalaration */

class CCandidate;

class CPages;

class CBitmapDb;

class CListManager;

class MEventObserver;

class CBubbleCtrl;

class TAknTextLineLayout;

/** The max length for fixed text */

const TInt KMaxFixedTextNumber = 32;

const TInt KDropDownListCtrlType = EUserCtrlBase | ECtrlBaseCtrl;

/**

 *  The interface dealing with outer event from any control except the list

 *

 *  The interface dealing with outer event from any control except the list

 *

 *  @lib FepCtrlDropdownList.lib

 *  @since S60 v3.2

 */

class MListEventHandler

    {

public:

    /**

     * The method will be called when there is event from any control except from the list

     *

     * @since S60 v3.2

     * @param aEventType The event type

     * @param aCtrl The control who sends out the event

     * @param aEventData The data relative with the event

     */    

    virtual void HandleListOuterEvent(TInt aEventType, CFepUiBaseCtrl* aCtrl, 

                                      const TDesC& aEventData);  

    };

/**

 *  The drop-down list control

 *

 *  The drop-down list control

 *

 *  @lib FepCtrlDropdownList.lib

 *  @since S60 v3.2

 */

class CFepCtrlDropdownList : public CFepUiBaseCtrl,  

                             public MFepCtrlDropdownListContext,

                             public MEventObserver

    { 

public: // internal type definition

    /**

     *  The type of list, expandable or no-expandable

     *

     *  The type of list, expandable or no-expandable

     *

     *  @lib FepCtrlDropdownList.lib

     *  @since S60 v3.2

     */ 

    enum TListType

        {

        EListExpandable,

        EListExpandableWithBubble,

        EListNoExpandable,

        EListNoExpandableWithBubble,

        EListExpandableWithoutIcon,

        EListExpandableRollWithIcon,

		EListExpandableRollWithIconWithBubble,

        EListExpandableMultiRowWithoutIcon      

        };

    enum TCandTruncateType

        {

        // beginning part of candidate are hide

        ECandTruncateFromBeginning,

        // end part of candidate are shown as ellipsis

        ECandTruncateAsEllipsis,

        // end part of candidate are hide

        ECandTruncateFromEnd

        };

    enum TExpandType

        {

        ECandExpandUpward,

        ECandExpandDownward

        };

    // horizontal direction of candidate list: shrink and expanded

    enum THDirection

        {

        ECandFromLToR,

        ECandFromRToL

        };

public: //Method

    /**

     * Destructor

     *

     * @since S60 v3.2

     * @return None.

     */ 

    IMPORT_C virtual ~CFepCtrlDropdownList();

    /**

     * Create one CFepCtrlDropdownList object

     *

     * @since S60 v3.2

     * @param aTopLeftPoint The top left point of the drop down list

     * @param aUiLayout The layout plugin

     * @param aControlId This control ID

     * @param aReader The reader from which the bitmaps ID can be read

     * @param aCellWidth The width of one basic cell

     * @param aCellHeight The height of one basic cell

     * @param aNaviWidth The width of navidation

     * @param aColNum The number of columns in one row

     * @param aRowNum The number of rows

     * @param aFont The font used to draw the text

     * @param aHandler The handle which will deal with outer event to this control

     * @param aAlignment The alighment used to draw text

     * @param aTextMargin if alignment is not ECenter, the margin is used      

     * @param aBorderColor The color of border

     * @param aBgColor The color of background

     * @param aNavigationBgColor The background color of navigation area

     * @param aTextColor The color of text

     * @param aSpecialTextColor The color of special text

     * @param aHighLightTextColor The color of highlight text

     * @param aHighLightBgColor The background color of high light

     * @param aButtonDownBgColor The background color when button pressing

     * @return The CFepCtrlDropdownList object.

     */        

    IMPORT_C static CFepCtrlDropdownList* NewL(const TPoint& aTopLeftPoint,

                                                CFepUiLayout* aUiLayout,

                                                TInt aControlId,

                                                TResourceReader& aReader,

                                                const TInt aCellWidth,

                                                const TInt aCellHeight,

                                                const TInt aNaviWidth,

                                                const TInt aColNum,

                                                const TInt aRowNum,

                                                const CFont* aFont = NULL,

                                                MListEventHandler* aHandler = NULL,

                                                const CGraphicsContext::TTextAlign aAlignment = CGraphicsContext::ECenter,

                                                const TInt aTextMargin = 3,

                                                const TRgb aBorderColor = KRgbBlack,

                                                const TRgb aBgColor = TRgb(0xeeeeee),

                                                const TRgb aNavigationBgColor = TRgb(0xeeeeee), 

                                                const TRgb aTextColor = KRgbBlack,

                                                const TRgb aSpecialTextColor = KRgbBlack,

                                                const TRgb aHighLightTextColor = KRgbBlack,

                                                const TRgb aHighLightBgColor = TRgb(0xcccccc),

                                                const TRgb aButtonDownBgColor = KRgbGray);

    IMPORT_C static CFepCtrlDropdownList* NewL(CFepUiLayout* aUiLayout,

                                               TInt aControlId,

                                               TInt aResId,

                                               TPoint aTopLeftPoint,

                                               TSize aCellSize,

                                               TInt aColNum,

                                               TInt aRowNum);

    IMPORT_C static CFepCtrlDropdownList* NewL(CFepUiLayout* aUiLayout,

                                               TInt aControlId,

                                               TInt aResId,

                                               TPoint aTopLeftPoint,

                                               const CFont* aFont,

                                               TSize aCellSize,

                                               TInt aNaviWidth,

                                               TInt aColNum,

                                               TInt aRowNum,

                                               TInt aSpinBtnHeight,

                                               TInt aHorizontalCellMargin = 0,

                                               TInt aVerticalCellMargin = 0,

                                               THDirection aDirection = ECandFromLToR,

                                               TBool aPageShown = ETrue);

    /**

     * Create one CFepCtrlDropdownList object, need to pop up yourself

     *

     * @since S60 v3.2

     * @param aTopLeftPoint The top left point of the drop down list

     * @param aUiLayout The layout plugin

     * @param aControlId This control ID

     * @param aReader The reader from which the bitmaps ID can be read

     * @param aCellWidth The width of one basic cell

     * @param aCellHeight The height of one basic cell

     * @param aNaviWidth The width of navidation

     * @param aColNum The number of columns in one row

     * @param aRowNum The number of rows

     * @param aFont The font used to draw the text

     * @param aHandler The handle which will deal with outer event to this control

     * @param aAlignment The alighment used to draw text

     * @param aTextMargin if alignment is not ECenter, the margin is used      

     * @param aBorderColor The color of border

     * @param aBgColor The color of background

     * @param aNavigationBgColor The background color of navigation area

     * @param aTextColor The color of text

     * @param aSpecialTextColor The color of special text

     * @param aHighLightTextColor The color of highlight text

     * @param aHighLightBgColor The background color of high light

     * @param aButtonDownBgColor The background color when button pressing

     * @return The CFepCtrlDropdownList object.

     */        

    IMPORT_C static CFepCtrlDropdownList* NewLC(const TPoint& aTopLeftPoint,

                                                CFepUiLayout* aUiLayout,

                                                TInt aControlId,

                                                TResourceReader& aReader,

                                                const TInt aCellWidth,

                                                const TInt aCellHeight,

                                                const TInt aNaviWidth,

                                                const TInt aColNum,

                                                const TInt aRowNum,

                                                const CFont* aFont = NULL,

                                                MListEventHandler* aHandler = NULL,

                                                const CGraphicsContext::TTextAlign aAlignment = CGraphicsContext::ECenter,

                                                const TInt aTextMargin = 3,

                                                const TRgb aBorderColor = KRgbBlack,

                                                const TRgb aBgColor = TRgb(0xeeeeee),

                                                const TRgb aNavigationBgColor = TRgb(0xeeeeee), 

                                                const TRgb aTextColor = KRgbBlack,

                                                const TRgb aSpecialTextColor = KRgbBlack,

                                                const TRgb aHighLightTextColor = KRgbBlack,

                                                const TRgb aHighLightBgColor = TRgb(0xcccccc),

                                                const TRgb aButtonDownBgColor = KRgbGray);

    /**

     * Size change function

     *

     * @since S60 v3.2

     * @param aCellWidth The width of one basic cell

     * @param aCellHeight The height of one basic cell

     * @param aNaviWidth The width of navidation

     * @param aTopLeftPoint The top left point of the drop down list

     * @param aColNum The number of columns in one row

     * @param aRowNum The number of rows

     * @return None.

     */                                                   

    IMPORT_C void SizeChanged(const TInt aCellWidth, const TInt aCellHeight, 

                               const TInt aNaviWidth, const TPoint aTopLeftPoint = TPoint(0,0),

                               const TInt aColNum = 0, const TInt aRowNum = 0);

    /**

     * Set top left point of the list

     *

     * @since S60 v3.2

     * @param aTopLeftPoint The top left point of the drop down list

     * @return None.

     */                                                   

    IMPORT_C void SetTopLeftPoint(const TPoint aTopLeftPoint);

    /**

     * Set the width of one basic cell

     *

     * @since S60 v3.2

     * @param aCellWidth The width of one basic cell

     * @return None.

     */                                                   

    IMPORT_C void SetCellWidth(const TInt aCellWidth);

    /**

     * Set the height of one basic cell

     *

     * @since S60 v3.2

     * @param aCellHeight The height of one basic cell

     * @return None.

     */                                                   

    IMPORT_C void SetCellHeight(const TInt aCellHeight);

    /**

     * Set width of navigation 

     *

     * @since S60 v3.2

     * @param aNaviWidth The width of navidation

     * @return None.

     */                                                   

    IMPORT_C void SetNaviWidth(const TInt aNaviWidth);

    IMPORT_C void SetSpinBtnHeight(const TInt aHeight);

    IMPORT_C void SetCellMargin(const TInt aHorizontalMargin, const TInt aVerticalMargin);

    /**

     * Set column numbers

     *

     * @since S60 v3.2

     * @param aColNum The number of columns in one row

     * @return None.

     */                                                   

    IMPORT_C void SetColNum(const TInt aColNum);

    /**

     * Set or unset highlight for cells.

     *

     * @since S60 v3.2

     * @param aCellIndex Which cell would be set

     * @param aHighlight The flag of highlight, set highlight if ETrue, otherwise cancel highlight

     * @return None.

     */  

    IMPORT_C void SetHighlightCell(const TInt aCellIndex, TBool aHighlight = ETrue,

                                   const TBool aIsDraw = ETrue );

    /**

     * Set row numbers

     *

     * @since S60 v3.2

     * @param aRowNum The number of rows

     * @return None.

     */                                                  

    IMPORT_C void SetRowNum(const TInt aRowNum);

    /**

     * Set border color

     *

     * @since S60 v3.2

     * @param aBorderColor The border color

     * @param aReDraw Redraw if ETrue, otherwise not redraw

     * @return None.

     */                                                   

    IMPORT_C void SetBorderColor(TRgb aBorderColor, TBool aReDraw = EFalse);

    /**

     * Set background color for the whole area

     *

     * @since S60 v3.2

     * @param aBgColor The background color

     * @param aReDraw Redraw if ETrue, otherwise not redraw

     * @return None.

     */                                                   

    IMPORT_C void SetBgColor(TRgb aBgColor, TBool aReDraw = EFalse);

    /**

     * Set background for navigation area

     *

     * @since S60 v3.2

     * @param aNavigationBgColor The background color of navigation area

     * @param aReDraw Redraw if ETrue, otherwise not redraw

     * @return None.

     */                                                   

    IMPORT_C void SetNavigationBgColor(TRgb aNavigationBgColor, TBool aReDraw = EFalse);

    /**

     * Set text color

     *

     * @since S60 v3.2

     * @param aTextColor The color used to draw text

     * @param aReDraw Redraw if ETrue, otherwise not redraw

     * @return None.

     */                                                   

    IMPORT_C void SetTextColor(TRgb aTextColor, TBool aReDraw = EFalse);

    /**

     * Set color for special text

     *

     * @since S60 v3.2

     * @param aSpecialTextColor The color used to draw special text

     * @param aReDraw Redraw if ETrue, otherwise not redraw

     * @return None.

     */                                                   

    IMPORT_C void SetSpecialTextColor(TRgb aSpecialTextColor, TBool aReDraw = EFalse);

    /**

     * Set color for high light text

     *

     * @since S60 v3.2

     * @param aHighLightTextColor The color used to draw high light text

     * @param aReDraw Redraw if ETrue, otherwise not redraw

     * @return None.

     */                                                   

    IMPORT_C void SetHighLightTextColor(TRgb aHighLightTextColor, TBool aReDraw = EFalse);

    /**

     * Set background color for highlight

     *

     * @since S60 v3.2

     * @param aHighLightBgColor The background color of high light area

     * @param aReDraw Redraw if ETrue, otherwise not redraw

     * @return None.

     */                                                   

    IMPORT_C void SetHighLightBgColor(TRgb aHighLightBgColor, TBool aReDraw = EFalse);

    /**

     * The method will be called when there is event from any control except from the list

     *

     * @since S60 v3.2

     * @param aFont The font used to draw text

     * @param aReDraw Redraw if ETrue, otherwise not redraw

     * @return None.

     */                                                   

    IMPORT_C void SetFont(const CFont* aFont, TBool aReDraw = EFalse);

    /**

     * Set text alignment

     *

     * @since S60 v3.2

     * @param aAlignment The alignment used to draw text

     * @param aReDraw Redraw if ETrue, otherwise not redraw

     * @return None.

     */                                                   

    IMPORT_C void SetTextAlighment(const CGraphicsContext::TTextAlign aAlignment, 

                                   TBool aReDraw = EFalse);

    /**

     * Set text margin if alignment is not ECenter

     *

     * @since S60 v3.2

     * @param aTextMargin the margin used to draw text

     * @param aReDraw Redraw if ETrue, otherwise not redraw

     * @return None.

     */                                                   

    IMPORT_C void SetTextMargin(const TInt aTextMargin, TBool aReDraw = EFalse);

    /**

     * set secondary list

     *

     * @since S60 v3.2

     * @param aIndex the cell index need to set new color

     * @param aBgColor The background color

     * @param aReDraw Redraw if ETrue, otherwise not redraw

     * @return None.

     */                                                   

    IMPORT_C void SetSecondaryList(RArray<TInt>& aIndexList, TBool aReDraw = EFalse);

    /**

     * Set event handler when there is out event coming

     *

     * @since S60 v3.2

     * @param aHandler The event handler, which has implemented the interface of MListEventHandler

     * @return None.

     */                                                   

    IMPORT_C void SetListEventHandler(MListEventHandler* aHandler);

    /**

     * Set event id when candidate is selected

     *

     * @since S60 v3.2

     * @param aEventId The event id when candidate is selected

     * @return The CListMultiRowWithIcon pointer.

     */                                                   

    IMPORT_C void SetEventIdForCandidateSelected(TInt aEventId);

    /**

     * Set event id when need to get next page candidate

     *

     * @since S60 v3.2

     * @param aEventId The event id need next page candidate

     * @return None

     */

    IMPORT_C void SetEventIdForNextPageCandidate(TInt aEventId);

    /**

     * Set event id when need to get previous page candidate

     *

     * @since S60 v3.2

     * @param aEventId The event id need previous page candidate

     * @return None

     */

    IMPORT_C void SetEventIdForPreviousPageCandidate(TInt aEventId);

    /**

     * Set event id when need to judge if candidate exist

     *

     * @since S60 v3.2

     * @param aEventId The event id judge if candidate exist

     * @return None

     */

    IMPORT_C void SetEventIdForCandidateExisted(TInt aEventId);

    /**

     * Set candidates for the list

     *

     * @since S60 v3.2

     * @param aCandidates the candidates array

     * @param aListType The list type used when redraw

     * @param aFixedText The fixed text(only used in English)

     * @return None.

     */                                                   

    IMPORT_C void SetCandidatesL(const RPointerArray<HBufC>& aCandidates, 

                                 const TListType aListType  = EListExpandable,

                                 const TDesC& aFixedText = KNullDesC16);

    IMPORT_C void SetCandTruncateType(

                                const TCandTruncateType aTruncateType = ECandTruncateFromEnd);

    /**

     * Add candidates for the list

     *

     * @since S60 v3.2

     * @param aCandidates the candidates array

     * @param aListType The list type used when redraw

     * @return None.

     */

    IMPORT_C void AddCandidatesL(const RPointerArray<HBufC>& aCandidates,

                                 const TListType aListType  = EListExpandable);

    /**

     * Reset and clear all candidates in the list and redraw the list

     *

     * @since S60 v3.2