phoneapp/phoneuiutils/inc/tphonecmdparamkeyevent.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: 
       
    15 *   See class description.
       
    16 *
       
    17 */
       
    18 
       
    19 
       
    20 #ifndef __TPHONECMDPARAMKEYEVENT_H
       
    21 #define __TPHONECMDPARAMKEYEVENT_H
       
    22 
       
    23 //  INCLUDES
       
    24 
       
    25 #include <w32std.h>
       
    26 #include "tphonecommandparam.h"
       
    27 
       
    28 // DATA TYPES
       
    29 
       
    30 // CLASS DECLARATION
       
    31 
       
    32 /**
       
    33 *  A parameter class for key event information.
       
    34 */
       
    35 class TPhoneCmdParamKeyEvent : public TPhoneUICommandParam
       
    36     {   
       
    37     public:  
       
    38         
       
    39         /**
       
    40         * C++ default constructor.
       
    41         */
       
    42         IMPORT_C TPhoneCmdParamKeyEvent();
       
    43 
       
    44     public: 
       
    45         
       
    46         /**
       
    47         * Sets the key event.
       
    48         * @param aKeyEvent is the key event
       
    49         */
       
    50         IMPORT_C void SetKeyEvent( const TKeyEvent& aKeyEvent );
       
    51 
       
    52         
       
    53         /**
       
    54         * Sets the key event code.
       
    55         * @param aEventCode is the key event code
       
    56         */
       
    57         IMPORT_C void SetEventCode( TEventCode aEventCode );
       
    58 
       
    59         /**
       
    60         * Returns the key event.
       
    61         * @return Returns the key event
       
    62         */
       
    63         IMPORT_C const TKeyEvent KeyEvent() const;
       
    64 
       
    65 
       
    66         /**
       
    67         * Returns the key code.
       
    68         * @return Returns the key code
       
    69         */
       
    70         IMPORT_C TEventCode EventCode() const;
       
    71 
       
    72     private:    
       
    73         
       
    74         /**
       
    75         * Key event
       
    76         */
       
    77         TKeyEvent iKeyEvent;
       
    78 
       
    79         /**
       
    80         * Key event code
       
    81         */
       
    82         TEventCode iEventCode;
       
    83 
       
    84     };
       
    85 
       
    86 #endif // __TPHONECMDPARAMKEYEVENT_H   
       
    87             
       
    88 // End of File