1 /*

     2 * Copyright (c) 2009-2010 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:  header of main window of finger hwr.

    15 *

    16 */

    17 

    18 

    19 #ifndef C_PENINPUTFINGERHWRARWND_H

    20 #define C_PENINPUTFINGERHWRARWND_H

    21 

    22 // INCLUDES

    23 #include <peninputlayoutctrlgroup.h>

    24 

    25 // FORWARD DECLARATIONS

    26 class CFepLayoutMultiLineIcf;

    27 class CAknFepCtrlEventButton;

    28 class CAknFepCtrlRepeatButton;

    29 class CFepCtrlDropdownList;

    30 class CPeninputFingerHwrArLafManager;

    31 class CPeninputArabicFingerHwrSymbolTable;

    32 class CPeninputArabicFingerHwrIndicator;

    33 class CPeninputArabicFingerHwrWritingWnd;

    34 class CPeninputArabicFingerHwrNumSymbolTable;

    35 

    36 /**

    37  *  class CPeninputFingerHwrArWnd.

    38  *

    39  *  Main window of finger hwr arabic. 

    40  *

    41  *  @lib peninputfingerhwrar.lib

    42  *  @since Symbian TB9.2

    43  */

    44 class CPeninputFingerHwrArWnd : public CControlGroup

    45     {   

    46 public:

    47 

    48     /**

    49      * Symbian constructor.

    50      *

    51      * @since Symbian TB9.2

    52      * 

    53      * @param aUiLayout The layout

    54      * @param aControlId The control id

    55      * @param aLandscapeStyle Current screen is landscape or not

    56      * @return Pointer to created CPeninputFingerHwrArWnd object

    57      */

    58     static CPeninputFingerHwrArWnd* NewL( CFepUiLayout* aFepUiLayout,

    59             TInt aControlId, TBool aLandscapeStyle );

    60 

    61     /**

    62      * Symbian constructor.

    63      *

    64      * @since Symbian TB9.2

    65      * 

    66      * @param aUiLayout The layout

    67      * @param aControlId The control id

    68      * @param aLandscapeStyle Current screen is landscape or not

    69      * @return Pointer to created CPeninputFingerHwrArWnd object

    70      */

    71     static CPeninputFingerHwrArWnd* NewLC( CFepUiLayout* aFepUiLayout,

    72             TInt aControlId, TBool aLandscapeStyle );

    73 

    74     /**

    75      * standard c++ destructor.

    76      *

    77      * @since Symbian TB9.2

    78      * @return None

    79      */

    80     virtual ~CPeninputFingerHwrArWnd();

    81 

    82     

    83 public: //from base class CFepUiBaseCtrl

    84     /**

    85      * From CFepUiBaseCtrl.

    86      * Construct from resource. Handle resource change.

    87      *

    88      * @since S60 v4.0

    89      */

    90     void ConstructFromResourceL();

    91     

    92     /**

    93      * From CFepUiBaseCtrl

    94      * Draw control

    95      *

    96      * @since S60 V4.0

    97      */      

    98     void Draw();

    99     

   100 public: 

   101     /**

   102      * Resize according to LAF.

   103      *

   104      * @since Symbian TB9.2

   105      * @return None

   106      */

   107     void SizeChangedL();

   108 	

   109 public: // target editor attributes

   110     /**

   111      * accept editor's text alignment.  

   112      * 

   113      * @since Symbian TB9.2

   114      * @param aAlignment text alignment id. It can be one of the following: 

   115      *     EAknEditorAlignNone

   116      *     EAknEditorAlignCenter

   117      *     EAknEditorAlignLeft

   118      *     EAknEditorAlignRight

   119      *     EAknEditorAlignBidi

   120      * @param aLangId language id

   121      * @return none

   122      */ 

   123     void SetTextAlignmentL( TInt aAlignment, TInt aLangId );

   124     

   125     /**

   126      * accept editor's text.

   127      * 

   128      * @since Symbian TB9.2

   129      * @param aData editor's text.

   130      * @return none

   131      */

   132     void SetEditorTextL( const TFepInputContextFieldData& aData );

   133     

   134     /**

   135      * accept editor's promopt txt

   136      * 

   137      * @since Symbian TB9.2

   138      * @param aPromoptData editor's promopt text

   139      * @return none

   140      */    

   141     void SetPromptTextL( TUint8* aPromoptData );

   142     

   143     /**

   144      * Dim option button

   145      * 

   146      * @since Symbian TB9.2

   147      * @param aEnable Enable or disable option button

   148      * @return none

   149      */    

   150     void SetEnableSettingBtn(const TBool aEnable);

   151     

   152     /**

   153      * accept editor's bubble text.

   154      * 

   155      * @since Symbian TB9.2

   156      * @param aPromoptData editor's bubble text.

   157      * @return none

   158      */       

   159     void SetBubbleTextL( const TDesC& aInfo );    

   160 

   161 public: //hwr 

   162     

   163     /**

   164      * get strokes from hwr writing box

   165      * 

   166      * @since Symbian TB9.2

   167      * @return a TPoint array of strokes

   168      */

   169     const RArray<TPoint>& StrokeList();

   170 

   171     /**

   172      * set end mark of hwr

   173      * 

   174      * @since Symbian TB9.2

   175      * @param aEndMark a TPoint object as end mark

   176      * @return none

   177      */

   178     void SetStrokeEndMark( const TPoint& aEndMark );

   179     

   180     /**

   181      * set guide line on or off. 

   182      * 

   183      * @since Symbian TB9.2

   184      * @return none

   185      */

   186     void SetGuideLineOn( const TBool aGuideLineOn);

   187     

   188     /**

   189      * set pen color of hwr writing 

   190      * 

   191      * @since Symbian TB9.2

   192      * @return none

   193      */

   194     void SetBoxPenColor( const TInt aPenColor );

   195     

   196     /**

   197      * set pen size of hwr writing 

   198      * 

   199      * @since Symbian TB9.2

   200      * @return none

   201      */

   202     void SetBoxPenSize( const TSize aPenSize );

   203     

   204     /**

   205      * set writing speed hwr writing 

   206      * 

   207      * @since Symbian TB9.2

   208      * @return none

   209      */    

   210     void SetBoxWritingSpeed( TTimeIntervalMicroSeconds32& aCharDelay );

   211     

   212     /**

   213      * retrieve rect of hwr writingbox.

   214      * 

   215      * @since Symbian TB9.2

   216      * @return rect of hwr writingbox.

   217      */

   218     TRect WritingBoxRect();

   219     

   220     /**

   221      * Cancel wrting

   222      *

   223      * @since Symbian TB9.2

   224      * @return None

   225      */

   226     void CancelWriting();    

   227 

   228 public: // show symbol table page

   229     

   230     /**

   231      * Change symbol table page.

   232      * 

   233      * @since Symbian TB9.2

   234      * @param aPageNo page no.

   235      * @param aPos Specifies the interpretation of the aPageNo parameter:

   236             EPagePosPageNo - go to page aPageNo.

   237             EPagePosNextPage -  go to next page.

   238             EPagePosPrevPage -  go to previous page.

   239             EPagePosLastPage -  go to last page.

   240             EPagePosFirstPage  - go to first page.

   241      * @return none

   242      */

   243     void ShowSymbolPage( TInt aPageNo, TInt aPos );

   244     /**

   245      * accept editor's number mapping restriction.

   246      * 

   247      * @since S60 v5.0

   248      * @param aNumMapping a string contains numbers and related char. max length is 16.

   249      * @return none

   250      */

   251     void SetNumericMapping( const TDesC& aNumMapping );

   252 

   253 

   254 public: //child control access

   255     

   256     /**

   257      * retrieve the ICF control. 

   258      * 

   259      * @since Symbian TB9.2

   260      * @return pointer to ICF

   261      */

   262     CFepLayoutMultiLineIcf* Icf();

   263 

   264     

   265     /**

   266      * retrieve the candicate list control. 

   267      * 

   268      * @since Symbian TB9.2

   269      * @return pointer to candicate list 

   270      */    

   271     CFepCtrlDropdownList* CandidateList();

   272     

   273 //    /**

   274 //     * retrieve the number candicate list control. 

   275 //     * 

   276 //     * @since Symbian TB9.2

   277 //     * @return pointer to candicate list 

   278 //     */    

   279 //    CFepCtrlDropdownList* NumCandidateList();

   280 	

   281     /**

   282      * dim arrow buttons

   283      * 

   284      * @since Symbian TB9.2

   285      * @param aDimArrow ETrue to dim arrow buttons, EFalse to set arrow buttons as not dimmed. 

   286      * @return none

   287      */

   288     void DimArrowKeys( TBool aDimArrow );

   289     

   290 public: // symbol table & candidate list    

   291     /**

   292      * Show preview bubble

   293      * 

   294      * @since Symbian TB9.2

   295      * @param aShow Show/Hide flag

   296      * @return none

   297      */

   298     void ShowBubble(TInt aShow);

   299 	

   300 	/**

   301      * Open the symble table

   302      * 

   303      * @since Symbian TB9.2

   304      * @return none

   305      */

   306     void OpenSymbolTable();

   307     

   308 	/**

   309      * Close the symble table

   310      * 

   311      * @since Symbian TB9.2

   312      * @return none

   313      */

   314 	void CloseSymbolTable();

   315 	

   316 	/**

   317      * Open the candidate list

   318      * 

   319      * @since Symbian TB9.2

   320      * @return none

   321      */

   322 	void OpenCandidateList();

   323 	

   324 	/**

   325      * Close the candidate list

   326      * 

   327      * @since Symbian TB9.2

   328      * @return none

   329      */

   330 	void CloseCandidateList();

   331 	

   332 	/**

   333      * Check if the symbol table is alreay opened up

   334      * 

   335      * @since Symbian TB9.2

   336      * @return ETrue if the symbol table was already opened up, EFalse otherwise

   337      */

   338     TBool IsSymbolTableShowingUp();

   339 	

   340 

   341     /**

   342      * Check if the candidate list was opened up

   343      * 

   344      * @since Symbian TB9.2

   345      * @return ETrue if the candidate list was already opened up, EFalse otherwise

   346      */

   347 	TBool IsCandidateShowup();

   348 

   349     /**

   350      * Hide the indicator of handwriting

   351      * @since Symbian TB9.2

   352      * @return none	 

   353      */

   354     void HideIndicator();

   355 	

   356 	/**

   357 	 * Get the char before the cursor

   358 	 *

   359 	 * @param aCharPos The the char position

   360 	 * @param aCharBeforeCursor The char to be retrieved

   361 	 * @since Symbian TB9.2

   362      * @return TBool ETrue if char have been retrieved, EFalse otherwise

   363 	 */

   364 	TBool GetCharBeforeCursor(TInt aCharPos, TUint16& aCharBeforeCursor); 

   365 	

   366 	/**

   367 	 * Handle window open

   368 	 */

   369 	void HandleWindowOpenCommandL();

   370     /*

   371      * set arabic number mode.

   372      * @since s60 v5.2

   373      * @param aIsNativeNumMode a flag to indicate whether it is native number mode.

   374      * @return none.

   375      */

   376     void SetNativeNumMode(const TBool aIsNativeNumMode);

   377     

   378     /*

   379      * set icf language.

   380      * @since s60 v5.2

   381      * @param aLang language id.

   382      * @return none.

   383      */

   384     void SetIcfLanguage( TInt aLang );    

   385 protected:

   386 

   387     /**

   388      * C++ constructor

   389      *

   390      * @since Symbian TB9.2

   391      * @param aFepUiLayout A Ui Layout environment (CFepUiLayout)

   392      * @param aControlId Control id

   393      * @return None

   394      */

   395     CPeninputFingerHwrArWnd( CFepUiLayout* aFepUiLayout, TInt aControlId );

   396 

   397 private:

   398 

   399     /**

   400      * Symbian second-phase constructor

   401      *

   402      * @since Symbian TB9.2

   403      * @param aLandscapeStyle Current screen is landscape or not

   404      * @return None

   405      */

   406     void ConstructL( TBool aLandscapeStyle );

   407 

   408     /**

   409      * create icf.

   410      * 

   411      * @since Symbian TB9.2

   412      * @return None

   413      */

   414     void CreateContextFieldL();

   415 

   416     /**

   417      * create candidate lists.

   418      * 

   419      * @since Symbian TB9.2

   420      * @return None

   421      */

   422     void CreateCandidateListL();

   423 //    /**

   424 //     * create number candidate lists.

   425 //     * 

   426 //     * @since Symbian TB9.2

   427 //     * @return None

   428 //     */

   429 //    void CreateNumCandidateListL();

   430     

   431     /**

   432      * create writing box.

   433      * 

   434      * @since Symbian TB9.2

   435      * @return None

   436      */    

   437     void CreateWritingBoxL();

   438     

   439     /**

   440      * create all function buttons. 

   441      * 

   442      * @since Symbian TB9.2

   443      * @return None

   444      */    

   445     void CreateButtonsL();

   446     

   447     /**

   448      * create virtual sct pad.

   449      * 

   450      * @since Symbian TB9.2

   451      * @return None

   452      */    

   453     void CreateSymbolTableL();

   454     

   455     /**

   456      * create virtual number modesct pad.

   457      * 

   458      * @since Symbian TB9.2

   459      * @return None

   460      */    

   461     void CreateNumSymbolTableL();

   462     

   463     /**

   464      * EventButton creation helper.

   465      * 

   466      * @since Symbian TB9.2

   467      * @param aCtrlId button control id.

   468      * @param aResId resource id.

   469      * @param aEvent event id;

   470      * @param aUnicode a unicode value to be sent

   471      * @return pointer to created CAknFepCtrlEventButton obj.

   472      */    

   473     CAknFepCtrlEventButton* CreateEventBtnL( TInt aCtrlId, TInt32 aResId, 

   474             TInt aEvent = 0xFFFF, TInt aUnicode=0 );

   475     

   476     /**

   477      * RepeatButton creation helper.

   478      * 

   479      * @since Symbian TB9.2

   480      * @param aCtrlId button control id.

   481      * @param aResId resource id.

   482      * @param aEvent event id;

   483      * @param aUnicode a unicode value to be sent

   484      * @return pointer to created CAknFepCtrlRepeatButton obj. 

   485      */

   486     CAknFepCtrlRepeatButton* CreateRepBtnL( const TInt aCtrlId, TInt32 aResId,  

   487             const TInt aEvent, const TInt aUnicode );

   488         

   489     /**

   490      * load virtual sct keys.

   491      * 

   492      * @since Symbian TB9.2

   493      * @param aResId resource id.

   494      * @param aCellRects rects of virtual keys.

   495      * @return None

   496      */      

   497     void LoadSymbolVirtualKeysL( const TInt aResId, const RArray<TRect>& aCellRects );

   498 

   499     /**

   500      * load virtual number mode sct keys.

   501      * 

   502      * @since Symbian TB9.2

   503      * @param aResId resource id.

   504      * @param aCellRects rects of virtual keys.

   505      * @return None

   506      */      

   507     void LoadNumSymbolVirtualKeysL( const TInt aResId, 

   508             const RArray<TRect>& aCellRects, TBool aReload = ETrue );

   509     

   510     /**

   511      * relayout full ui, reset all controls position. 

   512      * 

   513      * @since Symbian TB9.2

   514      * @return None

   515      */    

   516     void ResetLayoutL();

   517 

   518     /**

   519      * switch to arabic standby view

   520      * 

   521      * @since Symbian TB9.2

   522      * @return None

   523      */    

   524     void SwitchToStandbyView();

   525     

   526     /**

   527      * switch to symbol table view

   528      * 

   529      * @since Symbian TB9.2

   530      * @return None

   531      */    

   532     void SwitchToSymbolTableView();

   533 

   534     /**

   535      * EventButton layout helper. Move button to specified rect.

   536      * 

   537      * @since Symbian TB9.2

   538      * @param aButton the button to move

   539      * @param aRect new rect of button

   540      * @param aXPadding horz padding of button icon.

   541      * @param aYPadding vert padding of button icon.

   542      * @param aReloadImages Specifies whether the images is to be reloaded.

   543      * @return None

   544      */    

   545     void MoveIconButton( CAknFepCtrlEventButton* aButton, const TRect& aRect, 

   546             TInt aXPadding=0, TInt aYPadding=0, TBool aReloadImages=ETrue );

   547 

   548     /**

   549      * read control's shadow info.

   550      * 

   551      * @since Symbian TB9.2

   552      * @param aResId resource id.

   553      * @return None

   554      */    

   555     void ReadShadowInfoL( const TInt aResId );

   556     

   557     /**

   558      * read control's background info.

   559      *

   560      * @since Symbian TB9.2

   561      * @param aResId resource id.

   562      * @return None

   563      */

   564     void ReadBackgroundInfoL( const TInt aResId );

   565     

   566     /**

   567      * read icf appearance info.

   568      * 

   569      * @since Symbian TB9.2

   570      * @param aResId resource id.

   571      * @return None

   572      */    

   573     void ReadICFInfoL( const TInt aResId );

   574     

   575     /**

   576      * read writingbox appearance info.

   577      * 

   578      * @since Symbian TB9.2

   579      * @param aResId resource id.

   580      * @return None

   581      */    

   582     void ReadWritingBoxInfoL( TInt aResId );

   583     

   584 	/**

   585 	 * Calcaulate the postion of guideline

   586 	 * @since Symbian TB9.2

   587 	 * @return None

   588 	 */

   589     void CalculateGuideLinePos();

   590 	

   591 	/**

   592 	 * Draw the guideline

   593 	 * @since Symbian TB9.2

   594 	 * @return None

   595 	 */

   596     void DrawGuideLine();

   597 

   598 private: // datas

   599 

   600     /**

   601      * Input context field control.

   602      * Not own.

   603      */

   604     CFepLayoutMultiLineIcf* iContextField;

   605 

   606 

   607     /**

   608      * Candidate list control.

   609      * Not own.

   610      */    

   611     CFepCtrlDropdownList* iCandidateList;

   612     

   613     

   614     /**

   615      * Writing box control.

   616      * Not own.

   617      */

   618     CPeninputArabicFingerHwrWritingWnd* iWritingBox;

   619 

   620     /**

   621      * Close button control.

   622      * Not own.

   623      */    

   624     CAknFepCtrlEventButton* iCloseBtn;

   625 

   626     /**

   627      * Option button control.

   628      * Not own.

   629      */     

   630     CAknFepCtrlEventButton* iOptionBtn;

   631     

   632     /**

   633      * Ime switch button control.

   634      * Not own.

   635      */     

   636     CAknFepCtrlEventButton* iImeSwitchBtn;

   637 

   638     /**

   639      * Backspace button control.

   640      * Not own.

   641      */     

   642     CAknFepCtrlRepeatButton* iBackspaceBtn;

   643 

   644     /**

   645      * Left arrow button control.

   646      * Not own.

   647      */     

   648     CAknFepCtrlRepeatButton* iArrowLeftBtn;

   649     

   650     /**

   651      * Right arrow button control.

   652      * Not own.

   653      */     

   654     CAknFepCtrlRepeatButton* iArrowRightBtn;

   655     

   656     /**

   657      * Up arrow button control.

   658      * Not own.

   659      */     

   660     CAknFepCtrlRepeatButton* iArrowUpBtn;

   661     

   662     /**

   663      * Down arrow button control.

   664      * Not own.

   665      */     

   666     CAknFepCtrlRepeatButton* iArrowDownBtn;

   667     /**

   668      * Sct selection button control.

   669      * Not own.

   670      */     

   671     CAknFepCtrlEventButton* iSymbolTableBtn;

   672     /**

   673      * enter button control.

   674      * Not own.

   675      */     

   676     CAknFepCtrlEventButton* iEnterBtn;

   677     /**

   678      * space button control.

   679      * Not own.

   680      */     

   681     CAknFepCtrlEventButton* iSpaceBtn;

   682     

   683     /**

   684      * Symbol table control.

   685      * Not own.

   686      */     

   687     CPeninputArabicFingerHwrSymbolTable* iSymbolTable;

   688 

   689     /**

   690      * Number mode Symbol table control.

   691      * Not own.

   692      */     

   693     CPeninputArabicFingerHwrNumSymbolTable* iNumSymbolTable;

   694     

   695     /**

   696      * L&F manager.

   697      * Own.

   698      */

   699     CPeninputFingerHwrArLafManager* iLafManager;    

   700 

   701     /**

   702      * First time construct flag

   703      */

   704     TBool iFirstTimeConstruct;

   705 

   706     /**

   707      * bit mask of permitted char ranges.

   708      */

   709     TInt iPermittedRanges;

   710 	

   711     /**

   712 	 * Right Bottom point of guideline

   713 	 */

   714 	TPoint iGuideLineBottomTl;

   715 	

   716 	/**

   717 	 * Right Bottom point of guideline

   718 	 */

   719     TPoint iGuideLineBottomBr;

   720     

   721 	/**

   722 	 * Check if the symbol table has been opened up

   723 	 */

   724 	TBool iIsSymbolTableShowingUp;

   725 

   726     /**

   727      * Check if the guideline is switched on

   728      */	 

   729     TBool iGuideLineOn;

   730 

   731 	/**

   732 	 * Handwring indicator

   733 	 */

   734 	CPeninputArabicFingerHwrIndicator* iHandwritingIndicator; 

   735     };

   736 

   737 #endif // C_PENINPUTFINGERHWRARWND_H

   738 // End Of File