/*

* 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:  A utility that provides services to both the Speeddial and

*                PhoneBook applications for getting and setting speeddial

*                number configuration.

*

*/

#ifndef SPDIACONTROL_H

#define SPDIACONTROL_H

// INCLUDES

#include <coecntrl.h>

#include <TPbkContactItemField.h>

#include <MPbkContactDbObserver.h>

#include <MPbkThumbnailOperationObservers.h>

// FORWARD DECLARATIONS

class CAknGrid;

class CGulIcon;

class CEikonEnv;

class TSpdiaIndexData;

class CPbkContactEngine;

class RPbkViewResourceFile;

class CEikStatusPane;

class CPAlbImageData;

class CSpdiaGridDlg;

class CPbkContactChangeNotifier;

class CPbkSingleItemFetchDlg;

class CAknQueryDialog;

class CPAlbImageFactory;

class CPbkThumbnailManager;

class CAknsBasicBackgroundControlContext;

#include <AknsConstants.h>

// CLASS DECLARATION

/**

*  A utility that provides services to both the Speeddial and PhoneBook

*  applications for getting and setting speeddial number configuration.

*

*  @lib SpdCtrl.DLL

*  @deprecated

*  @since

*/

// one line code added for build ver 2.6

const TInt KArraySize =9; 

class CSpdiaControl    : public CCoeControl,

                         public MPbkContactDbObserver,

                         private MPbkThumbnailGetObserver

    {

    public:     // SpdiaControl APIs

        /**

        * Creates a new instace of this class.

        */

        IMPORT_C static CSpdiaControl* NewL();

        /**

        * Creates a new instace of this class.

        *

        * @param aPbkEngine     reference of CPbkContactEngine.

        */

        IMPORT_C static CSpdiaControl* NewL(

                                CPbkContactEngine& aPbkEngine);

        /**

        * Puts a query on the screen asking for '...Assign it now'.

        * When the user goes through, it will assign speed dial.

        *

        * @param aLocation      a location to assign speed dial.

        * @param aStatusPane    not used.

        * @reutn    ETrue if success.

        */

        IMPORT_C TBool AssignDialNumberL(TInt aLocation,

                            CEikStatusPane* aStatusPane = NULL);

        /**

        * Runs the Speed Dial Selection Grid Dialog.

        * If accepted sets speed dial key to aItem's aFieldId.

        * Note: Calls CPbkContactEngine::SetFieldAsSpeedDialL().

        *       If necessary, calls CPbkContactEngine::RemoveSpeedDialFieldL().

        *

        * @param aId        a contact item id. (Don't open)

        * @param aFieldId   index to aItems field set.

        * @return   nonzero if accepted, zero if canceled.

        */

        IMPORT_C TInt ExecuteLD(TContactItemId aId, TInt aFieldIdx);

        /**

        * Cancels and dismisses this dialog. In other words makes

        * ExecuteLD return just like cancel was pressed.

        * Used when user switches a application and all modal

        * dialogs are closed.

        */

        IMPORT_C void Cancel();

        /**

        * The assigned number of the location is obtained.

        * Note: Voice mail number will be returned if the location

        *       is the position of Voice mail.

        * Note: If the location is empty, required dialog

        *       will be displayed and a location will be assigned.

        *

        * @param aLocation      a location of speed dial.

        * @param aPhonenumber   reference of phonenumber.

        * @param aStatusPane    not used.

        * @return   EFalse if user cancel or failed.

        */

        IMPORT_C TBool DialNumberL(TInt aLocation, TDes& aPhoneNumber,

                            CEikStatusPane* aStatusPane = NULL);

    private:  // Constructors

        /**

        * C++ default constructor.

        */

        CSpdiaControl();

        /**

        * C++ constructor.

        */

        CSpdiaControl(CPbkContactEngine* aPbkEngine);

        /**

        * Gets actual size of thumbnial to be drawn.

        * @return  size of thumbnail.

        */

        TSize GetThumbnailSize();

    public:  // Destructor

        /**

        * Destructor.

        */

        IMPORT_C virtual ~CSpdiaControl();

    public:     // New function

        /**

        * The number of voice mail returned, if voice mail is assigned.

        * Note: If the location is empty, required dialog

        * will be displayed and voice mail will be defined.

        *

        * @param aNumber    reference of phone number.

        * @retunr   EFalse if user cancel or failed.

        */

        IMPORT_C TBool VoiceMailL(TDes& aNumber);

        /**

        * Returns the owned Phone Book Engine.

        */

        IMPORT_C CPbkContactEngine* PbkEngine() const;

        /**

        * The value converted into the index of an array from

        * the location of speeddial is returned.

        *

        * @param aDial      a location of speed dial.

        * @return   the index of a speeddial index data, if not found -1

        */

        IMPORT_C TInt Index(TInt aDial) const;

        /**

        * The value converted into the the location of speeddial

        * from index of an array is returned.

        *

        * @param aIndex     a index of array.

        * @return   location of speed dial(1-9), if not found -1

        */

        IMPORT_C TInt Number(TInt aIndex) const;

        /**

        * Returns the phone book contact item's id.

        *

        * @param aIndex     a index of array.

        * @return   a contact item's id, if not found -1

        */

        IMPORT_C TContactItemId ContactId(TInt aIndex) const;

        /**

        * Returns the phone number of a speed dial contact.

        * Note: A character invalid as a phone number is removed.

        *

        * @param aDial      a location of speeddial.

        * @return   phone number

        */

        IMPORT_C const TDesC& PhoneDialNumber(TInt aDial) const;

        /**

        * Returns the phone number of a speed dial contact.

        * Note: left and right spaces are removed.

        *

        * @param aIndex     a index of array.

        */

        IMPORT_C const TDesC& PhoneNumber(TInt aIndex) const;

    public:   // SpeedDial internal API

        /**

        * Gets a title text from contact item's id.

        * Note:  calls CPbkContactItem::GetContactTitleOrNullL()

        *              or CPbkContactEngine::UnnamedTitle()

        *

        * @param aCid       contact item's id

        * @param aUnnamed   if title is empty, unname or NULL.

        * @return   a buffer containing the title. An unnametitle will

        *           be set if a title is empty.

        */

        IMPORT_C HBufC* ContactTitleL(TContactItemId aCid, TBool aUnnamed);

        /**

        * Returns the icon index of a grid array.

        *

        * @param aIndex     a index of array.

        */

        IMPORT_C TInt IconIndex(TInt aIndex) const;

        /**

        * Returns the thumbnail index of a grid array.

        *

        * @param aIndex     a index of array.

        */

        IMPORT_C TInt ThumbIndex(TInt aIndex) const;

        /**

        * Returns the array of icons

        */

        IMPORT_C CArrayPtr<CGulIcon>* IconArray() const;

        /**

        * Icons, thumbnails and text array for the grid are created.

        * Note: If a aIndex parameter is set, only the data of the value

        *       will be set up.

        * Note: CreateDataL() is used if App to be used is except SD.

        *

        * @param aGrid      the grid to set up

        * @param aIndex     (TInt) if <-1, All values are set up.

        */

        IMPORT_C TBool CreateGridDataL(CAknGrid* aGrid, TBool aIndex);

        /**

        * Assigns the index data at the index in the phone book's contact entry.

        *

        * @param aIndex     a index of array.

        */

        IMPORT_C TBool AssignDialIndexL(TInt aIndex);

        /**

        * Removes a speed dial from the phone book's contact entry.

        *

        * @param aIndex         a index of array.

        * @param aConfirmation  when remove, confirm is displayed.

        * @reutn    ETrue if success

        */

        IMPORT_C TBool RemoveDialIndexL(TInt aIndex,

                            TBool aConfirmation = ETrue);

        /**

        * deprecated - do not use

        */

        IMPORT_C TBool AssignNumberL(TInt aIndex,

                            CEikStatusPane* aStatusPane,

                            CCoeControl* aContainer,

                            TBool aConfirmation);

        IMPORT_C void ApplyCellSpdiaPaneStyleL(CAknGrid& aListBox, TSize& aSize);

        IMPORT_C void DrawShadow(CWindowGc& aGc, const TSize& aSize);

        /**

        * The position which a shadow draws is set up.

        *

        * @param aRect

        */

        IMPORT_C void SetLayout(const TRect& aRect);

        /**

        * deprecated - do not use

        */

        IMPORT_C TInt Size() const;

        /**

        * Returns the position of voice mail box

        */

        IMPORT_C TInt VMBoxPosition() const;

        /**

        * Returns the icon index of grid array.

        */

        IMPORT_C TInt SpdIconIndex(TInt aIndex) const;

        /**

        * Returns type of the phone number.

        */

        IMPORT_C TInt NumberType(TInt aIndex) const;

		/**

        * Build ver 2.6 . Deletes the old icon array.

        */

		IMPORT_C void DeleteIconArray();

		/**

        * Build ver 2.6 .  Reloads the new skin icons

        */

		IMPORT_C void ReloadIconArray();

		IMPORT_C TInt VoiceMailType();

		/**

        * Returns last error.

        */

		IMPORT_C TInt GetSpdCtrlLastError();

		/**

        * Internal rutine to check if pop up has to be shown

        * to enable the One-Key-Dialling setting.

        * @return   bool value of one key calling status on or off.

        */

       IMPORT_C  TBool CheckingIfPopUpNeeded();

	private:

		/**

        * Internal rutine to check if pop up has to be shown

        * to enable the One-Key-Dialling setting.

        * @return   bool value of one key calling status on or off.

        */

		TBool CheckingIfPopUpNeededL();

		/**

        * Build ver 2.6 .  Reloads the new skin icons

        */

		 void ReloadIconArrayL();

    public:

        /**

        * Creates a grid itemArray.

        * Note: It calls, when using a grid except SDM.

        *

        * @param aGrid      the grid to set up

        * @param aUpdate    updates in an event.

        */

        TBool CreateDataL(const CAknGrid& aGrid);

        /**

        * Thumbnail's shadow is drawn.

        *

        * @param aGc    window gc

        */

        void DrawShadow(CWindowGc& aGc) const;

    private:    // Functions from base classes

        // from MpblThumbnailOperation

        /**

        * Called when thumbnail loading is completed.

        *

        * @param aOperation    the completed operation.

        * @param aBitmap       The loaded bitmap. Callee is responsible of

        *                      the bitmap.

        */

        void PbkThumbnailGetComplete(MPbkThumbnailOperation& aOperation,

                                     CFbsBitmap* aBitmap);

        /**

        * Called if the thumbnail loading fails.

        *

        * @param aOperation     the failed operation.

        * @param aError         error code of the failure.

        */

        void PbkThumbnailGetFailed

            (MPbkThumbnailOperation& aOperation, TInt aError);

        /**

        * Passes skin information when needed.

        **/

        TTypeUid::Ptr MopSupplyObject(TTypeUid aId);

    private:

        /**

        * Called when thumbnail loading is completed.

        *

        * @param aOperation    the completed operation.

        * @param aBitmap       The loaded bitmap. Callee is responsible of

        *                      the bitmap.

        */

    	 void PbkThumbnailGetCompleteL(MPbkThumbnailOperation& aOperation,

                                     CFbsBitmap* aBitmap);

    private:  // from CCoeControl

        /**

         * Draw this control

         */

        void Draw(const TRect& aRect) const;

        /**

         * Set size for the skin background context.

         */

        void SizeChanged();

    private:

        /**

        * From MContactDbObserver, Handles an event of type aEventType.

        */

        void HandleDatabaseEventL(TContactDbObserverEvent aEvent);

    private:    // functions

        /**

        * Constructor

        */

        void ConstructL();

        /**

        * Index data are initialized.

        */

        void InitIndexDataL();

        /**

        * Updates data set to match index of the owned index data array.

        */

        TBool UpdateIndexDataL(TInt aIndex);

        /**

        * Searches icon of grid array for a match.

        *

        * @param aId     phone book icon id to match to.

        * @return   the matching index, -1 if not found.

        */

        TInt FindIconIndex(TInt aId) const;

        /**

        * Returns the thumbnail type.

        *

        * @param aIndex     a index of array.

        */

        TInt ThumbType(TInt aIndex) const;

        /**

        * Returns the thumbnail size.

        *

        * @param aIndex     a index of array.

        */

        TSize ThumbSize(TInt aIndex) const;

        /**

        * Set phonebook contact itmes'id.

        *

        * @param aIndex     a index of array.

        * @param aCid       phone book contact item's id.

        */

        void SetContactId(TInt aIndex, TContactItemId aCid);  // not referenced...

        /**

        * The position on the array that a grid uses from

        * an item and a phone number is returned.

        *

        * @param aItem      contacd item

        * @param aDial      phone number

        */

        TInt IconPositionL(const CPbkContactItem& aItem, TInt aDial, TInt& aFieldId);

        /**

        * An icon array is created and set.

        *

        * @retunr   if need loadthumbL ETrue

        */

        TInt SetIconArrayL(CArrayPtrFlat<CGulIcon>* aArray);

        /**

        * Gets Item's descriptor for Grid.

        *

        * @param aIndex     a index of array.

        * @param aSdmData   reference to the data currently used.

        * @return   a buffer containing the descriptor text.

        */

        HBufC* ItemDescriptorLC(TInt aIndex, const TSpdiaIndexData& aSdmData);

        /**

        * Creates Item's descriptor for Grid.

        *

        * @param aSdmData   reference to the data currently used.

        * @returen  a buffer containing the descriptor text.

        */

        HBufC* CreateItemDescriptorLC(const TSpdiaIndexData& aSdmData);

        /**

        * A descriptor is added to a text.

        *

        * @param aSdmData   reference to the data currently used.

        * @param aText      the text for storing

        */

        void AppendTextL(const TSpdiaIndexData& aSdmData, TPtr& aText);

        /**

        * Searches contact item's fiels of this contact for a match.

        *

        * @param aItem      contact item to search.

        * @param aFieldId   field id to search.

        * @return   first field matching aFieldId, NULL if none found.

        */

        TPbkContactItemField* FindFieldL(CPbkContactItem& aItem,

                                    TPbkFieldId aFieldId);

        /**

        * The descriptor for thumbnail is added.

        *

        * @param aSdmData           reference to the data currently used.

        * @param aText

        * @param aFixedLocation

        */

        void AppendThumbnail(const TSpdiaIndexData& aSdmData,

                            TPtr& aText,

                            TBool aFixedLocation);

        /**

        * Returns the type from a size of thumbnail.

        *

        * @param aSize  a thumbnail size

        */

        TInt ConvThumbType(const TSize& aSize) const;

        /**

        * Operations to a CPbkThumbnailManager are set.