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