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:  interface of layout context

    15 *

    16 */

    17 

    18 

    19 #ifndef M_MPENINPUTLAYOUTCONTEXT_H

    20 #define M_MPENINPUTLAYOUTCONTEXT_H

    21 

    22 // System includes

    23 #include <e32base.h>

    24 

    25 // User includes

    26 #include "peninputdataprovider.h"

    27 

    28 // Class forward decalaration

    29 class CFepUiBaseCtrl;

    30 

    31 /**

    32  *  Peninput common layout interface

    33  *

    34  *  @lib peninputcommonlayout.lib

    35  *  @since S60 v3.2

    36  */

    37 class MPeninputLayoutContext

    38     {

    39 

    40 public:

    41 

    42     /**

    43      * Send event to window

    44      *

    45      * @since S60 v3.2

    46      * @param aEventType The event type

    47      * @param aCtrl The sender control

    48      * @param aEventData The event data

    49      * @return None 

    50      */

    51     virtual void SendEventToWindow( TInt aEventType, 

    52                                     CFepUiBaseCtrl* aCtrl, 

    53                                     const TDesC& aEventData = KNullDesC ) = 0;

    54                         

    55     virtual TBool IsShiftPermitted() = 0;

    56     virtual TBool IsCapsLockPermitted() = 0;

    57 

    58     /**

    59      * Send key to fep

    60      *

    61      * @since S60 v3.2

    62      * @param aEventType The event type

    63      * @param aEventData The event data

    64      * @return None

    65      */

    66     virtual void Sendkey( TInt aEventType, 

    67                           const TDesC& aEventData = KNullDesC ) = 0;

    68     

    69     /**

    70      * Request data from data provider

    71      *

    72      * @since S60 v3.2

    73      * @param aDataType The data type request 

    74      * @return The pointer to TAny type data requested

    75      */

    76     virtual TAny* RequestData( TPeninputDataType aDataType ) = 0;

    77 

    78     /**

    79      * Set data for data provider

    80      *

    81      * @since S60 v3.2

    82      * @param aDataType The data type to set value 

    83      * @param aData The pointer to TAny type data

    84      * @return None

    85      */

    86     virtual void SetData( TPeninputDataType aDataType, TAny* aData ) = 0;

    87 

    88     /**

    89      * Save key into CenRep(AknFep)

    90      *

    91      * @since S60 v3.2

    92      * @param aKey The key name

    93      * @param aValue The new value

    94      * @return None

    95      */

    96     virtual void SaveKey( TInt aKey, TInt aValue ) = 0;

    97 

    98     /**

    99      * Get the layout type, vkb or hwr.

   100      * 

   101      * @since S60 v3.2

   102      * @return The layout type

   103      */    

   104     virtual TInt LayoutType() = 0;

   105     

   106     };

   107 

   108 #endif  // End of M_PENINPUTLAYOUTCONTEXT_H