textinput/peninputvkbcn/inc/peninputvkbuistatestandbycn.h
changeset 0 eb1f2e154e89
equal deleted inserted replaced
-1:000000000000 0:eb1f2e154e89
       
     1 /*
       
     2 * Copyright (c) 2002-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:  Interface of vkb standby cn ui state
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef C_AKNFEPVKBUISTATESTANDBYCN_H
       
    20 #define C_AKNFEPVKBUISTATESTANDBYCN_H
       
    21 
       
    22 // user includes
       
    23 #include "peninputvkbuistate.h"
       
    24 
       
    25 /**
       
    26  *  Vkb standby cn ui state
       
    27  *  It provides key event handling and internal event handling in standby cn ui state
       
    28  *
       
    29  *  @lib peninputvkbcn.lib
       
    30  *  @since S60 v3.2
       
    31  */
       
    32 class CAknFepVkbUiStateStandbycn : public CAknFepVkbUiState
       
    33     {
       
    34 public:
       
    35 
       
    36     /**
       
    37      * Two-phased constructor.
       
    38      *
       
    39      * @since S60 v3.2
       
    40      * @param aUiStateMgr The vkb ui state manager
       
    41      * @param aContext The vkb layout context
       
    42      * @return The pointer point to CAknFepVkbUiStateStandbycn type object
       
    43      */
       
    44     static CAknFepVkbUiStateStandbycn* NewL(MAknFepVkbUiStateMgr* aUiStateMgr, 
       
    45                                             MAknFepVkbLayoutContext* aContext);
       
    46         
       
    47     /**
       
    48      * Destructor.
       
    49      *
       
    50      * @since S60 v3.2
       
    51      */
       
    52     virtual ~CAknFepVkbUiStateStandbycn();
       
    53         
       
    54     /**
       
    55      * Process key event
       
    56      *
       
    57      * @since S60 v3.2
       
    58      * @param aData Carry information of key pressed
       
    59      * @return ETrue means event was responsed, otherwise EFalse
       
    60      */
       
    61     virtual TBool HandleKeyEventL(const TRawEvent &aData);     
       
    62         
       
    63     /**
       
    64      * process internal event
       
    65      *
       
    66      * @since S60 v3.2
       
    67      * @param aEventType The internal event type
       
    68      * @param aEventData The internal event data
       
    69      * @return ETrue means event was responsed, otherwise EFalse
       
    70      */
       
    71     virtual TBool HandleControlEvent(TInt aEventType, const TDesC& aEventData);
       
    72             
       
    73 protected:
       
    74 
       
    75     /**
       
    76      * C++ default constructor.
       
    77      *
       
    78      * @since S60 v3.2
       
    79      * @param aUiStateMgr The vkb ui state manager
       
    80      * @param aContext The vkb layout context
       
    81      */
       
    82     CAknFepVkbUiStateStandbycn(MAknFepVkbUiStateMgr* aUiStateMgr, 
       
    83                                MAknFepVkbLayoutContext* aContext);
       
    84     
       
    85     /**
       
    86      * Symbian second-phase constructor
       
    87      *
       
    88      * @since S60 v3.2
       
    89      * @return None
       
    90      */
       
    91     //void ConstructL();
       
    92     
       
    93     /**
       
    94      * Process virtual key event
       
    95      *
       
    96      * @since S60 v3.2
       
    97      * @param aEventType The event type
       
    98      * @param aEventData The event data
       
    99      * @return ETrue means event was responsed, otherwise EFalse
       
   100      */
       
   101     virtual TBool HandleVkbEvent(TInt aEventType, const TDesC& aEventData);
       
   102 
       
   103     /**
       
   104      * Process backspace key event
       
   105      *
       
   106      * @since S60 v3.2
       
   107      * @param aEventType The event type
       
   108      * @param aEventData The event data
       
   109      * @return ETrue means event was responsed, otherwise EFalse
       
   110      */
       
   111     virtual TBool HandleBackEvent(TInt aEventType, const TDesC& aEventData);
       
   112 
       
   113     /**
       
   114      * Process enter, space key event
       
   115      *
       
   116      * @since S60 v3.2
       
   117      * @param aEventType The event type
       
   118      * @param aEventData The event data
       
   119      * @return ETrue means event was responsed, otherwise EFalse
       
   120      */
       
   121     virtual TBool HandleEnterSpaceEvent(TInt aEventType, const TDesC& aEventData);
       
   122         
       
   123     /**
       
   124      * Process tab key event
       
   125      *
       
   126      * @since S60 v3.2
       
   127      * @param aEventType The event type
       
   128      * @param aEventData The event data
       
   129      * @return ETrue means event was responsed, otherwise EFalse
       
   130      */
       
   131     virtual TBool HandleTabEvent(TInt aEventType, const TDesC& aEventData);   
       
   132     
       
   133 	virtual TBool HandleArrowKeyEvent(TInt aEventType, const TDesC& aEventData);        
       
   134     };
       
   135 
       
   136 #endif  // C_AKNFEPVKBUISTATESTANDBYCN_H
       
   137 
       
   138 // End Of File