phoneapp/phoneuiview/inc/mphoneviewcommandhandle.h
changeset 0 5f000ab63145
equal deleted inserted replaced
-1:000000000000 0:5f000ab63145
       
     1 /*
       
     2 * Copyright (c) 2005 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:  View command handle
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef MPHONEVIEWCOMMANDHANDLE_H
       
    20 #define MPHONEVIEWCOMMANDHANDLE_H
       
    21 
       
    22 //  INCLUDES
       
    23 #include <e32std.h>
       
    24 #include "phoneviewcommanddefinitions.h"
       
    25 
       
    26 // DATA TYPES
       
    27 
       
    28 // FORWARD DECLARATION
       
    29 class TPhoneCommandParam;
       
    30 
       
    31 // CLASS DECLARATION
       
    32 /**
       
    33 *  Interface class for executing UI commands
       
    34 *
       
    35 */
       
    36 class MPhoneViewCommandHandle
       
    37     {
       
    38     public:  // Constructors and destructor
       
    39         /**
       
    40         * Destructor.
       
    41         */
       
    42         virtual ~MPhoneViewCommandHandle(){};
       
    43 
       
    44     public: // New functions
       
    45         
       
    46         /**
       
    47         * Execute Command with given Command Id
       
    48         * @param aCmdId Command Id
       
    49         * @return None
       
    50         */
       
    51         virtual void ExecuteCommandL( 
       
    52             TPhoneViewCommandId aCmdId ) = 0;
       
    53 
       
    54         /**
       
    55         * Execute Command with given Command Id  and Call Id
       
    56         * @param aCmdId Command Id
       
    57         * @param aCallId Call Id
       
    58         * @return None
       
    59         */
       
    60         virtual void ExecuteCommandL( 
       
    61             TPhoneViewCommandId aCmdId, 
       
    62             TInt aCallId ) = 0;
       
    63 
       
    64          /**
       
    65         * Execute Command with given command id, call id and command parameter.
       
    66         * @param aCmdId Command Id
       
    67         * @param aCommandParam Command parameter
       
    68         * @return None
       
    69         */
       
    70         virtual void ExecuteCommandL( 
       
    71             TPhoneViewCommandId aCmdId, 
       
    72             TPhoneCommandParam* aCommandParam ) = 0;
       
    73 
       
    74          /**
       
    75         * Execute Command with given command id, call id and command parameter.
       
    76         * @param aCmdId Command Id
       
    77         * @param aCallId Call Id
       
    78         * @param aCommandParam Command parameter
       
    79         * @return None
       
    80         */
       
    81         virtual void ExecuteCommandL( 
       
    82             TPhoneViewCommandId aCmdId, 
       
    83             TInt aCallId, 
       
    84             TPhoneCommandParam* aCommandParam ) = 0;
       
    85 
       
    86         /**
       
    87         * Execute Command with given command id, call id and message.
       
    88         * @param aCmdId Command Id
       
    89         * @param aCallId Call Id
       
    90         * @param aMessage Command message
       
    91         */
       
    92         virtual void ExecuteCommandL( 
       
    93             TPhoneViewCommandId aCmdId, 
       
    94             TInt aCallId, 
       
    95             TDesC& aMessage ) = 0;
       
    96 
       
    97         /**
       
    98         * Handle Command with given Command Id
       
    99         * @param aCmdId Command Id
       
   100         * @return TPhoneViewResponseId
       
   101         */
       
   102         virtual TPhoneViewResponseId HandleCommandL( 
       
   103             TPhoneViewCommandId aCmdId ) = 0;
       
   104 
       
   105         /**
       
   106         * Handle Command with given command id and command parameter.
       
   107         * @param aCmdId Command Id
       
   108         * @param aCommandParam Command parameter
       
   109         * @return TPhoneViewResponseId
       
   110         */
       
   111         virtual TPhoneViewResponseId HandleCommandL( 
       
   112             TPhoneViewCommandId aCmdId, 
       
   113             TPhoneCommandParam* aCommandParam ) = 0;
       
   114             
       
   115         /**
       
   116         * Execute Command with given Command Id
       
   117         * @param aCmdId Command Id
       
   118         * @return None
       
   119         */
       
   120         virtual void ExecuteCommand( 
       
   121             TPhoneViewCommandId aCmdId ) = 0;
       
   122             
       
   123         /**
       
   124         * Execute Command with given command id and command parameter.
       
   125         * @param aCmdId Command Id
       
   126         * @param aCommandParam Command parameter
       
   127         * @return None
       
   128         */
       
   129         virtual void ExecuteCommand( 
       
   130             TPhoneViewCommandId aCmdId, 
       
   131             TPhoneCommandParam* aCommandParam ) = 0;                        
       
   132        
       
   133         /**
       
   134         * Execute Command with given Command Id
       
   135         */     
       
   136         virtual const TDesC& FetchContent() = 0;          
       
   137 
       
   138     };
       
   139 
       
   140 #endif // MPHONEVIEWCOMMANDHANDLE_H   
       
   141             
       
   142 // End of File