/*

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

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members

* which accompanies this distribution, and is available

* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description: 

*

*/

#ifndef __AKNLISTS_H__

#define __AKNLISTS_H__

#include <eikclb.h>

#include <eikfrlb.h>

#include <eikslb.h>

#include <AknGrid.h>

#include <aknutils.h>

#include <aknpanic.h>

class TAknTextLineLayout;

class MAknsSkinInstance;

class MAknsControlContext;

/** THIS FILE INCLUDES:

 *  1) All listbox layouts specified in Avkon LAF specification

 *      a) General list pane descendants

 *      b) Pop up window list pane descendants

 *      c) Grid panes

 *  2) Utilities that help building listbox layouts based on LAF specification

 *  3) Other helper classes that handle listbox behavior

 */

//

//

// Helper template definitions.

// (these are before concrete listbox classes because they're needed for inheritance)

//

/**

 * This adds correct horizontal and vertival lines to the listbox and handles empty listbox!

 *

 * This class is only useful if you're writing your own list layout. 

 * Please use the predefined layouts instead, for example CAknSingleStyleListBox.

 */

template<class T>

class AknListBoxLinesTemplate : public T

    {

public:

    /** AknListBoxLinesTemplate

     *

     * Read AVKON_LISTBOX_LINES resources. 

     *

     * The following predefined lines are available:

     * R_LIST_PANE_LINES_A_COLUMN

     * R_LIST_PANE_LINES_AB_COLUMN

     * R_LIST_PANE_LINES_AB_COLUMN_X

     * R_LIST_PANE_LINES_AB_COLUMN_XX

     * R_LIST_PANE_LINES_BC_COLUMN

     * R_LIST_PANE_LINES_BC_COLUMN_X

     * R_LIST_PANE_LINES_BC_COLUMN_XX

     * 

     */

    IMPORT_C AknListBoxLinesTemplate(TInt aResourceId);

    /** SizeChanged()

     * 

     * Determines position of the lines

     */

    IMPORT_C void SizeChanged();

    /** Draw()

     * 

     * Draws the lines

     */

    IMPORT_C void Draw(const TRect& aRect) const;

    /** CountComponentControls()

     * 

     * Choose controls to use as child controls

     */

    IMPORT_C TInt CountComponentControls() const;

    /** CountComponentControls()

     * 

     * Choose controls to use as child controls

     */

    IMPORT_C CCoeControl* ComponentControl(TInt aIndex) const;

private:

    TInt iSpare0;                           // was iResourceId;

    TAknLayoutRect iVertLine1, iVertLine2;  // not used

    TAknLayoutRect iHoriLine;               // not used

    TBool iResized;

    TInt iSpare[2];

    };

/**

 * Empty layout for popup lists

 */

template<class T>

class AknPopupListEmpty : public T

    {

   /**

    * Draws empty list when needed. See AknDraw::DrawEmptyList().

    */

    IMPORT_C virtual void Draw(const TRect &aRect) const;

    };

	/** 

	* Avkon version of eikon's column listbox.

	* Content for list items are tab-separated strings.

	*

	* See methods 

	*   CEikListBox::ConstructFromResourceL()

	*   CEikListBox::ConstructL()

	*   CEikTextListBox::SetItemArray()

	*   CEikColumnListBoxData::SetIconArray()

	* 

	* Related flags for ConstructL() (avkon.hrh)

	*   EAknListBoxSelectionList

	*   EAknListBoxMenuList

	*   EAknListBoxMarkableList

	*   EAknListBoxMultiselectionList

	*   EAknListBoxViewerFlags

	*

	* Related flags for dialogs (avkon.hrh)

	*   EAknDialogSelectionList

	*   EAknDialogMenuList

	*   EAknDialogMultiselectionList

	*

	* @since Series 60 0.9

	*

	*/

class CAknColumnListBox : public CEikColumnListBox

    {

public:

    /** 

	* Creates new @c CAknColumnListBoxView object and returns pointer to it.

	* @return Pointer to the list box view which displays the list items which

	* are currently visible in a list box.

    */

    IMPORT_C virtual CListBoxView* MakeViewClassInstanceL();

    /** 

    * Creates @c CAknFilteredTextListBoxModel object.

    */

    IMPORT_C virtual void CreateModelL();

    /** 

    * Listbox rectangle calculation. Rounds down the height of the rectangle

    * (if necessary) so that only a whole number of items can be displayed

    * inside the list box.

    * @param aRect The size of the listbox.

    * @return The number of pixels reduced.

    */

    IMPORT_C virtual TInt AdjustRectHeightToWholeNumberOfItems(TRect& aRect) const;

    /**

     * From CCoeControl.     

     * Handles pointer events

     */

    IMPORT_C void HandlePointerEventL(const TPointerEvent& aPointerEvent);

private:

    /**

    * From CAknControl

    */

    IMPORT_C void* ExtensionInterface( TUid aInterface );

private: // listbox use only

	IMPORT_C virtual void CEikListBox_Reserved(); 

    };

//

// These define what features are needed --> you can remove shortcuts from ALL lists by changing these..

// Templates available: AknListBoxLinesTemplate<> AknListBoxShortCutTemplate<>

typedef AknListBoxLinesTemplate<CAknColumnListBox > CEikColumnListBoxTypedef;

typedef AknListBoxLinesTemplate<CEikFormattedCellListBox > CEikFormattedCellListBoxTypedef;

typedef AknListBoxLinesTemplate<CEikSettingsListBox > CEikSettingsListBoxTypedef;

typedef CAknGrid CAknSelectionGridTypedef;

// Templates available: AknListBoxShortCutTemplate<> AknListBoxLinesTemplate<>

#define AKNCOLUMNLISTBOXNAME(x) AknListBoxLinesTemplate<CAknColumnListBox >(x)

#define AKNDOUBLELISTBOXNAME(x) AknListBoxLinesTemplate<CEikFormattedCellListBox >(x)

#define AKNSETTINGLISTBOXNAME(x) AknListBoxLinesTemplate<CEikSettingsListBox >(x)

// Templates available: AknListBoxLinesTemplate<>, AknListBoxShortCutTemplate<>

#define AKNCOLUMNLISTBOX AknListBoxLinesTemplate<CAknColumnListBox >

#define AKNFORMATTEDLISTBOX AknListBoxLinesTemplate<CEikFormattedCellListBox >

#define AKNSETTINGSLISTBOX AknListBoxLinesTemplate<CEikSettingsListBox >

#define AKNGRID CAknGrid

//

//

// Derived listboxes (Use these in applications!)

// These are only for full screen lists -- the Rect() of the list must be ClientRect()

//

//

/**

 * list_single_pane

 *

 * list item string format: "\tTextLabel\t0\t1"

 * where 0 and 1 are indexes to icon array

 */

class CAknSingleStyleListBox : public CEikColumnListBoxTypedef

    {

public:

    IMPORT_C CAknSingleStyleListBox();

    /** SizeChanged()

     * 

     * Determines layout of the listbox

     */

    IMPORT_C void SizeChanged();

    /** MinimumSize()

     * 

     * Determines size of the listbox for use in dialogs.

     */

    IMPORT_C TSize MinimumSize();

    /**

     * From CCoeControl.     

     * Handles pointer events

     */

    IMPORT_C void HandlePointerEventL(const TPointerEvent& aPointerEvent);  

private:

    void SizeChangedL();

    };

/**

 * list_single_number_pane

 *

 * list item string format: "2\tTextLabel\t0\t1"

 * where 0 and 1 are indexes to icon array

 */

class CAknSingleNumberStyleListBox : public CEikColumnListBoxTypedef

    {

public:

    IMPORT_C CAknSingleNumberStyleListBox();

    /** SizeChanged()

     * 

     * Determines layout of the listbox

     */

    IMPORT_C void SizeChanged();

    /** MinimumSize()

     * 

     * Determines size of the listbox for use in dialogs.

     */

    IMPORT_C TSize MinimumSize();

    /**

     * From CCoeControl.     

     * Handles pointer events

     */

    IMPORT_C void HandlePointerEventL(const TPointerEvent& aPointerEvent);   

private:

    void SizeChangedL();

    };

/**

 * list_single_heading_pane

 *

 * list item string format: "Heading\tTextLabel\t0\t1"

 * where 0 and 1 are indexes to icon array

 *

 */

class CAknSingleHeadingStyleListBox : public CEikColumnListBoxTypedef

    {

public:

    IMPORT_C CAknSingleHeadingStyleListBox();

    /** SizeChanged()

     * 

     * Determines layout of the listbox

     */

    IMPORT_C void SizeChanged();

    /** MinimumSize()

     * 

     * Determines size of the listbox for use in dialogs.

     */

    IMPORT_C TSize MinimumSize();

    /**

     * From CCoeControl.     

     * Handles pointer events

     */

    IMPORT_C void HandlePointerEventL(const TPointerEvent& aPointerEvent); 

protected:

    /** CreateItemDrawerL()

     *

     * Chooses which itemdrawer to use.

     */

    IMPORT_C virtual void CreateItemDrawerL();

   /** MakeViewClassInstanceL()

    *

    * Chooses which listbox view class to use

    */

    IMPORT_C virtual CListBoxView* MakeViewClassInstanceL();

private:

    void SizeChangedL();

    };

/**

 * list_single_graphic_pane

 *

 * list item string format: "0\tTextLabel\t1\t2"

 * where 0,1,2 are index to the icon array 

 */

class CAknSingleGraphicStyleListBox : public CEikColumnListBoxTypedef

    {

public: 

    IMPORT_C CAknSingleGraphicStyleListBox();

    /** SizeChanged()

     * 

     * Determines layout of the listbox

     */

    IMPORT_C void SizeChanged();

    /** MinimumSize()

     * 

     * Determines size of the listbox for use in dialogs.

     */

    IMPORT_C TSize MinimumSize();

    /**

     * From CCoeControl.     

     * Handles pointer events

     */

    IMPORT_C void HandlePointerEventL(const TPointerEvent& aPointerEvent); 

private:

    void SizeChangedL();

    };

/**

 * list_single_Graphic_heading_pane

 *

 * list item string format: "0\tHeading\tTextLabel\t1\t2"

 * where 0,1,2 are index to the icon array 

 */

class CAknSingleGraphicHeadingStyleListBox : public CEikColumnListBoxTypedef

    {

public:

    IMPORT_C CAknSingleGraphicHeadingStyleListBox();

    /** SizeChanged()

     * 

     * Determines layout of the listbox

     */

    IMPORT_C void SizeChanged();

    /** MinimumSize()

     * 

     * Determines size of the listbox for use in dialogs.

     */

    IMPORT_C TSize MinimumSize();

    /**

     * From CCoeControl.     

     * Handles pointer events

     */

    IMPORT_C void HandlePointerEventL(const TPointerEvent& aPointerEvent);    

protected:

    IMPORT_C virtual void CreateItemDrawerL();

   /** MakeViewClassInstanceL()

    *

    * Chooses which listbox view class to use

    */

    IMPORT_C virtual CListBoxView* MakeViewClassInstanceL();

private:

    void SizeChangedL();

    };

/**

 * list_single_number_heading_pane

 *

 * list item string format: "1\tHeading\tTextLabel\t2\t3"

 * where 2 and 3 are indexes to icon array

 */

class CAknSingleNumberHeadingStyleListBox : public CEikColumnListBoxTypedef

    {

public:

    IMPORT_C CAknSingleNumberHeadingStyleListBox();

    /** SizeChanged()

     * 

     * Determines layout of the listbox

     */

    IMPORT_C void SizeChanged();

    /** MinimumSize()

     * 

     * Determines size of the listbox for use in dialogs.

     */

    IMPORT_C TSize MinimumSize();

    /**

     * From CCoeControl.     

     * Handles pointer events

     */

    IMPORT_C void HandlePointerEventL(const TPointerEvent& aPointerEvent); 

protected:

    IMPORT_C virtual void CreateItemDrawerL();

   /** MakeViewClassInstanceL()

    *

    * Chooses which listbox view class to use

    */

    IMPORT_C virtual CListBoxView* MakeViewClassInstanceL();

private:

    void SizeChangedL();

    };

/**

 * list_single_large_pane

 *

 * list item string format: "1\tTextLabel\t0\t0"

 * where 0 is an index to icon array

 */

class CAknSingleLargeStyleListBox : public CEikColumnListBoxTypedef

    {

public:

    IMPORT_C CAknSingleLargeStyleListBox();

    /** SizeChanged()

     * 

     * Determines layout of the listbox

     */

    IMPORT_C void SizeChanged();

    /** MinimumSize()

     * 

     * Determines size of the listbox for use in dialogs.

     */

    IMPORT_C TSize MinimumSize();

    /**

     * From CCoeControl.     

     * Handles pointer events

     */

    IMPORT_C void HandlePointerEventL(const TPointerEvent& aPointerEvent);   

private:

    void SizeChangedL();

    };

/**

 * list_double_pane and list_big_single_pane

 *

 * list item string format: " \tFirstLabel\tSecondLabel\t0\t0"

 * where 0 is an index to icon array

 */

class CAknDoubleStyleListBox : public CEikFormattedCellListBoxTypedef

    {

public:

    IMPORT_C CAknDoubleStyleListBox();

    /** SizeChanged()

     * 

     * Determines layout of the listbox

     */

    IMPORT_C void SizeChanged();

    /** MinimumSize()

     * 

     * Determines size of the listbox for use in dialogs.

     */

    IMPORT_C TSize MinimumSize();

    /**

     * From CCoeControl.     

     * Handles pointer events

     */

    IMPORT_C void HandlePointerEventL(const TPointerEvent& aPointerEvent); 

private:

    void SizeChangedL();

    };

/**

 * list_twoline_pane

 *

 * list item string format: " \tFirstLongLabel\t\t0"

 * where 0 is an index to icon array

 */

class CAknDoubleStyle2ListBox : public CAknDoubleStyleListBox

    {

public:

    /** SizeChanged()