1 /*

     2 * Copyright (c) 2008 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:           

    15 *      Provides the TAknFepInputMiniQwertyZhuyinPhraseBase definition.

    16 *

    17 */

    18 

    19 

    20 

    21 

    22 

    23 

    24 

    25 

    26 

    27 

    28 

    29 

    30 #ifndef T_AKNFEPUIINPUTMINIQWERTYZHUYINPHRASEBASE_H

    31 #define T_AKNFEPUIINPUTMINIQWERTYZHUYINPHRASEBASE_H

    32 

    33 //#include "AknFepUiInputStateChineseBase.h"

    34 #include "AknFepUiInputStateCandidateQwertyBaseChinesePhrase.h"

    35 

    36 class TAknFepInputMiniQwertyZhuyinPhraseBase : public TAknFepInputStateCandidateQwertyBaseChinesePhrase

    37     {

    38 public:

    39     

    40     /**

    41      * C++ default constructor

    42      *

    43      * @since S60 v3.2.3

    44      * @param aOwner Pointer to UI manager state interface

    45      * @param aUIContainer Pointer to Chinese UI container

    46      */

    47     TAknFepInputMiniQwertyZhuyinPhraseBase(

    48         MAknFepUIManagerStateInterface* aOwner,

    49         MAknFepUICtrlContainerChinese* aUIContainer

    50         );

    51     

    52     /**

    53      * Handle system key press event

    54      *

    55      * @since S60 v3.2.3

    56      * @param aKey System key

    57      * @param aLength Key press length

    58      * @return ETrue if handle, otherwise this class do not handle this key

    59      */

    60     TBool HandleKeyL( TInt aKey, TKeyPressLength aLength );

    61     

    62     /**

    63      * Get the valid keystroke.

    64      *

    65      * @since S60 v3.2.3

    66      * @param None.

    67      * @return ETrue,if the valid keystroke is not null, EFalse otehrs.

    68      */

    69     TBool GetValidKeystroke();

    70     

    71     /**

    72      * Refresh editing pane

    73      *

    74      * @since S60 v3.2.3

    75      * @param None.

    76      * @return None

    77      */

    78     void RefreshEditPane();

    79     

    80     /**

    81      * Refresh spelling pane

    82      *

    83      * @since S60 v3.2.3

    84      * @param aClearSelection ETrue if need to clear current selection, otherwise EFalse.

    85      * @return None

    86      */

    87     void RefreshSpellingPane( TBool aClearSelection = EFalse );

    88     

    89     /**

    90      * Refresh candidate

    91      *

    92      * @since S60 v3.2.3

    93      * @param aClearSelection, if ETrue then clear selection of popup, others EFalse.

    94      * @return none

    95      */

    96     void RefreshCandidatePane( TBool aClearSelection = EFalse );

    97 

    98     /**

    99      * Get candidate info.

   100      *

   101      * @since S60 v3.2.3

   102      * @param aClearSelection, if ETrue then clear selection of popup, others EFalse.

   103      * @return none

   104      */

   105     void GetCandidate( TBool aClearSelection = EFalse );

   106     

   107     /**

   108      * Update indicator

   109      *

   110      * @since S60 v3.2.3

   111      * @param None

   112      * @return None.

   113      */

   114     void UpdateIndicator();

   115     

   116     /**

   117      * Change CBA.

   118      *

   119      * @since S60 v3.2.3

   120      * @param None.

   121      * @return None.

   122      */        

   123     void ChangeCbaL();

   124     

   125     /**

   126      * clear Selection

   127      *

   128      * @since S60 v5.0

   129      * @return None.

   130      */

   131     void ClearDeliberateSelection();

   132     

   133 private:

   134     

   135     /**

   136      * clear the ptiengine keystroke.

   137      *

   138      * @since S60 v3.2.3

   139      * @param None

   140      * @return None

   141      */

   142     void ClearPtiEngineKeystroke();

   143     

   144     /**

   145      * Check the spelling whether is phrase spelling.

   146      *

   147      * @since S60 v3.2.3

   148      * @param None.

   149      * @return ETrue,if one of spelling of PtiEngine is not phrase spelling, 

   150      *  EFalse others.

   151      */

   152     TBool CheckPhraseSpellingL();

   153     

   154     /**

   155      * Get the valid keystroke.

   156      *

   157      * @since S60 v3.2.3

   158      * @param None.

   159      * @return ETrue,if the valid keystroke is not null, EFalse otehrs.

   160      */

   161     TBool GetValidKeystrokeL();

   162     

   163     /**

   164      * Check whether tone mark border upon.

   165      *

   166      * @since S60 v3.2.3

   167      * @param None.

   168      * @return ETrue,if the tone mark border upon, EFalse otehrs.

   169      */

   170     TBool CheckToneMarkBorderUpon();

   171     

   172     /**

   173      * Get candidate info.

   174      *

   175      * @since S60 v3.2.3

   176      * @param aClearSelection, if ETrue then clear selection of popup, others EFalse.

   177      * @return none

   178      */

   179     void GetCandidateL( TBool aClearSelection = EFalse );

   180     };		

   181 

   182 #endif //T_AKNFEPUIINPUTMINIQWERTYZHUYINPHRASEBASE_H

   183 

   184 // End of file