textinput/peninputhwrboxjp/inc/peninputhwrboxuistate.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 ui state
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef C_PENINPUTHWRBOXUISTATE_H
       
    20 #define C_PENINPUTHWRBOXUISTATE_H
       
    21 
       
    22 // system includes
       
    23 #include <peninputuistatebase.h>
       
    24 
       
    25 class CPeninputHwrBoxLayout;
       
    26 
       
    27 // user includes
       
    28 
       
    29 // class declarations
       
    30 
       
    31 /**
       
    32  *  Basic class of hwr ui state
       
    33  *
       
    34  *  @lib peninputhwrboxjp.lib
       
    35  *  @since S60 v3.2
       
    36  */
       
    37 class CPeninputHwrBoxUiState : public CPeninputUiStateBase
       
    38     {
       
    39 public:
       
    40 
       
    41     /**
       
    42      * Two-phased constructor.
       
    43      *
       
    44      * @since S60 v3.2
       
    45      * @param aUiStateMgr The common ui state manager
       
    46      * @param aContext The common layout context
       
    47      * @return The pointer point to CPeninputHwrBoxUiState type object
       
    48      */
       
    49     static CPeninputHwrBoxUiState* NewL(MPeninputUiStateMgr* aUiStateMgr, MPeninputLayoutContext* aContext);
       
    50 
       
    51     /**
       
    52      * Destructor.
       
    53      *
       
    54      * @since S60 v3.2
       
    55      */
       
    56     virtual ~CPeninputHwrBoxUiState();
       
    57 
       
    58     // from MPeninputHwrBoxUiState  
       
    59 
       
    60     /**
       
    61      * process internal event
       
    62      *
       
    63      * @since S60 v3.2
       
    64      * @param aEventType The internal event type
       
    65      * @param aEventData The internal event data
       
    66      * @return ETrue means event was responsed, otherwise EFalse
       
    67      */
       
    68     virtual TBool HandleControlEvent(TInt aEventType, const TDesC& aEventData);
       
    69 
       
    70     /**
       
    71      * Handle the event for Pen from control
       
    72      *
       
    73      * @since S60 v3.2
       
    74      * @param aEventType The event type
       
    75      * @param aEventData The event data.
       
    76      * @param aUiLayout  The UiLayout Control
       
    77      * @param aCharCode  character code buffer
       
    78      * @param aHandled   output buffer:ETrue means event was responsed, otherwise EFalse
       
    79      * @return None
       
    80      */
       
    81     virtual void HandleControlEventPenL(TInt aEventType, const TDesC& aEventData, CPeninputHwrBoxLayout& aUiLayout, TDes& aCharCode, TBool& aHandled);
       
    82 
       
    83 protected:
       
    84 
       
    85     /**
       
    86      * C++ default constructor.
       
    87      *
       
    88      * @since S60 v3.2
       
    89      * @param aUiStateMgr The common ui state manager
       
    90      * @param aContext The common layout context
       
    91      */
       
    92     CPeninputHwrBoxUiState(MPeninputUiStateMgr* aUiStateMgr, MPeninputLayoutContext* aContext);
       
    93 
       
    94     /**
       
    95      * Process pseudo virtual key (hwr 1 char) 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 HandleVkbEvent(TInt aEventType, const TDesC& aEventData);
       
   103 
       
   104     /**
       
   105      * Process backspace key event
       
   106      *
       
   107      * @since S60 v3.2
       
   108      * @param aEventType The event type
       
   109      * @param aEventData The event data
       
   110      * @return ETrue means event was responsed, otherwise EFalse
       
   111      */
       
   112     virtual TBool HandleBackEvent(TInt aEventType, const TDesC& aEventData);
       
   113 
       
   114     /**
       
   115      * Process enter, space, tab key event
       
   116      *
       
   117      * @since S60 v3.2
       
   118      * @param aEventType The event type
       
   119      * @param aEventData The event data
       
   120      * @return ETrue means event was responsed, otherwise EFalse
       
   121      */
       
   122     virtual TBool HandleEnterSpaceTabEvent(TInt aEventType, const TDesC& aEventData);
       
   123     };
       
   124 
       
   125 #endif  // C_PENINPUTHWRBOXUISTATE_H
       
   126 
       
   127 // End Of File