1 /*

     2 * Copyright (c) 2002 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:  Base class for all command parameter classes.

    15 *

    16 */

    17 

    18 #ifndef TPHONECOMMANDPARAM_H

    19 #define TPHONECOMMANDPARAM_H

    20 

    21 //  INCLUDES

    22 #include <e32std.h>

    23 

    24 // FORWARD DECLARATIONS

    25 class TPhoneCommandParam;

    26 

    27 // DATA TYPES

    28 typedef TPhoneCommandParam TPhoneUICommandParam;

    29 typedef TPhoneCommandParam TPhoneEngineCommandParam;

    30 

    31 // CLASS DECLARATION

    32 

    33 /**

    34 *  A base class for command parameter.

    35 *  

    36 */

    37 class TPhoneCommandParam

    38     {

    39     public: // enum

    40 

    41     /** TPhoneParamId is list of possible phone ui command parameters */

    42     enum TPhoneParamId

    43         {

    44         EPAParamIdCallId = 200,

    45         EPAParamIdKeyCode,

    46         EPAParamIdDtmfString,

    47         EPAParamIdPhoneNumber,

    48         EPAParamIdAudioIHFMode,

    49         EPAUIParamIdMOTerminationIndicator,

    50         EPAUIParamIdMOSettingsIndication,

    51         EPAUIParamCallControlState,

    52         EPAUIParamIdMenuBar,

    53         EPAUIParamIdChangeMenuBar,

    54         EPAUIParamIdChangeToolBar,

    55         EPAUIParamIdRemoteInfo,

    56         EPAUIParamIdInformationBanner,

    57         EPAUIParamIdCallStatusIndicator,    

    58         EPAUIParamIdTerminationNote,

    59         EPAUIParamIdViewId,

    60         EPAUIParamIdKeyEvent,

    61         EPAUIParamIdServiceReqResult,

    62         EPAUIParamIdToolBar,

    63         EPAUIParamIdEmergencyPhase,

    64         EPAUIParamIdKeyCapture,    

    65         EPAUIParamIdHscsd,

    66         EPAUIParamIdUid,        

    67         EPAUIParamAppInfo,

    68         EPAUIParamIdSoftkeyName,

    69         EPAUIParamIdGlobalIndicator, // for displaying global note

    70         EPAUIParamIdCallGuard,

    71         EPAUIParamIdSpeedDial,

    72 

    73     // ----- USED TYPES ---------

    74         EPhoneParamIdInteger,

    75         EPhoneParamIdMenu,

    76         EPhoneParamIdBoolean,

    77         EPhoneParamIdKeyEvent,

    78         EPhoneParamIdKeyCapture,

    79         EPhoneParamIdString,

    80         EPhoneParamIdNote,

    81         EPhoneParamIdGlobalNote,

    82         EPhoneParamIdCallHeaderData,

    83         EPhoneParamIdEmergencyCallHeaderData,

    84         EPhoneParamIdIncallIndicatorData,

    85         EPhoneParamIdAppInfo,

    86         EPhoneParamIdQuery,

    87         EPhoneParamIdMessageEditor,

    88         EPhoneParamIdCallStateData,

    89         EPhoneParamIdSingleItemFetch,

    90         EPhoneParamIdBitmap,

    91         EPhoneParamIdSfiData,

    92         EPhoneParamIdProgressNote,

    93         EPhoneParamIdAudioOutput,

    94         EPhoneParamIdAudioAvailable,

    95         EPhoneParamIdRingTone,

    96         EPhoneParamIdSpeedDial,

    97         EPhoneParamIdReconnectQuery,

    98         EPhoneParamIdVideoCallSetupFailedCreateVoiceCallToTheSameContactQuery,

    99         EPhoneParamRebootQuery,

   100         EPhoneParamIdUnattendedTransferAcceptanceQuery,

   101         EPhoneParamIdCustomDialer,

   102         EPhoneParamIdGlobalWaitNote,

   103         EPhoneNumberEntryObserver,

   104         EPhoneParamIdPointer,

   105         // Add new params before this

   106         EPhoneParamIdLast

   107         };

   108 

   109     public: 

   110         

   111         /**

   112         * Method for checking the command parameter id.

   113         * 

   114         * @return Returns an id of the command parameter in question.

   115         */

   116         IMPORT_C TPhoneParamId ParamId() const;

   117 

   118         /**

   119         * C++ default constructor.

   120         */

   121         IMPORT_C TPhoneCommandParam();

   122 

   123 

   124     protected:

   125 

   126         /**

   127         * Param ID.

   128         */

   129         TPhoneParamId iParamId;

   130     };

   131 

   132 #endif // TPHONECOMMANDPARAM_H   

   133             

   134 // End of File