phoneapp/phoneuivoipextension/inc/cphonestatemachinevoip.h
changeset 0 5f000ab63145
equal deleted inserted replaced
-1:000000000000 0:5f000ab63145
       
     1 /*
       
     2 * Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies). 
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description: 
       
    15 *       The class implements a VoIP-specific state machine
       
    16 *
       
    17 */
       
    18 
       
    19 
       
    20 #ifndef CPHONESTATEMACHINEVOIP_H
       
    21 #define CPHONESTATEMACHINEVOIP_H
       
    22 
       
    23 //  INCLUDES
       
    24 #include "cphonestatemachinegsm.h"
       
    25 
       
    26 // FORWARD DECLARATIONS
       
    27 class CPhoneCustomizationVoip;
       
    28 class CPhoneVoIPErrorMessagesHandler;
       
    29 class CPhoneStateUtilsVoip;
       
    30 
       
    31 // CLASS DECLARATION
       
    32 
       
    33 /**
       
    34  *  The class implements a VoIP-specific state machine.
       
    35  */
       
    36 NONSHARABLE_CLASS( CPhoneStateMachineVoIP ): public CPhoneStateMachineGSM
       
    37     {
       
    38     public:
       
    39 
       
    40         /**
       
    41          * Destructor.
       
    42          */
       
    43         virtual ~CPhoneStateMachineVoIP();
       
    44 
       
    45         /**
       
    46          * Creates the only instance of state machine class.
       
    47          * @param   aViewCommandHandle  A handle to the Phone UI view.
       
    48          * @return  An instance of class CPhoneStateMachine.
       
    49          */
       
    50         static CPhoneStateMachineVoIP* NewL(
       
    51             MPhoneViewCommandHandle* aViewCommandHandle );
       
    52 
       
    53         /**
       
    54          * Returns active state.
       
    55          */
       
    56         MPhoneState* State();
       
    57 
       
    58         /**
       
    59          * Sets voip error message handler.
       
    60          * @param   aErrorHandler   Voip error message handler.
       
    61          */
       
    62         void SetVoipErrorMessageHandler(
       
    63             CPhoneVoIPErrorMessagesHandler& aErrorHandler );
       
    64 
       
    65         /**
       
    66          * Returns error message handler instance.
       
    67          * @return  Voip error message handler.
       
    68          */
       
    69         CPhoneVoIPErrorMessagesHandler& VoipErrorMessageHandler() const;
       
    70         
       
    71         /**
       
    72          * Returns utility class for voip states.
       
    73          * @return  Voip state utils.
       
    74          */
       
    75         CPhoneStateUtilsVoip& StateUtils();
       
    76 
       
    77     private:
       
    78 
       
    79         /**
       
    80          * By default EPOC constructor is private.
       
    81          */
       
    82         CPhoneStateMachineVoIP(
       
    83             MPhoneViewCommandHandle* aViewCommandHandle );
       
    84 
       
    85         /**
       
    86          * ConstructL()
       
    87          */
       
    88         void ConstructL();
       
    89 
       
    90     private: // Data
       
    91 
       
    92         /**
       
    93          * Voip customization.
       
    94          * Own.
       
    95          */
       
    96         CPhoneCustomizationVoip* iVoipCustomization;
       
    97 
       
    98         /**
       
    99          * Voip error message handler.
       
   100          * Now own.
       
   101          */
       
   102         CPhoneVoIPErrorMessagesHandler* iVoipErrorMessageHandler;
       
   103         
       
   104         /**
       
   105          * Voip state utils.
       
   106          * Own.
       
   107          */
       
   108         CPhoneStateUtilsVoip* iStateUtils;
       
   109 
       
   110     };
       
   111 
       
   112 #endif      // CPHONESTATEMACHINEVOIP_H
       
   113 
       
   114 // End of File