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:  peninput generic vkb ui state standby class definition

    15 *

    16 */

    17 

    18 

    19 #ifndef C_PNEINPUTGENERICVKBUISTATESTANDBY_H

    20 #define C_PNEINPUTGENERICVKBUISTATESTANDBY_H

    21 

    22 // System includes

    23 #include <peninputuistatebase.h>

    24 

    25 // Forward declarations

    26 class MPeninputUiStateMgr;

    27 class MPeninputLayoutContext;

    28 

    29 /**

    30  *  Vkb's standby ui state class

    31  *  This class define methods to handle event received at this ui state

    32  *

    33  *  @lib peninputgenericvkb.lib

    34  *  @since S60 v3.2

    35  */

    36 class CPeninputUiStateVkbStandby : public CPeninputUiStateBase

    37     {

    38 

    39 public:

    40 

    41     /**

    42      * Two-phased constructor

    43      *

    44      * @since S60 v3.2

    45      * @param aUiStateMgr The vkb ui state manager

    46      * @param aContext The vkb layout context

    47      * @return The pointer to CPeninputUiStateVkbStandby object

    48      */

    49     static CPeninputUiStateVkbStandby* NewL( MPeninputUiStateMgr* aUiStateMgr,

    50         MPeninputLayoutContext* aContext );

    51         

    52     /**

    53      * Destructor

    54      *

    55      * @since S60 v3.2

    56      * @return None

    57      */

    58     virtual ~CPeninputUiStateVkbStandby();

    59         

    60 // From base class CPeninputUiStateBase  

    61 

    62     /**

    63      * From CPeninputUiStateBase

    64      * Process key event

    65      *

    66      * @since S60 v3.2

    67      * @param aData Carry information of key pressed

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

    69      */

    70     virtual TBool HandleKeyEventL( const TRawEvent &aData );

    71     

    72     /**

    73      * From CPeninputUiStateBase

    74      * process internal event

    75      *

    76      * @since S60 v3.2

    77      * @param aEventType The internal event type

    78      * @param aEventData The internal event data

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

    80      */

    81     virtual TBool HandleControlEvent( TInt aEventType, 

    82                                       const TDesC& aEventData );

    83     

    84 protected:

    85 

    86     /**

    87      * Constructor

    88      *

    89      * @since S60 v3.2

    90      * @param aUiStateMgr The vkb ui state manager

    91      * @param aContext The vkb layout context

    92      * @return None

    93      */

    94     CPeninputUiStateVkbStandby( MPeninputUiStateMgr* aUiStateMgr, 

    95                                 MPeninputLayoutContext* aContext );

    96 

    97     /**

    98      * Process virtual key event

    99      *

   100      * @since S60 v3.2

   101      * @param aEventType The event type

   102      * @param aEventData The event data

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

   104      */

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

   106     

   107     /**

   108      * Process backspace key event

   109      *

   110      * @since S60 v3.2

   111      * @param aEventType The event type

   112      * @param aEventData The event data

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

   114      */

   115     virtual TBool HandleBackEvent( TInt aEventType, 

   116                                    const TDesC& aEventData );

   117     

   118     /**

   119      * Process enter, space key event

   120      *

   121      * @since S60 v3.2

   122      * @param aEventType The event type

   123      * @param aEventData The event data

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

   125      */

   126     virtual TBool HandleEnterSpaceEvent( TInt aEventType, 

   127                                             const TDesC& aEventData );

   128     

   129     /**

   130      * Process tab key event

   131      *

   132      * @since S60 v3.2

   133      * @param aEventType The event type

   134      * @param aEventData The event data

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

   136      */

   137     virtual TBool HandleTabEvent( TInt aEventType, 

   138                                             const TDesC& aEventData );

   139 

   140     };

   141                 

   142 #endif  // C_PNEINPUTGENERICVKBUISTATESTANDBY_H