phoneengine/phonemodel/inc/cpephonemodelif.h
changeset 0 5f000ab63145
equal deleted inserted replaced
-1:000000000000 0:5f000ab63145
       
     1 /*
       
     2 * Copyright (c) 2006-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:  Interface class of PhoneEngineGsm
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef C_CPEPHONEMODELIF_H
       
    20 #define C_CPEPHONEMODELIF_H
       
    21 
       
    22 #include <e32base.h>
       
    23 #include <pevirtualengine.h>
       
    24 #include <mpeengineinfo.h>
       
    25 
       
    26 class MEngineMonitor;
       
    27 class CPEAudioFactory;
       
    28 
       
    29 /**
       
    30  * Offers message interface from phone application GSM to phone engine GSM.
       
    31  *
       
    32  *  @lib phoneenginegsm
       
    33  *  @since S60 v.4.0
       
    34  */
       
    35 NONSHARABLE_CLASS( CPEPhoneModelIF ) : public CBase,
       
    36                            public MPEPhoneModel
       
    37     {
       
    38 
       
    39 public:
       
    40 
       
    41     typedef TInt TPEMessagesToPhoneEngineGsm;
       
    42 
       
    43     enum
       
    44         {
       
    45         // Audio messages                         11000 - 11199
       
    46 
       
    47         // Call messages                          11200 - 11399
       
    48         EPEMessageAddConferenceMember           = KPEMessagesToPhoneEngineGsmFirst + 200,
       
    49         EPEMessageCreateConference,
       
    50         EPEMessageDropConferenceMember,
       
    51         EPEMessageGoOneToOne,
       
    52         EPEMessageHangUpConference,
       
    53         EPEMessageHold,
       
    54         EPEMessageHoldConference,
       
    55         EPEMessageResume,
       
    56         EPEMessageResumeConference,
       
    57         EPEMessageSwap,
       
    58         EPEMessageSwapConference,
       
    59         EPEMessageTransfer,
       
    60                 
       
    61         // Contact messages                       11400 - 11599
       
    62 
       
    63         // Error messages                         11600 - 11799
       
    64 
       
    65         // Network messages                       11800 - 12999
       
    66 
       
    67         // Parser messages                        12000 - 12199
       
    68         EPEMessageCancelSSstringCommand         = KPEMessagesToPhoneEngineGsmFirst + 1000, // Start last SS string command canceling
       
    69 
       
    70         // Security messages                      12200 - 12399
       
    71 
       
    72         // Settings messages                      12400 - 12599
       
    73         EPEMessageSetALSLine                    = KPEMessagesToPhoneEngineGsmFirst + 1400,
       
    74         // Miscellaneous messages                 12600 - 12799
       
    75 
       
    76         // Last                                   12999
       
    77         // Exposing this allows the compiler to detect the overlapping enumerations.
       
    78         EPEMessageLastVariantItem               = KPEMessagesToPhoneEngineGsmLast
       
    79         };
       
    80 
       
    81      ~CPEPhoneModelIF();
       
    82 
       
    83     /**
       
    84      * Initiates Phone Engine construction
       
    85      *
       
    86      * @since S60 v.4.0
       
    87      * The construction of Phone Application Engine is an asynchronous operation.
       
    88      * The Engine Monitor observer will be notified using the message interface when
       
    89      * the operation completes:
       
    90      *      message EPEMessagePEConstructionReady signifies a successful procedure
       
    91      *      message EPEMessagePEConstructionFailed signifies a failed procedure
       
    92      *
       
    93      * @param aEngineMonitor reference to Engine Monitor instance
       
    94      * @return pointer to protocol specific phone model object
       
    95      */
       
    96      IMPORT_C static CPEPhoneModelIF* CreateL( MEngineMonitor& aEngineMonitor );
       
    97      
       
    98      /**
       
    99       * Initiates Phone Engine construction for Module testing
       
   100       *
       
   101       * @since S60 v.4.0
       
   102       * The construction of Phone Application Engine is an asynchronous operation.
       
   103       * The Engine Monitor observer will be notified using the message interface when
       
   104       * the operation completes:
       
   105       *      message EPEMessagePEConstructionReady signifies a successful procedure
       
   106       *      message EPEMessagePEConstructionFailed signifies a failed procedure
       
   107       *
       
   108       * @param aEngineMonitor reference to Engine Monitor instance
       
   109       * @param aAudioFactory Factory to create audio related classes.
       
   110       * @return pointer to protocol specific phone model object
       
   111       */
       
   112       IMPORT_C static CPEPhoneModelIF* CreateL( 
       
   113           MEngineMonitor& aEngineMonitor,
       
   114           CPEAudioFactory& aAudioFactory );
       
   115      
       
   116 protected:
       
   117     
       
   118     CPEPhoneModelIF();
       
   119           
       
   120 
       
   121     };
       
   122           
       
   123 #endif // C_CPEPHONEMODELIF_H