textinput/peninputvkbcn/inc/peninputvkbdataprovider.h
changeset 0 eb1f2e154e89
equal deleted inserted replaced
-1:000000000000 0:eb1f2e154e89
       
     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 vkb ui state
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef M_AKNFEPVKBDATAPROVIDER_H
       
    20 #define M_AKNFEPVKBDATAPROVIDER_H
       
    21 
       
    22 enum TAknFepDataType
       
    23     {
       
    24     EAknFepDataTypeCase                 = 0x0001,
       
    25     EAknFepDataTypeInputLanguage        = 0x0002,
       
    26     EAknFepDataTypePermittedRange       = 0x0004,
       
    27     EAknFepDataTypeCurrentRange         = 0x0008,
       
    28     EAknFepDataTypeIMLayout             = 0x0010,
       
    29     EAknFepDataTypeNumericKeymap        = 0x0020,                       
       
    30     EAknFepDataTypeShfitDown            = 0x0040,
       
    31     EAknFepDataTypeCapslockDown         = 0x0080,
       
    32     EAknFepDataTypeCurrentAccent        = 0x0100,    
       
    33     EAknFepDataTypeCandidateCount       = 0x0200,    
       
    34     EAknFepDataTypeLengthWhenButtondownOnBack = 0x0400,
       
    35     EAknFepDataTypeWindowPosition       = 0x0800,
       
    36     EAknFepDataTypeUnitWidth        = 0x1000,
       
    37     EAknFepDataTypeUnitHeight        = 0x2000,
       
    38     EAknFepDataTypeScreenSize        = 0x4000,
       
    39     //EAknFepDataTypePoistionJustifyStyle = 0x8000,
       
    40     EAknFepDataTypeDataQueryRect        = 0x10000,
       
    41     EAknFepDataTypeUseDefinedResource   = 0x20000,
       
    42     EAknFepDataTypeShadowTlSize = 0x40000,
       
    43     EAknFepDataTypeShadowBrSize = 0x80000,
       
    44     EAknFepDataTypeMainPaneRect = 0x100000,
       
    45     EAknFepDataTypeTitleBarHeight = 0x200000,
       
    46     EAknFepDataTypeIcfColumnNums  = 0x400000,
       
    47     EAknFepDataTypeDefaultIMLayout = 0x800000,
       
    48     EAknFepDataTypeNeedBRJustify = 0x8000
       
    49     };
       
    50 
       
    51 // class declarations
       
    52 /**
       
    53  *  Data manager class
       
    54  *
       
    55  *  @lib peninputvkbcn.lib
       
    56  *  @since S60 v3.2
       
    57  */
       
    58 class MAknFepVkbDataProvider
       
    59     {
       
    60 public:
       
    61     /**
       
    62      * Request data from data provider
       
    63      *
       
    64      * @since S60 v3.2
       
    65      * @param aDataType The data request 
       
    66      * @return The data you request
       
    67      */
       
    68     virtual TInt RequestData(TAknFepDataType aDataType) = 0;
       
    69     
       
    70     /**
       
    71      * Set data according to the data type
       
    72      *
       
    73      * @since S60 v3.2
       
    74      * @param aDataType The data type need to set
       
    75      * @param aData The new data
       
    76      * @return candidates list.
       
    77      */    
       
    78     virtual void SetData(TAknFepDataType aDataType,TInt aData) = 0;
       
    79     
       
    80     /**
       
    81      * Read unit and shadow size
       
    82      *
       
    83      * @since S60 v3.2
       
    84      * @return None
       
    85      */    
       
    86     virtual void ReadUnitShadowSize() = 0;
       
    87     
       
    88     /**
       
    89      * Whether size is changing
       
    90      *
       
    91      * @since S60 v3.2
       
    92      * @return ETrue if size is changing, otherwise EFalse
       
    93      */    
       
    94     virtual TBool SizeChanging() = 0;
       
    95     
       
    96     /**
       
    97      * Get info of whether unit and shadow size have been read
       
    98      *
       
    99      * @since S60 v3.2
       
   100      * @return Flag to indicate whether unit and shadow size
       
   101      * have been read
       
   102      */      
       
   103     virtual TBool UnitShadowSizeSet() = 0;
       
   104     };
       
   105 
       
   106 #endif  //M_AKNFEPVKBDATAPROVIDER_H
       
   107 
       
   108 //End Of File