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 #ifndef C_PENINPUTSPLITQWERTYUISTATESTANDBY_H

    19 #define C_PENINPUTSPLITQWERTYUISTATESTANDBY_H

    20 

    21 // System includes

    22 #include <peninputuistatebase.h>

    23 

    24 // Forward declarations

    25 class MPeninputUiStateMgr;

    26 class MPeninputLayoutContext;

    27 

    28 /**

    29  *  class CPeninputSplitQwertyUiStateStandby

    30  *

    31  *  @lib peninputsplitqwerty.lib

    32  *  @since S60 v5.0

    33  */

    34 class CPeninputSplitQwertyUiStateStandby : public CPeninputUiStateBase

    35     {

    36 

    37 public:

    38     /**

    39      * Symbian constructor

    40      *

    41      * @since S60 v5.0

    42      * @param aUiStateMgr The vkb ui state manager

    43      * @param aContext The vkb layout context

    44      * @return The pointer to CPeninputUiStateVkbStandby object

    45      */

    46     static CPeninputSplitQwertyUiStateStandby* NewL(

    47                                         MPeninputUiStateMgr* aUiStateMgr,

    48                                         MPeninputLayoutContext* aContext );

    49 

    50     /**

    51      * C++ destructor

    52      *

    53      * @since S60 v5.0

    54      * @return None

    55      */

    56     virtual ~CPeninputSplitQwertyUiStateStandby();

    57 

    58 public:

    59     // From base class CPeninputUiStateBase  

    60 

    61     /**

    62      * From CPeninputUiStateBase

    63      * Process key event

    64      *

    65      * @since S60 v5.0

    66      * @param aData Carry information of key pressed

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

    68      */

    69     virtual TBool HandleKeyEventL( const TRawEvent& aData );

    70 

    71     /**

    72      * From CPeninputUiStateBase

    73      * process internal event

    74      *

    75      * @since S60 v5.0

    76      * @param aEventType The internal event type

    77      * @param aEventData The internal event data

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

    79      */

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

    81 

    82 protected:

    83 

    84     /**

    85      * C++ constructor

    86      *

    87      * @since S60 v5.0

    88      * @param aUiStateMgr The vkb ui state manager

    89      * @param aContext The vkb layout context

    90      * @return None

    91      */

    92     CPeninputSplitQwertyUiStateStandby( MPeninputUiStateMgr* aUiStateMgr,

    93                                         MPeninputLayoutContext* aContext );

    94 

    95     /**

    96      * Process virtual key event

    97      *

    98      * @since S60 v5.0

    99      * @param aEventType The event type

   100      * @param aEventData The event data

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

   102      */

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

   104 

   105     /**

   106      * Process backspace key event

   107      *

   108      * @since S60 v5.0

   109      * @param aEventType The event type

   110      * @param aEventData The event data

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

   112      */

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

   114 

   115     /**

   116      * Process enter, space key event

   117      *

   118      * @since S60 v5.0

   119      * @param aEventType The event type

   120      * @param aEventData The event data

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

   122      */

   123     virtual TBool HandleEnterSpaceEvent( TInt aEventType,

   124                                          const TDesC& aEventData );

   125 

   126     /**

   127      * Process tab key event

   128      *

   129      * @since S60 v5.0

   130      * @param aEventType The event type

   131      * @param aEventData The event data

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

   133      */

   134     virtual TBool HandleTabEvent( TInt aEventType, const TDesC& aEventData );

   135 

   136     };

   137 

   138 #endif  // C_PENINPUTSPLITQWERTYUISTATESTANDBY_H