1 /*

     2 * Copyright (c) 2005-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:  common layout window class

    15 *

    16 */

    17 

    18 

    19 #ifndef C_CPENINPUTLAYOUTWINDOWEXT_H

    20 #define C_CPENINPUTLAYOUTWINDOWEXT_H

    21 

    22 // System includes

    23 #include <peninputbasewindowext.h>

    24 

    25 // User includes

    26 #include "peninputctrlpool.h"

    27 #include "peninputlayoutconfig.h"

    28 #include "peninputcommonlayoutglobalenum.h"

    29 

    30 // Forward declarations

    31 class CFepUiLayout;

    32 class CFepInputContextField;

    33 class CAknFepCtrlEventButton;

    34 class MPeninputLayoutContext;

    35 class CPeninputLayoutConfig;

    36 class CPeninputNumericKepMappingMgr;

    37 

    38 /**

    39  *  Common pen input layout window class.

    40  *  This class define the common behaviors of VKB layout window and 

    41  *  HWR layout window.

    42  *

    43  *  @lib peninputcommonlayout.lib

    44  *  @since S60 v3.2

    45  */

    46 class CPeninputLayoutWindowExt : public CAknFepCtrlBaseWindowExt

    47     {

    48 

    49 public:

    50 

    51     /**

    52      * Destructor

    53      *

    54      * @since S60 v3.2

    55      * @return None

    56      */

    57     IMPORT_C virtual ~CPeninputLayoutWindowExt();

    58 

    59     /**

    60      * Get layout config

    61      *

    62      * @since S60 v3.2

    63      * @return The pointer to CPeninputLayoutConfig object

    64      */

    65     IMPORT_C CPeninputLayoutConfig* ConfigInfo() const;

    66 

    67     /**

    68      * Change input language

    69      *

    70      * @since S60 v3.2

    71      * @param aLangID The new language id

    72      * @return None

    73      */

    74     IMPORT_C void ChangeInputLanguageL( TInt aLangID );

    75 

    76     /**

    77      * Change range

    78      *

    79      * @since S60 v3.2

    80      * @param aRange The destination range

    81      * @return None

    82      */     

    83     IMPORT_C void ChangeRange( TInt aRange, TInt aVkbLayoutId = 0, TBool aNotify = ETrue );

    84    

    85     /**

    86      * Set the input context field text

    87      *

    88      * @since S60 v3.2

    89      * @param aData The data of type TFepInputContextFieldData to be set

    90      * @return None

    91      */          

    92     IMPORT_C void SetEditorTextL( const TFepInputContextFieldData& aData );

    93     

    94     /**

    95      * Set if the input context field text is secret

    96      *

    97      * @since S60 v3.2

    98      * @param aData The flag

    99      * @return None

   100      */          

   101     IMPORT_C void SetTextIsSecret( TBool aData );

   102 

   103     void SetNumberGrouping(TBool aData);

   104 

   105     /**

   106      * Method for size changing of the window

   107      *

   108      * @since S60 v3.2

   109      * @param aLandscapeStyle The flag that specify the window style is 

   110      *  landscape or portrait

   111      * @return None

   112      */

   113     IMPORT_C virtual void SizeChanged( TBool aLanscapeStyle );

   114     

   115     /**

   116      * Handle control event 

   117      *

   118      * @since S60 v3.2

   119      * @param aEventType The event type

   120      * @param aCtrl The control who sends the event

   121      * @param aEventData The event data

   122      * @return None

   123      */     

   124     IMPORT_C virtual void HandleControlEvent( TInt aEventType, 

   125                                               CFepUiBaseCtrl* aCtrl, 

   126                                               const TDesC& aEventData );  

   127 

   128     /**

   129      * Change client area layout

   130      *

   131      * @since S60 v3.2

   132      * @param aClientLayoutId The id of client area layout

   133      * @return None

   134      */

   135     IMPORT_C void ChangeClientLayout( TInt aClientLayoutId );

   136     

   137     /**

   138      * Change vkb area layout

   139      *

   140      * @since S60 v3.2

   141      * @param aVkbLayoutId The id of vkb area layout

   142      * @return None

   143      */     

   144     IMPORT_C void ChangeVkbLayout( TInt aVkbLayoutId );  

   145     

   146     /**

   147      * Get id of window config resource

   148      *

   149      * @since S60 v3.2

   150      * @return The id of window config resource

   151      */

   152     virtual TInt GetWindowConfigResId() = 0;

   153 

   154     /**

   155      * Get id of window resource

   156      *

   157      * @since S60 v3.2

   158      * @return The id of window resource

   159      */ 

   160     virtual TInt GetWindowResId() = 0;

   161 

   162     /**

   163      * Get file name of window config resource

   164      *

   165      * @since S60 v3.2

   166      * @param aLangID The id of language

   167      * @return The file name of window config resource

   168      */ 

   169     virtual const TDesC& 

   170         GetWindowConfigResFileName( TInt aLangID ) = 0;

   171 

   172     /**

   173      * Get file name of window resource

   174      *

   175      * @since S60 v3.2

   176      * @return The file name of window resource

   177      */ 

   178     virtual const TDesC& GetWindowResFileName() = 0;

   179     

   180     /**

   181      * Change unit size

   182      *

   183      * @since S60 v3.2

   184      * @return The rect of whole window

   185      */

   186 	virtual const TRect ChangeUnitSize() = 0;

   187   

   188     /**

   189      * Change size of client area

   190      *

   191      * @since S60 v3.2

   192      * @param aLeftTopPoint The left top point of client area

   193      * @return None

   194      */

   195     virtual void ChangeClientSize() = 0; 

   196     

   197     /**

   198      * Construct all controls specified in resource(implementation will be 

   199      * postponed in subclass)

   200      *

   201      * @since S60 v3.2

   202      * @return None

   203      */

   204     virtual void CreateAllControlsL() = 0;

   205     

   206     /**

   207      * Set control fonts. Fonts info comes from resource

   208      *

   209      * @since S60 v3.2

   210      * @return None

   211      */

   212     virtual void SetControlsFont() = 0;

   213   

   214     /**

   215      * Pop up choice list

   216      *

   217      * @since S60 v3.2

   218      * @return None

   219      */

   220     virtual void PopupChoiceList() = 0;

   221   

   222     /**

   223      * Re-organize all controls in the assigned client area layout

   224      *

   225      * @since S60 v3.2

   226      * @param aClientLayoutId The id of client area layout

   227      * @return None

   228      */

   229     virtual void ReorganizeControls( TInt aClientLayoutId, TBool aNeedReset ) = 0;

   230 

   231     /**

   232      * Do when case changed

   233      *

   234      * @since S60 v3.2

   235      * @param aNewCase The new case

   236      * @return None

   237      */

   238     virtual void DoCaseChange( TInt aNewCase ) = 0;

   239     IMPORT_C virtual void OnInputLanguageChange();

   240           

   241     /**

   242      * Handler for range button clicked

   243      *

   244      * @since S60 v3.2

   245      * @param aRange The range id

   246      * @return None

   247      */

   248     IMPORT_C virtual void HandleRangeEvent( TInt aRange );

   249 

   250     /**

   251      * Handler for range loop event

   252      *

   253      * @since S60 v3.2

   254      * @param aLoop The loop id

   255      * @return None

   256      */

   257     IMPORT_C virtual void HandleRangeLoopEvent( TInt aLoop );

   258     

   259 	/**

   260      * Handler for shift and capslock merged button clicked

   261      *

   262      * @since S60 v3.2

   263      * @param aMode The mode of the mutimode button

   264      * @return None

   265      */

   266     IMPORT_C virtual void HandleMergedBtnClicked( TInt aCase );

   267     

   268     /**

   269      * Handler for shift button clicked

   270      *

   271      * @since S60 v3.2

   272      * @return None

   273      */

   274     IMPORT_C virtual void HandleShiftBtnClicked();

   275 

   276     /**

   277      * Handler for capslock button clicked

   278      *

   279      * @since S60 v3.2

   280      * @return None

   281      */

   282     IMPORT_C virtual void HandleCapslockBtnClicked();

   283     

   284     /**

   285      * Handler for shif and capslock button clicked

   286      *

   287      * @since S60 v3.2

   288      * @return None

   289      */

   290     IMPORT_C virtual void HandleShiftAndCapslockBtnClicked();

   291 

   292     /**

   293      * Draw window and shadow

   294      *

   295      * @since S60 v3.2

   296      * @return None

   297      */          

   298     IMPORT_C virtual void Draw();

   299     

   300     /**

   301      * Set if enable switch to hwr

   302      *

   303      * @since S60 v3.2

   304      * @param aEnable The enable flag

   305      * @return None

   306      */ 

   307     IMPORT_C void SetEnableSwitchToHwr(TBool aEnable);

   308     

   309     /**

   310      * Set if enable option button and language switch button

   311      *

   312      * @since S60 v3.2

   313      * @param aEnable The enable flag

   314      * @return None

   315      */ 

   316     IMPORT_C void SetEnableSettingBtn(TBool aEnable);

   317 

   318     /**

   319      * config unit size, reason may due to client layout id changed,

   320      * or screen resolution changed

   321      *

   322      * @since S60 v3.2

   323      * @param aClientLayoutId New client layout id

   324      * @return ETrue means unit size changed, otherwise EFalse

   325      */

   326     IMPORT_C virtual TBool ReconfigUnitSize(TInt aClientLayoutId);

   327     

   328     /**

   329      * Get numeric keymapping resource id

   330      *

   331      * @since S60 v3.2

   332      * @return The id of numeric keymapping

   333      */ 

   334     virtual TInt GetNumKeymappingResId() = 0;

   335     

   336     IMPORT_C void CPeninputLayoutWindowExt::SetTextAlignmentL( TInt aAlignment );

   337        

   338     /**

   339      * Unlatch the dead key for all kinds of vkb layout

   340      *

   341      * @since S60 v5.0

   342      * @param none

   343      * @return void

   344      */

   345     void CancelDeadKey();

   346     

   347 protected:

   348 

   349     /**

   350      * constructor

   351      *

   352      * @since S60 v3.2

   353      * @param aUiLayout The pointer to CFepUiLayout object

   354      * @param aLayoutContext The pointer to MPeninputLayoutContext

   355      * @return None

   356      */

   357     IMPORT_C CPeninputLayoutWindowExt( CFepUiLayout* aUiLayout, 

   358                                     MPeninputLayoutContext* aLayoutContext );

   359 

   360     /**

   361      * Second-phase constructor

   362      *

   363      * @since S60 v3.2

   364      * @return None

   365      */ 

   366     IMPORT_C void ConstructL();

   367     /**

   368      * From CAknFepCtrlBaseWindow

   369      * Close window

   370      *

   371      * @since S60 v3.2

   372      * @return The TBool indicating the result of close operation

   373      */ 

   374     IMPORT_C TBool DoClose();

   375     

   376     /**

   377      * Construct from resource file

   378      *

   379      * @since S60 v3.2

   380      * @param aResReader The resource reader

   381      * @param aResUtils The resource utils

   382      * @return None

   383      */     

   384     //IMPORT_C virtual void ConstructFromResourceL( 

   385                                      //TResourceReader& aResReader );

   386 

   387     /** 

   388      * ConstructFromResourceL load settings from resource.

   389      * Before calling this function, the resource id should be set

   390      *

   391      * @since S60 v3.2

   392      * @return None

   393      */

   394     //IMPORT_C void ConstructFromResourceL();

   395     

   396      /**

   397      * Add not owned control into the window

   398      *

   399      * @since S60 v3.2

   400      * @param aControl The control to be added

   401      * @return None

   402      */  

   403     IMPORT_C void AddNotOwnedControl( CFepUiBaseCtrl* aControl );

   404 

   405     /**

   406      * Change button status

   407      *

   408      * @since S60 v3.2

   409      * @param aIsDown The button is down or not

   410      * @param aControlId The destination button id

   411      * @return None

   412      */  

   413     

   414     IMPORT_C void ChangeButtonStatus(const TInt aIsDown, const TInt aControlId);

   415 	

   416 	/**

   417      * Change Merged shift and capslock button status

   418      *

   419      * @since S60 v3.2

   420      * @param aIsShiftCase when shift case

   421      * @param aIsCapslockCase when capslock case

   422      * @return None

   423      */  

   424     

   425 	IMPORT_C void ChangeMergedButtonStatus(	const TInt aIsShiftCase, 

   426 	    								 	const TInt aIsCapslockCase );    								 

   427 			

   428     /**

   429      * Change layout position

   430      *

   431      * @since S60 v3.2

   432      * @return The new rectangle of layout

   433      */      

   434     IMPORT_C void ChangeLayoutPosition( TInt aJustifyStyle );

   435     

   436     /**

   437      * Set the window rect

   438      *

   439      * @since S60 v3.2

   440      * @param aRect The new rect of the window

   441      * @return None

   442      */                                            

   443     IMPORT_C void SetWindowRect(const TRect& aRect);

   444 

   445     /**

   446      * Read icf bitmap from resource

   447      *

   448      * @since S60 v3.2

   449      * @param aResReader The reource reader

   450      * @return None

   451      */

   452     //IMPORT_C void ReadIcfInfo( TResourceReader aResReader );

   453     

   454     /**

   455      * Set text font for language switch button.

   456      *

   457      * @since S60 v3.2

   458      * @param aSwitchBtn Pointer to language switch button

   459      * @return None

   460      */

   461     IMPORT_C void SetSwitchBtnFont(CAknFepCtrlEventButton& aSwitchBtn);

   462     

   463     /**

   464      * Set text color for language switch button.

   465      *

   466      * @since S60 v3.2

   467      * @param aSwitchBtn Pointer to language switch button

   468      * @return None

   469      */

   470     IMPORT_C void SetSwitchBtnTextColor(CAknFepCtrlEventButton& aSwitchBtn);

   471     

   472     

   473     /**

   474      * Change size for base window, such as move button,drag button etc.

   475      *

   476      * @since S60 v3.2

   477      * @return None

   478      */

   479     IMPORT_C  virtual void SizeChangedForBaseWindow( TInt aTotalColumns ); 

   480     

   481     IMPORT_C virtual void SetLafLayOut(TInt aRows, TInt aColumns);   

   482     

   483     IMPORT_C virtual void SetVkbLayoutSize();

   484     

   485     virtual TBool CreateCustomControlL( TInt16 aControlId, TInt32 aImageId );

   486     

   487     virtual void AddCustomControlGroupL(CFepUiBaseCtrl* aCtrl);

   488 

   489 private:

   490 

   491     /**

   492      * Read laf of shadow

   493      *

   494      * @since S60 v3.2

   495      * @param aRect the parent window

   496      * @return None

   497      */

   498     void ReadLafForShadow();

   499     

   500     /**

   501      * Check whether or not the resource file exists

   502      *

   503      * @since S60 v3.2

   504      * @param aFileName The name of resource file

   505      * @return The TBool indicating existance of resource file

   506      */

   507     TBool CheckResourceExist( const TDesC& aFileName );

   508     

   509     /**

   510      * Get case decided by shift&caps status

   511      *

   512      * @since S60 v3.2

   513      * @return The case value

   514      */

   515     TInt CaseByShiftCapslockStatus();

   516     

   517     /**

   518      * Dim keys

   519      *

   520      * @since S60 v3.2

   521      * @return None

   522      */

   523     void DimKeys();

   524     void DimKeysL();    

   525     

   526     /**

   527      * Change range bar

   528      *

   529      * @since S60 v3.2

   530      * @return None

   531      */

   532     void ChangeRangeBarL();

   533     

   534     /**

   535      * Change window position

   536      *

   537      * @since S60 v3.2

   538      * @return None.

   539      */    

   540     void TopLeftJustify();

   541 

   542     /**

   543      * Change window position

   544      *

   545      * @since S60 v3.2

   546      * @return None.

   547      */    

   548     void BottomRightJustify();

   549 

   550     /**

   551      * Change window position

   552      *

   553      * @since S60 v3.2

   554      * @return None.

   555      */    

   556     void DataQueryJustify();

   557         

   558     /**

   559      * Get key mapping string from resource or user defined mappings

   560      *

   561      * @since S60 v3.2

   562      * @param aKeyMapping The key mapping enum

   563      * @return None.

   564      */    

   565     HBufC* GetKeyMappingStringL( TInt aKeyMapping, const TInt aLang );

   566     

   567     void ResetLastColRow();

   568 protected: // data

   569 

   570     /**

   571      * The layout config

   572      * Own

   573      */    

   574     CPeninputLayoutConfig* iConfigInfo;

   575 

   576     /**

   577      * The layout context

   578      * Not own

   579      */

   580     MPeninputLayoutContext* iLayoutContext;        

   581 

   582     /**

   583      * The numeric kep mapping manager

   584      * Own

   585      */        

   586     CPeninputNumericKepMappingMgr* iKeyMappingMgr;

   587         

   588     /**

   589      * Vkb layout

   590      * Own

   591      */ 

   592     CAknFepCtrlVkbLayout* iVkbLayout;

   593 

   594     /**

   595      * Language is changed

   596      */

   597     TBool iLangOrSizeChanged;

   598 

   599     /**

   600      * The total column for the window

   601      */

   602     TInt iLastUsedTotalColumns;

   603 

   604     TInt iLastUsedTotalRows;

   605 

   606     /**

   607      * The resource id of window

   608      */

   609     TInt iWinResId;

   610 

   611     /**

   612      * The resource id of config

   613      */

   614     TInt iConfigResId;

   615     

   616     /**

   617      * Width of top left shadow rect

   618      */

   619     TInt iShadowTlWidth;

   620 

   621     /**

   622      * Height of top left shadow rect

   623      */

   624     TInt iShadowTlHeight;

   625 

   626     /**

   627      * Width of bottom right shadow rect

   628      */

   629     TInt iShadowBrWidth;

   630 

   631     /**

   632      * Height of bottom right shadow rect

   633      */

   634     TInt iShadowBrHeight;

   635     

   636     /**

   637      * First time construct flag

   638      */

   639     TBool iFirstTimeConstruct;        

   640     

   641     /**

   642      * Switch button font id

   643      */

   644     TInt32 iSwitchFont;

   645     

   646     /**

   647      * Switch button shadow font id

   648      */

   649     TInt32 iSwitchShadowFont;

   650     

   651     /**

   652      * Indicate whether switch(shadow) font has been set

   653      */

   654     TBool iSwitchFontSet;

   655     

   656     /**

   657      * Indicate whether need size change when change unit size

   658      */

   659     TBool iUnitSizeChange;

   660     

   661     /**

   662      * Tone mark set for Viet

   663      */

   664     HBufC* iToneSet;

   665     

   666     /**

   667      * Vowel char flag for Viet

   668      */

   669     TBool iVowelChar;

   670     };

   671 #endif // C_CPeninputLayoutWindowExt_H