/*!
* 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:  Handles phone ui commands.
*
*/

#ifndef PHONEUICOMMANDCONTROLLER_H
#define PHONEUICOMMANDCONTROLLER_H

#include <QObject>
#include <QString>
#include <hbmenu.h>
#include <spdefinitions.h>
#include "phonecommandextensionwrapper.h"
#include "phoneuiqtviewif.h"

// FORWARD DECLARATION
class HbAction;

class PhoneUiCommandController : public QObject
{
    Q_OBJECT
    
public:

    /*!
        \fn PhoneUiCommandController(
            PhoneUIQtViewIF &m_view, QObject *parent)
    */
    PhoneUiCommandController(PhoneUIQtViewIF &view, QObject *parent = 0);
        
    /*!
        Destructor
     */
    virtual ~PhoneUiCommandController();
    
    /*!
        \fn void showGlobalNote()
        
        Sets call menu actions.

    */
    void setCallMenuActions(QMap<int,int> callStates,
                            QMap<int,int> serviceIds,
                            int serviceId,
                            int expandedCallId);

    /*!
        \fn void setDialpadMenuActions ()
        
        Sets dialpad menu actions.

    */
    void setDialpadMenuActions();
    
    /*!
        \fn void pushButtonActionsForCall ()
        
        Returns push button actions for call.

    */
    QList<HbAction *> pushButtonActionsForCall( 
            int callState,
            bool emergencyCall,
            QMap<int,int> callStates,
            QMap<int,int> serviceIds,
            int serviceId,
            int callId);
    
    /*!
        \fn void toolBarActions ()
        
        Returns tool bar actions for call.

    */
    QList<HbAction *> toolBarActions( 
            int resourceId,
            QMap<int,int> callStates,
            QMap<int,int> serviceIds,
            int serviceId,
            int callId);
    
private:

    /*!
        \fn QList<int> menuCommands()
        
        Returns list of current menu commands.

    */
    QList<int> menuCommands(
            QMap<int,int> callStates, QMap<int,int> serviceIds) const;
    
    /*!
        \fn void addMenuItems()
        
        Adds menu commands to menu.
    */
    void addMenuItems(QList<int> menuCmdList);
    
    /*!
        \fn int mapCommand()
        
        Maps ui command extension commands to
        phone app commands.
    */
    int mapCommand(int extensionCommand) const;
    
    /*!
        \fn void commandExtension()
        
        Returns command extension by service id (null if
        extension not available).
    */
    PhoneCommandExtensionWrapper *commandExtension(int serviceId);

    /*!
        \fn void ResolveImplementationUidL()
        
        Returns service's plugin uid by service id.
    */
    TUid ResolveImplementationUidL( 
            TUint32 aServiceId, TServicePropertyName aPropertyName ) const;
    
    /*!
        \fn void MenuExtensionL()
        
        Returns command extension by service id (null if
        extension not available).
    */
    PhoneCommandExtensionWrapper *CommandExtensionL( TUint aServiceId );
    
    /*!
        \fn void releaseMenu()
        
        Releases extensions menu.
    */
    void releaseMenu();
       
    /*!
        \fn void areServicesSame()
        
        Checks are all calls made by same service (id).
        Returns true when same service used.
    */
    bool areServicesSame(QMap<int,int> callStates, QMap<int,int> serviceIds) const;

    /*!
        \fn void setJoinFlag()
        
        Sets conference join button flag.
    */
    void setJoinFlag(QMap<int,int> callStates, QMap<int,int> serviceIds) const;
 
    /*!
        \fn void setHoldFlag()
        
        Sets hold button flag.
    */
    void setHoldFlag(int callState) const;
 
    /*!
        \fn void setOutgoingFlag()
        
        Sets outgoing call button flag.
    */
    void setOutgoingFlag(QList<int> callStates) const;
    
    /*!
        \fn void setConferenceFlag()
        
        Sets conference call button flag. (Flag will be true when call 
        state list contains held/active conference).
    */
    void setConferenceFlag(QList<int> callStates) const;
    
    /*!
        \fn void setMulticallFlag()
        
        Sets multi call button flag. (Flag will be set as true when active
        and held calls exists).
    */
    void setMultiCallFlag(QList<int> callStates) const;

    /*!
        \fn void buttonCommandList()
        
        Returns push button command list.
    */    
    QList<int> buttonCommandList(int callState,
                                 bool emergencyCall,
                                 QList<int> callStates) const;
    
    /*!
        \fn HbAction *createAction(int extensionCommand, bool enabled)
        
        Converts given extension command id to HbAction.
        
        Returns action.
     */
    HbAction *createAction(int extensionCommand, bool enabled = true) const;
    
    /*!
        \fn void emergencyCall()
        
        Checks is an emergency call ongoing.
    */    
    bool emergencyCall(QMap<int,int> callStates) const;
    
private:

    PhoneUIQtViewIF &m_view;
    QList<HbAction *> m_customMenuActions;
    QList<PhoneCommandExtensionWrapper *> m_commandExtensions;
    PhoneCommandExtensionWrapper *m_lastCommandExtension;
    
};

#endif // PHONEUICOMMANDCONTROLLER_H