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 C_AKNFEPVKBDATAMGR_H

    20 #define C_AKNFEPVKBDATAMGR_H

    21 

    22 // System includes

    23 #include <e32base.h>

    24 #include <w32std.h>

    25 

    26 // User includes

    27 #include "peninputvkbdataprovider.h"

    28 #include <peninputpluginutils.h>

    29 

    30 // The max length for language string 

    31 const TInt KMaxLangStringLength = 30;

    32 

    33 // The max length for language string 

    34 const TInt KMaxLengthCompFieldElemCount = 50;

    35 const TInt KMaxLengthPredictiveString = KMaxLengthCompFieldElemCount + 

    36                                         KMaxLengthCompFieldElemCount;

    37 

    38 const TInt KMaxPredictCandCnt = 250;

    39 

    40 /** class forward decalaration */

    41 class CPtiEngine;

    42 class MAknFepVkbLayoutContext;

    43 class CRepository;

    44 

    45 // class declarations

    46 /**

    47  *  Data manager class

    48  *

    49  *  @lib peninputvkbcn.lib

    50  *  @since S60 v3.2

    51  */

    52 class CAknFepVkbDataMgr: public CBase, 

    53                          public MAknFepVkbDataProvider

    54     {

    55 public:   

    56     /**

    57      * struct SLanguageItem

    58      * Language item struct

    59      * 

    60      */

    61     //struct SLanguageItem

    62     //    {

    63         /*

    64          * the language id(Symbian)

    65          */

    66     //    TInt iLangId;

    67         

    68         /*

    69          * the display text for the language corresponding

    70          */

    71     //    TBuf<KMaxLangStringLength> iDisplayText;

    72     //    };

    73                   

    74 public:

    75 

    76     /**

    77      * Create one CAknFepVkbWindow object

    78      *

    79      * @since S60 v3.2

    80      * @param aContext The layout context

    81      * @return The CFepCtrlDropdownList object.

    82      */ 

    83     static CAknFepVkbDataMgr* NewL(MAknFepVkbLayoutContext* aContext, 

    84                                    CPtiEngine* aPtiEngine = NULL);

    85     

    86     /**

    87      * Create one CAknFepVkbWindow object

    88      *

    89      * @since S60 v3.2

    90      * @param aContext The layout context

    91      * @return The CFepCtrlDropdownList object.

    92      */ 

    93     static CAknFepVkbDataMgr* NewLC(MAknFepVkbLayoutContext* aContext, 

    94                                     CPtiEngine* aPtiEngine = NULL);

    95 

    96     /**

    97      * Destructor

    98      *

    99      * @since S60 v3.2

   100      * @return None.

   101      */ 

   102     virtual ~CAknFepVkbDataMgr();

   103 

   104     /**

   105      * Reset data in manager

   106      *

   107      * @since S60 v3.2

   108      * @return None.

   109      */     

   110     void Reset();

   111                     

   112     /**

   113      * Get candidates

   114      *

   115      * @since S60 v3.2

   116      * @return candidates list.

   117      */       

   118     RPointerArray<HBufC> Candidates();

   119 

   120     /**

   121      * Notify engine to generate candidates

   122      *

   123      * @since S60 v3.2

   124      * @param aInputString The string sent to engine    

   125      * @param aIsPredictive The predictive flag, if true, tell engine to predict, 

   126      * @param aForNextPage Is it for next page candidate

   127      * @return The count of candidates

   128      */      

   129     TInt GetCandidatesL(const TDesC& aInputString, 

   130                         const TBool aIsPredictive,

   131                         TBool aForNextPage = EFalse);

   132 

   133     /**

   134      * Notify engine to generate candidates

   135      *

   136      * @since S60 v3.2

   137      * @param aTriggerStr The string sent to engine    

   138      * @param aPredictives The predictive 

   139      * @return None

   140      */      

   141     void DoPredictive(const TDesC& aTriggerStr, 

   142                       RPointerArray<HBufC>& aPredictives);

   143 

   144     /**

   145      * Clear trigger string

   146      *

   147      * @since S60 v3.2

   148      * @return None

   149      */

   150     void ClearTriggerString();

   151 

   152     /**

   153      * Get the count of candidates

   154      *

   155      * @since S60 v3.2

   156      * @return Candidates count.

   157      */      

   158     TInt CandidatesCount();

   159         

   160     /**

   161      * Get case

   162      *

   163      * @since S60 v3.2

   164      * @return Case.

   165      */      

   166     TInt Case();

   167 

   168     /**

   169      * Get peninput language

   170      *

   171      * @since S60 v3.2

   172      * @return Peninput language.

   173      */      

   174     TInt InputLanguage();

   175 

   176     /**

   177      * Get permitted range

   178      *

   179      * @since S60 v3.2

   180      * @return Permitted range.

   181      */      

   182     TInt PermittedRange();

   183     

   184     /**

   185      * Get current range

   186      *

   187      * @since S60 v3.2

   188      * @return Current range.

   189      */      

   190     TInt CurrentRange();

   191 

   192     /**

   193      * Get current accent

   194      *

   195      * @since S60 v3.2

   196      * @return The current accent.

   197      */      

   198     TInt CurrentAccent();

   199         

   200     /**

   201      * Get editor numeric keymap

   202      *

   203      * @since S60 v3.2

   204      * @return The editor numeric keymap.

   205      */      

   206     TInt EditorNumericKeymap();

   207     

   208     /**

   209      * Get input method layout

   210      *

   211      * @since S60 v3.2

   212      * @return The input method layout.

   213      */      

   214     TInt IMLayout();

   215 

   216     /**

   217      * Get shift down flag

   218      *

   219      * @since S60 v3.2

   220      * @return The shift down flag.

   221      */      

   222     TBool ShiftDown();

   223     

   224     /**

   225      * Get capslock down flag

   226      *

   227      * @since S60 v3.2

   228      * @return The capslock down flag.

   229      */      

   230     TBool CapslockDown();

   231     

   232     /**

   233      * Get length in composition field when button down on backspace button

   234      *

   235      * @since S60 v3.2

   236      * @return The length in composition field when button down on backspace button.

   237      */      

   238     TInt LengthWhenButtondownOnBack();

   239 

   240     /**

   241      * Get window position

   242      *

   243      * @since S60 v3.2

   244      * @return The window position.

   245      */      

   246     TInt WindowPosition();

   247     

   248     /**

   249      * Set window position

   250      *

   251      * @since S60 v3.2

   252      * @param aPosition The new value

   253      * @return None.

   254      */      

   255     void SetWindowPosition(TInt aPosition);

   256     

   257     /**

   258      * Set candidate count

   259      *

   260      * @since S60 v3.2

   261      * @param aCandidatesCount The new value

   262      * @return None.

   263      */         

   264     void SetCandidatesCount(TInt aCandidatesCount);

   265     

   266     /**

   267      * Set case

   268      *

   269      * @since S60 v3.2

   270      * @param aCase The new value

   271      * @return None.

   272      */         

   273     void SetCase(TInt aCase);

   274     void SetPermittedCase(TInt aCase);

   275     TInt PermittedCase();

   276 

   277     /**

   278      * Set peninput language

   279      *

   280      * @since S60 v3.2

   281      * @param aInputLanguage The new value

   282      * @return Display language shown on switch button

   283      */         

   284     TInt SetInputLanguage(TInt aInputLanguage = -1);

   285 

   286     /**

   287      * Set permitted range

   288      *

   289      * @since S60 v3.2

   290      * @param aRange The new value

   291      * @return None.

   292      */         

   293     void SetPermittedRange(TInt aRange);

   294 

   295     /**

   296      * Set current range

   297      *

   298      * @since S60 v3.2

   299      * @param aPosition The new value

   300      * @return None.

   301      */         

   302     void SetCurrentRange(TInt aRange);

   303     

   304     /**

   305      * Set data query rect

   306      *

   307      * @since S60 v3.2

   308      * @param aRect The rect of data query

   309      * @return None.

   310      */         

   311     void SetDataQueryRect(const TRect& aRect);

   312     

   313     /**

   314      * Set current accent

   315      *

   316      * @since S60 v3.2

   317      * @param aAccent The new value

   318      * @return None.

   319      */         

   320     void SetCurrentAccent(TInt aAccent);    

   321     

   322     /**

   323      * Set editor numbric keymap

   324      *

   325      * @since S60 v3.2

   326      * @param aEditorNumericKeymap The new value

   327      * @return None.

   328      */         

   329     void SetEditorNumericKeymap(TInt aEditorNumericKeymap);

   330 

   331     /**

   332      * Set input method layout

   333      *

   334      * @since S60 v3.2

   335      * @param aImLayout The new value

   336      * @return None.

   337      */         

   338     void SetImLayout(TInt aImLayout);

   339 

   340     /**

   341      * Change shift down flag

   342      *

   343      * @since S60 v3.2

   344      * @return New case.

   345      */         

   346     TInt ChangeShiftDown();

   347     

   348     /**

   349      * Change capslock down flag

   350      *

   351      * @since S60 v3.2

   352      * @return New case.

   353      */          

   354     TInt ChangeCapslockDown();

   355     

   356     /**

   357      * Set shift down flag

   358      *

   359      * @since S60 v3.2

   360      * @param aFlag The new value

   361      * @return None.

   362      */         

   363     void SetShiftDown(TBool aFlag);

   364         

   365     /**

   366      * Set capslock down flag

   367      *

   368      * @since S60 v3.2

   369      * @param aFlag The new value

   370      * @return None.

   371      */          

   372     void SetCapslockDown(TBool aFlag);

   373     

   374     /**

   375      * Set length when button down on backspace button

   376      *

   377      * @since S60 v3.2

   378      * @param aLength The new value

   379      * @return None.

   380      */        

   381     void SetLengthWhenButtondownOnBack(TInt aLength);

   382     

   383     /**

   384      * Shift button permit or not

   385      *

   386      * @since S60 v3.2

   387      * @return ETrue if shift button permit, or EFalse.

   388      */         

   389     TBool IsShiftPermitted();

   390     TBool IsCapsLockPermitted();

   391     /**

   392      * Set screen mode

   393      *

   394      * @since S60 v3.2

   395      * @param aScreenMode The new value

   396      * @return None.

   397      */         

   398     void SetScreenMode(const TPixelsTwipsAndRotation& aScreenMode);

   399 

   400     /**

   401      * Save window position

   402      *

   403      * @since S60 v3.2

   404      * @param aBr The new value

   405      * @return None.

   406      */         

   407     void SaveWindowPos(const TPoint& aBr);

   408 

   409     /**

   410      * Save range

   411      *

   412      * @since S60 v3.2

   413      * @param aRange The new value

   414      * @return None.

   415      */    

   416     void SaveRange(TInt aRange);

   417 

   418     /**

   419      * Handle notification from CenRep monitor

   420      *

   421      * @since S60 v3.2

   422      * @param aPtr The data manager self

   423      * @return None.

   424      */         

   425     static TInt HandleFepRepositoryCallBack(TAny* aPtr);

   426     

   427     /**

   428      * Handle notification from CenRep monitor

   429      *

   430      * @since S60 v3.2

   431      * @param aPosition The data manager self

   432      * @return None.

   433      */         

   434     static TInt HandleGSRepositoryCallBack(TAny* aPtr);

   435     

   436     /**

   437      * Write window position

   438      *

   439      * @since S60 v3.2

   440      * @param aPosition The new value

   441      * @return None.

   442      */         

   443     void WriteWindowPostion(TInt aPosition);

   444     

   445     /**

   446      * Write last used range into CenRep

   447      *

   448      * @since S60 v3.2

   449      * @param aLastUsedRange The new value

   450      * @return None.

   451      */         

   452     void WriteLastUsedRange(TInt aLastUsedRange);

   453     

   454 // From class MAknFepVkbDataProvider

   455 

   456     /**

   457      * Request data according to the data type

   458      *

   459      * @since S60 v3.2

   460      * @param aDataType The data type need to get

   461      * @return candidates list.

   462      */      

   463     TInt RequestData(TAknFepDataType aDataType);   

   464      

   465     /**

   466      * Set data according to the data type

   467      *

   468      * @since S60 v3.2

   469      * @param aDataType The data type need to set

   470      * @param aData The new data

   471      * @return candidates list.

   472      */      

   473     void SetData(TAknFepDataType aDataType,TInt aData);

   474     

   475     /**

   476      * Read unit size and shadow from scalable data

   477      *

   478      * @since S60 v3.2

   479      * @return None.

   480      */      

   481     void ReadUnitShadowSize();

   482     

   483     /**

   484      * Get info of whether it is size changing

   485      *

   486      * @since S60 v3.2

   487      * @return ETrue if size is changing, otherwise EFalse

   488      */      

   489     TBool SizeChanging();

   490     

   491     /**

   492      * Get info of whether unit and shadow size have been read

   493      *

   494      * @since S60 v3.2

   495      * @return Flag to indicate whether unit and shadow size

   496      * have been read

   497      */      

   498     TBool UnitShadowSizeSet();

   499 

   500     /**

   501      * Judge if next candidate after current page exist

   502      *

   503      * @since S60 v3.2

   504      * @return ETrue if candidate exist, otherwise EFalse

   505      */      

   506     TBool NextCandidateExist();

   507      

   508     /**

   509      * Reset unit size by current im layout

   510      *

   511      * @since S60 v3.2

   512      * @return None.

   513      */      

   514     void ResetUnitSize();

   515     

   516     /**

   517      * Set flag to indicate whether it is size changing

   518      *

   519      * @since S60 v3.2

   520      * @param aFlag Whether it is size changing

   521      * @return None.

   522      */      

   523     void SetSizeChanging(TBool aFlag);

   524     

   525 protected:

   526 

   527     /**

   528      * Constructor

   529      *

   530      * @since S60 v3.2

   531      * @param aContext The layout context     

   532      * @return None.

   533      */      

   534     CAknFepVkbDataMgr(MAknFepVkbLayoutContext* aContext);

   535         

   536     /**

   537      * 2nd constructor function

   538      *

   539      * @since S60 v3.2

   540      * @return None.

   541      */      

   542     void ConstructL(CPtiEngine* aPtiEngine);  

   543     

   544     /**

   545      * Get language item according to the id

   546      *

   547      * @since S60 v3.2

   548      * @param aLangId The language id

   549      * @return The language item.

   550      */      

   551     //const SLanguageItem* GetItemByLangId(TInt aLangId);    

   552     

   553     /**

   554      * notification function when the window position is changed in CenRep

   555      *

   556      * @since S60 v3.2

   557      * @return The deal result.

   558      */      

   559     TInt PositionChangeNotification();

   560 

   561     /**

   562      * notification function when the default mode is changed in CenRep

   563      *

   564      * @since S60 v3.2

   565      * @return The deal result.

   566      */      

   567     TInt DefaultModeChangeNotification();

   568 

   569     /**

   570      * notification function when the peninput language is changed in CenRep

   571      *

   572      * @since S60 v3.2

   573      * @return The deal result.

   574      */      

   575     TInt PeninputlanguageChangeNotification();

   576     

   577     /**

   578      * Calculate case according to shiftdown and capslock down

   579      *

   580      * @since S60 v3.2

   581      * @return New case.

   582      */      

   583     TInt CalculateCase();

   584     

   585     /**

   586      * Judge if given language is Chinese

   587      *

   588      * @since S60 v3.2

   589      * @param aLang Given language code

   590      * @return ETrue if given language is Chinese, otherwise EFalse

   591      */      

   592     TBool LanguageIsChinese(TInt aLang);

   593     

   594     /**

   595      * Set engine language to given language

   596      *

   597      * @since S60 v3.2

   598      * @param aLang Given language code

   599      * @return None

   600      */      

   601     void SetEngineLanguage(TInt aLang);

   602     

   603 private: // Data

   604 

   605     /**

   606      * The case

   607      * Own

   608      */

   609     TInt iCase;

   610     

   611     /**

   612      * The last used range

   613      * Own

   614      */    

   615     TInt iLastUsedRange;

   616     

   617     /**

   618      * The peninput language

   619      * Own

   620      */    

   621     TInt iInputLanguage;

   622 

   623     /**

   624      * The permitted range

   625      * Own

   626      */    

   627     TInt iPermittedRange;

   628     TInt iPermittedCase;

   629 

   630     /**

   631      * The candidate count

   632      * Own

   633      */    

   634     TInt iCandidatesCount;

   635     

   636     /**

   637      * The current range

   638      * Own

   639      */    

   640     TInt iCurrentRange; 

   641        

   642     /**

   643      * The current accent

   644      * Own

   645      */    

   646     TInt iCurrentAccent;

   647     

   648     /**

   649      * The unit width

   650      * Own

   651      */    

   652     TInt iUnitWidth;

   653     

   654     /**

   655      * The unit height

   656      * Own

   657      */    

   658     TInt iUnitHeight;

   659     

   660     /**

   661      * The im layout

   662      * Own

   663      */    

   664     TInt iImLayout; 

   665 

   666     /**

   667      * The default im layout for HK

   668      * Own

   669      */    

   670     TInt iDefaultImLayout4HK;

   671     

   672     /**

   673      * The default im layout for PRC

   674      * Own

   675      */    

   676     TInt iDefaultImLayout4PRC;

   677     

   678     /**

   679      * The default im layout for TW

   680      * Own

   681      */    

   682     TInt iDefaultImLayout4TW;

   683 

   684     //TAknEditorNumericKeymap iEditorNumericKeymap;

   685     /**

   686      * The editor numeric key map

   687      * Own

   688      */    

   689     TInt iEditorNumericKeymap;

   690 

   691     /**

   692      * The flag of shift down

   693      * Own

   694      */    

   695     TBool iShiftDown;

   696     

   697     /**

   698      * The flag of capslock down

   699      * Own

   700      */    

   701     TBool iCapslockDown;

   702     

   703     /**

   704      * The string length in composition field when mouse down on back button

   705      * Own

   706      */    

   707     TInt iLengthWhenButtondownOnBack;

   708     

   709     /**

   710      * The candidate list

   711      * Own

   712      */    

   713     RPointerArray<HBufC> iCandidates;

   714     

   715     /**

   716      * The pti engine

   717      * Ownership is deternimed by 

   718      */    

   719     CPtiEngine* iPtiEngine;

   720     

   721     /**

   722      * The pti engine ownership flag

   723      */    

   724     TBool iOwnPtiEngine;

   725     

   726     /**

   727      * The layout context

   728      * Not wwn

   729      */    

   730     MAknFepVkbLayoutContext* iContext;

   731     

   732     /**

   733      * The language string list

   734      * Own

   735      */    

   736     //RPointerArray<SLanguageItem> iLangStringList;

   737     

   738     /**

   739      * The fep repository (Own);

   740      */

   741     CRepository* iFepRepository;

   742     

   743     /**

   744      * The repository watcher

   745      * Own

   746      */    

   747     CAknFepRepositoryWatcher* iFepRepositoryWatcher;

   748     

   749     /**

   750      * The gs repository 

   751      * Own

   752      */

   753     CRepository* iGSRepository;

   754 

   755     /**

   756      * The repository watcher

   757      * Own

   758      */    

   759     CAknFepRepositoryWatcher* iGSRepositoryWatcher;

   760     

   761     /**

   762      * The position setting id

   763      * Own

   764      */    

   765     TInt iPositionSettingId;    

   766     

   767     /**

   768      * The window position

   769      * Own

   770      */    

   771     TInt iWindowPosition;

   772     

   773     /**

   774      * The screen mode

   775      * Own

   776      */    

   777     TPixelsTwipsAndRotation iScreenMode;

   778 

   779     /**

   780      * The rect of data query dialog

   781      * Own

   782      */    

   783     TRect iDataQueryRect;    

   784 

   785     /**

   786      * The user defined resource for number

   787      * Own

   788      */    

   789     HBufC* iUserDefinedResource;    

   790     

   791     /**

   792      * The predictive buffer

   793      * Own

   794      */    

   795     TBuf<KMaxLengthPredictiveString> iPredictiveBuf;

   796     

   797     /**

   798      * The array of units size

   799      * Own

   800      */    

   801     RArray<TSize> iUnits;

   802     

   803     /**

   804      * Flag of size changing

   805      */    

   806     TBool iSizeChanging;

   807     

   808     /**

   809      * The size of top left shadow corner

   810      */

   811     TSize iShadowTl;

   812     

   813     /**

   814      * The size of bottom right shadow corner

   815      */

   816     TSize iShadowBr;

   817     

   818     /**

   819      * The rect of main pane

   820      */

   821     TRect iMainPaneRect;

   822     

   823     /**

   824      * Indicate whether unit, shadow size have been read

   825      */

   826     TBool iUnitShadowSizeRead;

   827     

   828     TBool iNeedBrJustify;

   829     };

   830 

   831 #endif // C_AKNFEPVKBDATAMGR_H

   832 

   833 // End Of File

   834