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 vkb ui state

    15 *

    16 */

    17 

    18 

    19 #ifndef C_PENINPUTVKBUISTATE_H

    20 #define C_PENINPUTVKBUISTATE_H

    21 

    22 // system includes

    23 #include <peninputuistatebase.h>

    24 

    25 // user includes

    26 

    27 // class declarations

    28 

    29 /**

    30  *  Basic class of vkb ui state

    31  *

    32  *  @lib peninputvkbjp.lib

    33  *  @since S60 v3.2

    34  */

    35 class CPeninputVkbUiState : public CPeninputUiStateBase

    36     {

    37 public:

    38 

    39     /**

    40      * Two-phased constructor.

    41      *

    42      * @since S60 v3.2

    43      * @param aUiStateMgr The common ui state manager

    44      * @param aContext The common layout context

    45      * @return The pointer point to CPeninputVkbUiState type object

    46      */

    47     static CPeninputVkbUiState* NewL(MPeninputUiStateMgr* aUiStateMgr, MPeninputLayoutContext* aContext);

    48 

    49     /**

    50      * Destructor.

    51      *

    52      * @since S60 v3.2

    53      */

    54     virtual ~CPeninputVkbUiState();

    55 

    56     // from MPeninputVkbUiState  

    57 

    58     /**

    59      * process internal event

    60      *

    61      * @since S60 v3.2

    62      * @param aEventType The internal event type

    63      * @param aEventData The internal event data

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

    65      */

    66     virtual TBool HandleControlEvent(TInt aEventType, const TDesC& aEventData);

    67     

    68 protected:

    69 

    70     /**

    71      * C++ default constructor.

    72      *

    73      * @since S60 v3.2

    74      * @param aUiStateMgr The common ui state manager

    75      * @param aContext The common layout context

    76      */

    77     CPeninputVkbUiState(MPeninputUiStateMgr* aUiStateMgr, MPeninputLayoutContext* aContext);

    78 

    79     /**

    80      * Process virtual key event

    81      *

    82      * @since S60 v3.2

    83      * @param aEventType The event type

    84      * @param aEventData The event data

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

    86      */

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

    88 

    89     /**

    90      * Process backspace key event

    91      *

    92      * @since S60 v3.2

    93      * @param aEventType The event type

    94      * @param aEventData The event data

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

    96      */

    97     virtual TBool HandleBackEvent(TInt aEventType, const TDesC& aEventData);

    98 

    99     /**

   100      * Process enter, space, tab key event

   101      *

   102      * @since S60 v3.2

   103      * @param aEventType The event type

   104      * @param aEventData The event data

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

   106      */

   107     virtual TBool HandleEnterSpaceTabEvent(TInt aEventType, const TDesC& aEventData);

   108     };

   109 

   110 #endif  // C_PENINPUTVKBUISTATE_H

   111 

   112 // End Of File