/*

* Copyright (c) 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: PhoneBook2 custom control. Code has been modified to

*       suit PhoneBook2 requirements. See CColumnListBoxData

*       in EIKCLBD.CPP. 

*       Ensure that this piece of code is in sync with Avkon EIKCLBD.CPP(CColumnListBoxData)

*

*/

#if !defined(__CPbk2ContactViewCustomListBoxData_H__)

#define __CPbk2ContactViewCustomListBoxData_H__

#include <e32base.h>

#include <gdi.h>

#include <eikclbd.h>

#include <eiklbd.h>

#include <avkon.hrh>

#include <babitflags.h>    // for TBitFlags32

class CWindowGc;

class CGulIcon;

class CPbk2ContactViewCustomListBoxDataExtension;

class MAknsControlContext;

class CCoeControl;

class TAknsItemID;

class CAknsEffectAnim;

class CAknsListBoxBackgroundControlContext;

class CAknLayoutData;

class TAknWindowLineLayout;

class TAknTextLineLayout;

class TAknWindowComponentLayout;

class TAknTextComponentLayout;

class MAknsSkinInstance;

class CPbk2ContactViewListBoxModel;

class CPSRequestHandler;

class CPbk2PredictiveSearchFilter;

class MPbk2UiControlCmdItem;

/**

 * The @c CPbk2ContactViewCustomListBoxData class handles the data required to draw a column 

 * list box.

 *

 * The class performs drawing for @c CColumnListBoxItemDrawer. Columns are 

 * numbered from 0 from left to right, and extra column data can be set 

 * for each.

 *

 * N.B.: The standard width of a column drawn by @c CColumnListListBoxData is  

 * 0 pixels, so at the very least a column width should be set for each column 

 * in a column list box.    

 *

 * This class is not intended for user derivation. 

 */

class CPbk2ContactViewCustomListBoxData : public CListBoxData

    {

    friend class CPbk2ContactViewCustomListBoxDataExtension;

public:

    /**

     * Represents the colours used within the border and for the optional 

     * single pixel border outlines.

     *

     * These colours are stored using @c TRgb values.

     */

    class TColors

        {

    public:

        /**

         * C++ default constructor.

         */

        TColors();

    public:

        /**

         * Stores text Color.

         */

        TRgb iText;

        /**

         * Stores background color.

         */

        TRgb iBack;

        /**

         * Stores highLighted text color.

         */ 

        TRgb iHighlightedText;

        /**

         * Stores highlighted background colour.

         */

        TRgb iHighlightedBack;

        };

    /**

     * Set internal data model to work with special PCS data

     * @param aDataModel PCS data model 

     */        

    void SetDataModel(CPbk2ContactViewListBoxModel* aDataModel);

    /**

     * Draws the text in a single row with the predictive searched characters

     * underlined

     *

     *

     * @param aItemProperties The properties of each column in the row.

     * @param aGc The graphics context to draw into.

     * @param aRect Bounding rectangle for the entire row.

     * @param aTextToDraw Parsed Text which needs to be drawn.

     * @param aText Original Text.

     * @param aTextLayout Low level drawing based on European LAF document.

     * @param aTextLineLayout A text line structure from layout.

     * @param aUseLogicalToVisualConversion

     * @param aUsedFont Font to be used in Drawing the Text

     * @param aTextColor Color of the text     

     */

    void DrawEnhancedTextL(

            const TListItemProperties& aItemProperties,

            CWindowGc& aGc,

            const TRect& aRect,

            const TDesC& aTextToDraw,

            const TPtrC& aText,

            TAknLayoutText &aTextLayout,

            TAknTextLineLayout &aTextLineLayout, 

            TBool aUseLogicalToVisualConversion,

            const CFont* aUsedFont,        

            TRgb aTextColor

            ) const;

    /**

     * Sets the commands that should appear at the top of the list.

     * @param aCommands An array of commands. NULL may be given to

     *        indicate that no commands are to be shown. 

     */

    void SetListCommands( const RPointerArray<MPbk2UiControlCmdItem>* aCommands );

    TBool IsContactAtListboxIndex( TInt aListboxIndex ) const;

    TInt CommandItemCount() const;

public:

    /**

     * Two-phased constructor.

     *

     * Allocates and constructs a column list box data object.

     *

     * Constructs an array in which the column data is held.

     *

     * @param aSearchFilter PBk2 Search Filter

     * @return New @c CPbk2ContactViewCustomListBoxData.

     */

    static CPbk2ContactViewCustomListBoxData* NewL( CPbk2PredictiveSearchFilter &aSearchFilter );

    /**

     * Destructor.

     */

    ~CPbk2ContactViewCustomListBoxData();

public:

    /**

     * Gets the index of the last defined column.

     *

     * @return The index of the last defined column or @c KErrNotFound if no 

     *         column has been defined.

     */

    TInt LastColumn() const;

    /**

     * Gets the specified column’s width in pixels.

     *

     * @param aColumn The index of the column for which the width is obtained.

     * @return The specified column’s width in pixels. Zero is returned if no 

     *         column exists at the specified index.

     */

    TInt ColumnWidthPixel(TInt aColumn) const;

    /**

     * Sets the specified column’s width in pixels.

     * 

     * If the column does not exist, one is added at the specified index, 

     * with the specifed width.

     *

     * @param aColumn The index of the column for which the width is to be set.

     * @param aWidth The width in pixels.

     */

    void SetColumnWidthPixelL(TInt aColumn,TInt aWidth);

    /**

    * Not used in S60.

    */

    TInt ColumnHorizontalGap(TInt aColumn) const;

    /**

    * Not used in S60.

    */

    void SetColumnHorizontalGapL(TInt aColumn,TInt aGap);

    /**

     * Gets column's baseline.

     *

     * @param aColumn target column.

     * @return Vertical position.

     */

    TInt ColumnBaselinePos(TInt aColumn) const;

    /**

     * Sets columns baseline position.

     *

     * @param aColumn Target column.

     * @param aPos Wanted position.

     */

    void SetColumnBaselinePosL(TInt aColumn,TInt aPos);

    /**

     * Gets column's margins.

     *

     * @param aColumn Target column.

     * @return The columns margins.

     */

    TMargins ColumnMargins(TInt aColumn) const;

    /**

     * Sets column's margins.

     *

     * @param aColumn Target column.

     * @param aMargins Wanted margins.

     */

    void SetColumnMarginsL(TInt aColumn,TMargins aMargins);

    /**

     * Gets font used by the column.

     *

     * @param aColumn Target column.

     * @return Used font.

     */

    const CFont* ColumnFont(TInt aColumn) const;

    /**

     * Sets column's font.

     *

     * @param aColumn Target column.

     * @param aFont Wanted font.

     */

    void SetColumnFontL(TInt aColumn,const CFont* aFont);

    /**

     * Gets the text alignment for the specified column.

     *

     * @param  aColumn The index of the column for which the alignment 

     *         is obtained.

     * @return The text alignment for the specified column. The default 

     *         is @c ELeft.

     */

    CGraphicsContext::TTextAlign ColumnAlignment(TInt aColumn) const;

    /**

     * Sets the text alignment for the specified column.

     *

     * If the column does not exist, it is added with the specified index 

     * to the array.

     *

     * @param aColumn The index of the column for which alignment is set.

     * @param aAlign The text alignment to use. The default is @c ELeft.

     */

    void SetColumnAlignmentL(TInt aColumn,

                                      CGraphicsContext::TTextAlign aAlign);

    /**

    * Not used in S60.

    */

    CGraphicsContext::TPenStyle ColumnSeparatorStyle(

                                                        TInt aColumn) const;

    /**

    * Not used in S60.

    */

    void SetColumnSeparatorStyleL(TInt aColumn, 

                                           CGraphicsContext::TPenStyle aStyle);

    /**

     * Checks whether the column is optional.

     *

     * @param aColumn Target column.

     * @return @c ETrue if the column is optional.

     */

    TBool ColumnIsOptional(TInt aColumn) const;

    /**

     * Sets whether the column is optional.

     *

     * @param aColumn Target column.

     * @param aIsOptional Wanted setting, @c ETrue if column is optional.

     */

    void SetOptionalColumnL(TInt aColumn,TBool aIsOptional);

    /**

     * Checks whether the column contains graphics.

     *

     * @param aColumn Target column.

     * @return @c ETrue if column contains graphics.

     */

    TBool ColumnIsGraphics(TInt aColumn) const;

    /**

     * Sets whether the column shows graphics.

     *

     * @param aColumn Target column.

     * @param aIsGraphics Wanted setting.

     */

    void SetGraphicsColumnL(TInt aColumn,TBool aIsGraphics);

    /**

     * Checks if the column is a number.

     *

     * @param aColumn Target column.

     * @return @c ETrue if it is a number.

     */

    TBool ColumnIsNumber(TInt aColumn) const;

    /**

     * Sets whether the column is a number. 

     *

     * @param aColumn Target columun.

     * @param aIsNumber Wanted setting. @c ETrue if it is a number.

     */

    void SetNumberColumnL(TInt aColumn,TBool aIsNumber);

    /**

     * Gets the icon array. 

     *

     * These icons contain the bitmaps that are displayed in graphical columns.

     *

     * @return Pointer to the icon array.

     */

    CArrayPtr<CGulIcon>* IconArray() const;

    /**

     * Sets icon array.

     *

     * @param aArray Wanted icon collection .

     */

    void SetIconArray(CArrayPtr<CGulIcon>* aArray);

    /**

     * Gets TextClipGap, the gap between words in a text clip, for the 

     * given column.

     *

     * @param aSubCellIndex Index to target column.

     * @return TextClipGap.

     */

    TInt ColumnTextClipGap(TInt aSubCellIndex) const;

    /**

     * Sets columns TextClipGap, the gap between words in a text clip.

     *

     * @param aSubCellIndex Index of the target column.

     * @param aSize Wanted TextClipGap size. 

     */

    void SetColumnTextClipGapL(TInt aSubCellIndex, TInt aSize);

    /**

     * Gets the specified font for the specified column.

     *

     * @param aItemProperties Whether the required font is:

     *        bold, italic, bold and italic or normal.

     * @param aColumn The index of the column for which the font is obtained.

     * @return The specified column’s, specified font. Null, the 

     *         default, if no font is set for the column.

     */

    CFont* Font(const TListItemProperties& aItemProperties, 

                         TInt aColumn) const;

    /**

     * Gets the specified column’s surrounding rectangle.

     *

     * @param aColumn The index of the column for which the rectangle 

     *                is obtained.

     * @param aRect On return contains the specified column’s rectangle.

     * @return @c ETrue if successful. @c EFalse if a non-existent column 

     *               was specified.

     */

    TBool MakeColumnRect( TInt aColumn, TRect& aRect );

    /**

     * Draws a single row.

     *

     * The text @c aText is parsed into columns and is split using 

     * @c KColumnListSeparator. Text or bitmaps are drawn according to whether 

     * the column has been set as a graphical column 

     * (see @c SetGraphicsColumnL()). Column cells within the row are drawn 

     * from left to right.

     *

     * @param aItemProperties The properties of each column in the row.

     * @param aGc The graphics context to draw into.

     * @param aText The text to parse and draw.

     * @param aRect Bounding rectangle for the entire row.

     * @param aHighlight @c ETrue to draw the item highlighted. 

     *        @c EFalse otherwise.

     * @param aColors The colours to use if the item is highlighted.

     * @param aItemIndex Index of the item to draw.

     */

    virtual void Draw(const TListItemProperties& aItemProperties, 

                               CWindowGc& aGc,

                               const TDesC* aText,

                               const TRect& aRect,

                               TBool aHighlight,

                               const TColors& aColors,

                               TInt aItemIndex) const;

    /**

    * internal

    */

    void DrawSimpleL(const TListItemProperties& aItemProperties, CWindowGc& aGc,const TDesC* aText,const TRect& aRect,

                    TBool aHighlight,const TColors& aColors,TInt aItemIndex) const;

    /**

     * Sets position of listbox line.

     *

     * @param aPosition Wanted position.

     */

    void SetSeparatorLinePosition(

                                        TAknSeparatorLinePosition aPosition);

    /**

     * Gives out separator line position.

     *

     * @return Separator position.

     */

    TAknSeparatorLinePosition SeparatorLinePosition() const;

    /**

     * 

     * @deprecated

     *

     * Gives out layout data for separator line drawing.

     *

     * @return Requested layout data.

     */

    CAknLayoutData *LayoutData() const;

    /**

     * 

     * @deprecated

     *

     * Checks if the layout has been initialized.

     *

     * @return @c ETrue if initialized.

     */

    TBool LayoutInit() const;

    /**

     * 

     * @deprecated

     *

     * Sets the initialization .

     *

     * @param aValue Wanted value (@c ETrue = initialized).

     */

    void SetLayoutInit(TBool aValue) const;

    /**

     * Enables / disables underlining per text column,

     * if and only if @c TListItemProperties also has underlining enabled.

     * If this method is not called and @c TListItemProperties has underlining

     * enabled, drawing will revert to old style where only first text column

     * will be underlined.

     *

     * @since S60 3.0

     * @param aUnderlinedColumns Bitmask of columns to be underlined.

     */    

    void SetColumnUnderlined( TBitFlags32 aUnderlinedColumns );

private:

    struct SColumn

        {

        TInt iColumn; // Must be first entry

        TInt iWidth;

        TMargins iMargins;

        TInt iVerticalCap;

        const CFont* iBaseFont;

        TInt iActualFontIndex;

        TBool iGraphics;

    TBool iOptional;

    TInt iBaseline;

        CGraphicsContext::TTextAlign iAlign;

    CGraphicsContext::TPenStyle iSeparator;

    TInt iTextClipGap;

    TBool iNumberColumn;

    // the next are for storing x-coordinates of a column for the drawing algorithm.

    __MUTABLE TInt iX;

    __MUTABLE TInt iEndX;

        };

protected:

    /**

     * C++ default constructor.

     */

    CPbk2ContactViewCustomListBoxData( CPbk2PredictiveSearchFilter &aSearchFilter );

    /**

     * A second phase constructor. 

     *

     * Highlight animation will be created by default (if it is provided 

     * by the skin).

     */

    void ConstructLD();

    /**

     * Second phase constructor for subclasses that want to override highlight

     * animation creation.

     *

     * @since 3.0