/*  Copyright (c) 2005, Nokia. All rights reserved */

#ifndef __AKNEXLISTFORMCONTAINER_H__
#define __AKNEXLISTFORMCONTAINER_H__

// INCLUDES
#include "AknExListBaseContainer.h"

// CONSTANTS
const TInt KAknExListInitCount = 0; // for initialization.

// FORWARD DECLARATIONS
class CEikFormattedCellListBox;
class CAknSearchField;
class CAknExListFormView;

// CLASS DECLARATION

/**
* CAknExListFormContainer  container control class.
*/
class CAknExListFormContainer : public CAknExListBaseContainer
    {

    private: // Enumerations

        enum TAknExListComponentControls
            {
            EAknExListComponentListBox,
            EAknExListComponentFindBox
            };

    public: // Constructors and destructor

        /**
        * CAknExListFormContainer
        * Copy constructor.
        * @param aView Pointer of CAknExListFormView class.
        */
        CAknExListFormContainer( CAknExListFormView* aView );

        /**
        * ConstructL
        * Symbian constructor.
        * @param aRect Frame rectangle for container.
        */
        void ConstructL( const TRect& aRect );

        /**
        * ~CAknExListFormContainer
        * Destructor.
        */
        virtual ~CAknExListFormContainer();

    public: // New functions

        /**
        * DisplayListBoxL
        * Displays the listbox by outline ID.
        * @param aOutlineId The ID of outline to displayed next.
        */
        void DisplayListBoxL( const TInt aOutlineId );

    public: // Functions from base classes

        /**
        * From CoeControl, OfferKeyEventL.
        * Handles the key-events.
        * @return If key-event is consumed, EKeyWasConsumed. Else
        * EKeyWasNotConsumed.
        * @param aKeyEvent Key event.
        * @param aType Type of key event( EEventKey, EEventKeyUp or
        * EEventKeyDown ).
        */
        TKeyResponse OfferKeyEventL( 
            const TKeyEvent& aKeyEvent,
            TEventCode aType );

    private: // New functions

        /**
        * SetCountAndAddItemL
        * Sets count of added list items and calls AddItemL().
        * @param aKeyEvent Key event.
        */
        void SetCountAndAddItemL( const TKeyEvent& aKeyEvent );

        /**
        * SetCountAndRemoveItemL
        * Sets count of removed list items and calls RemoveItemL().
        * @param aKeyEvent Key event.
        */
        void SetCountAndRemoveItemL( const TKeyEvent& aKeyEvent );

    private: // From CAknExListBaseContainer

        /**
        * GraphicIconL
        * Appends graphics data.
        * @param Pointer of icon using graphics for listbox.
        */
        void GraphicIconL( CArrayPtr<CGulIcon>* aIcons );

    private: // From CoeControl

        /**
        * From CoeControl, SizeChanged.
        * Called by framework when the view size is changed.
        */
        void SizeChanged();

        /**
        * From CoeControl, CountComponentControls.
        * Returns number of components.
        * @return Number of controls.
        */
        TInt CountComponentControls() const;

        /**
        * From CCoeControl, ComponentControl.
        * Returns pointer to particular component.
        * @return Pointer to Control's component control, identified by index.
        * @param aIndex Index of the control.
        */
        CCoeControl* ComponentControl( TInt aIndex ) const;
        
        /**
        * From CoeControl, HandleResourceChange.
        * Called by framework when the view layout is changed.
        */
        virtual void HandleResourceChange(TInt aType);        

    private: // Data

        /**
        * iListBox
        * Owned by CAknExListFormContainer object.
        */
        CEikFormattedCellListBox* iListBox;

        /**
        * iView
        * Does not own.
        */
        CAknExListFormView* iView;

        /**
        * iFindBox
        * Owned by CAknExListFormContainer object.
        */
        CAknSearchField* iFindBox;

        /**
        * iOutlineId
        */
        TInt iOutlineId;

    };

#endif // __AKNEXLISTFORMCONTAINER_H__

// End of File