1 /*

     2 * Copyright (c) 2002-2007 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 hwr composition with chars ui state

    15 *

    16 */

    17 

    18 

    19 #ifndef C_PENINPUTHWRBOXUISTATEWITHTRANSITORYCHARS_H

    20 #define C_PENINPUTHWRBOXUISTATEWITHTRANSITORYCHARS_H

    21 

    22 // user includes

    23 #include "peninputhwrboxuistate.h"

    24 

    25 // class declarations

    26 /**

    27  *  with  transitory chars ui state

    28  *  It provides key event handling and internal event handling in with  transitory chars state

    29  *

    30  *  @lib peninputhwrboxjp.lib

    31  *  @since S60 v3.2

    32  */

    33 class CPeninputHwrBoxUiStateWithTransitoryChars : public CPeninputHwrBoxUiState

    34     {

    35 public:

    36 

    37     /**

    38      * Two-phased constructor.

    39      *

    40      * @since S60 v3.2

    41      * @param aUiStateMgr The common ui state manager

    42      * @param aContext The common layout context

    43      * @return The pointer point to CPeninputHwrBoxUiStateWithTransitoryChars type object

    44      */

    45     static CPeninputHwrBoxUiStateWithTransitoryChars* NewL(MPeninputUiStateMgr* aUiStateMgr, MPeninputLayoutContext* aContext);

    46         

    47     /**

    48      * Destructor.

    49      *

    50      * @since S60 v3.2

    51      */

    52     virtual ~CPeninputHwrBoxUiStateWithTransitoryChars();

    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 protected:

    64 

    65     /**

    66      * C++ default constructor.

    67      *

    68      * @since S60 v3.2

    69      * @param aUiStateMgr The common ui state manager

    70      * @param aContext The common layout context

    71      */

    72     CPeninputHwrBoxUiStateWithTransitoryChars(MPeninputUiStateMgr* aUiStateMgr, MPeninputLayoutContext* aContext);

    73 

    74     /**

    75      * Process pseudo virtual key (hwr 1 char) event

    76      *

    77      * @since S60 v3.2

    78      * @param aEventType The event type

    79      * @param aEventData The event data

    80      * @return ETrue means event was responsed, otherwise EFalse

    81      */

    82     virtual TBool HandleVkbEvent(TInt aEventType, const TDesC& aEventData);

    83 

    84     /**

    85      * Process backspace 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 HandleBackEvent(TInt aEventType, const TDesC& aEventData);

    93 

    94     /**

    95      * Process enter, space, tab 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 HandleEnterSpaceTabEvent(TInt aEventType, const TDesC& aEventData);   

   103     };

   104 

   105 #endif  // C_PENINPUTHWRBOXUISTATEWITHTRANSITORYCHARS_H

   106 

   107 // End Of File