textinput/peninputhwrboxjp/inc/peninputhwrboxuistatestandby.h
changeset 0 eb1f2e154e89
equal deleted inserted replaced
-1:000000000000 0:eb1f2e154e89
       
     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 standby ui state
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef C_PENINPUTHWRBOXUISTATESTANDBY_H
       
    20 #define C_PENINPUTHWRBOXUISTATESTANDBY_H
       
    21 
       
    22 // user includes
       
    23 #include "peninputhwrboxuistate.h"
       
    24 
       
    25 /**
       
    26  *  Hwr standby ui state
       
    27  *  It provides key event handling and internal event handling in standby ui state
       
    28  *
       
    29  *  @lib peninputhwrboxjp.lib
       
    30  *  @since S60 v3.2
       
    31  */
       
    32 class CPeninputHwrBoxUiStateStandby : public CPeninputHwrBoxUiState
       
    33     {
       
    34 public:
       
    35 
       
    36     /**
       
    37      * Two-phased constructor.
       
    38      *
       
    39      * @since S60 v3.2
       
    40      * @param aUiStateMgr The common ui state manager
       
    41      * @param aContext The common layout context
       
    42      * @return The pointer point to CPeninputHwrBoxUiStateStandby type object
       
    43      */
       
    44     static CPeninputHwrBoxUiStateStandby* NewL(MPeninputUiStateMgr* aUiStateMgr, MPeninputLayoutContext* aContext);
       
    45 
       
    46     /**
       
    47      * Destructor.
       
    48      *
       
    49      * @since S60 v3.2
       
    50      */
       
    51     virtual ~CPeninputHwrBoxUiStateStandby();
       
    52 
       
    53     /**
       
    54      * Process key event
       
    55      *
       
    56      * @since S60 v3.2
       
    57      * @param aData Carry information of key pressed
       
    58      * @return ETrue means event was responsed, otherwise EFalse
       
    59      */
       
    60     virtual TBool HandleKeyEventL(const TRawEvent &aData);
       
    61 
       
    62 protected:
       
    63 
       
    64     /**
       
    65      * C++ default constructor.
       
    66      *
       
    67      * @since S60 v3.2
       
    68      * @param aUiStateMgr The common ui state manager
       
    69      * @param aContext The common layout context
       
    70      */
       
    71     CPeninputHwrBoxUiStateStandby(MPeninputUiStateMgr* aUiStateMgr, MPeninputLayoutContext* aContext);
       
    72 
       
    73     /**
       
    74      * Process pseudo virtual key (hwr 1 char) event
       
    75      *
       
    76      * @since S60 v3.2
       
    77      * @param aEventType The event type
       
    78      * @param aEventData The event data
       
    79      * @return ETrue means event was responsed, otherwise EFalse
       
    80      */
       
    81     virtual TBool HandleVkbEvent(TInt aEventType, const TDesC& aEventData);
       
    82 
       
    83     /**
       
    84      * Process backspace key event
       
    85      *
       
    86      * @since S60 v3.2
       
    87      * @param aEventType The event type
       
    88      * @param aEventData The event data
       
    89      * @return ETrue means event was responsed, otherwise EFalse
       
    90      */
       
    91     virtual TBool HandleBackEvent(TInt aEventType, const TDesC& aEventData);
       
    92 
       
    93     /**
       
    94      * Process enter, space, tab key event
       
    95      *
       
    96      * @since S60 v3.2
       
    97      * @param aEventType The event type
       
    98      * @param aEventData The event data
       
    99      * @return ETrue means event was responsed, otherwise EFalse
       
   100      */
       
   101     virtual TBool HandleEnterSpaceTabEvent(TInt aEventType, const TDesC& aEventData);
       
   102     };
       
   103 
       
   104 #endif  // C_PENINPUTHWRBOXUISTATESTANDBY_H
       
   105 
       
   106 // End Of File