fep/aknfep/inc/aknfepuiinputminiqwertysogoustrokephraseplugin.h
branchRCL_3
changeset 56 8152b1f1763a
parent 50 5a1685599b76
child 57 9eb76adaa71f
equal deleted inserted replaced
50:5a1685599b76 56:8152b1f1763a
     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 TAknFepInputMiniQwertySogouStrokePhrasePlugin declaration.
       
    16 *
       
    17 */
       
    18 
       
    19 
       
    20 #ifndef T_AKNFEPUIINPUTMINIQWERTYSOGOUSTROKEPHRASEPLUGIN_H
       
    21 #define T_AKNFEPUIINPUTMINIQWERTYSOGOUSTROKEPHRASEPLUGIN_H
       
    22 
       
    23 class TAknFepInputMiniQwertySogouStrokePhrasePlugin
       
    24     {
       
    25 public:
       
    26     
       
    27     /**
       
    28      * C++ default constructor
       
    29      *
       
    30      * @since S60 v3.2.3
       
    31      * @param aOwner Pointer to UI manager state interface
       
    32      * @param aUIContainer Pointer to Chinese UI container
       
    33      * @param aState current state machine
       
    34      */
       
    35     TAknFepInputMiniQwertySogouStrokePhrasePlugin(
       
    36         MAknFepUIManagerStateInterface* aOwner,
       
    37         MAknFepUICtrlContainerChinese* aUIContainer,
       
    38         TUIState aState
       
    39         );
       
    40     
       
    41     /**
       
    42      * A patch to force the vtable to be copied during an assignment.
       
    43      * 
       
    44      * @param aState
       
    45      */
       
    46     void operator=(const TAknFepInputMiniQwertySogouStrokePhrasePlugin& aPlugin);
       
    47     
       
    48 public:       
       
    49         
       
    50         /**
       
    51          * Add phrase pinyin to the core.
       
    52          *  
       
    53          * @since S60 v3.2.3.
       
    54          * @param aPhraseAdd that need to be added to the UDB.
       
    55          * @return None.
       
    56          */ 
       
    57         void AddPhrasePinyinToPti(); 
       
    58         
       
    59         /**
       
    60          * Commint text to EEP or editor
       
    61          *
       
    62          * @since S60 V3.2.3
       
    63          * @param aDes Text had been select from candidate pane
       
    64          * @return ETrue if keep state, otherwise need to change to pridictive or editor
       
    65          */
       
    66         TBool CommitInlineEEPL( const TDesC& aDes );        
       
    67         
       
    68         /**
       
    69          * Enable or disable the plugin.
       
    70          *
       
    71          * @since S60 v3.2.3
       
    72          * @param aValid ETrue: enable the plugin, EFalse: disable the plugin.
       
    73          * @return None
       
    74          */
       
    75         void Enable( TBool aValid );
       
    76         
       
    77         /**
       
    78          * Detect whether the plugin enable or not.
       
    79          *
       
    80          * @since S60 v3.2.3
       
    81          * @param None
       
    82          * @return ETrue if the plugin is enable, others return EFalse.
       
    83          */
       
    84         TBool IsEnable();        
       
    85         
       
    86 private:
       
    87         /**
       
    88          * The ui manager
       
    89          */        
       
    90         MAknFepUIManagerStateInterface* iOwner;
       
    91         
       
    92         /**
       
    93          * The ui container.
       
    94          */
       
    95         MAknFepUICtrlContainerChinese* iUIContainer;
       
    96         
       
    97         /**
       
    98          * The machine state
       
    99          */           
       
   100         TUIState iState;
       
   101         
       
   102         /**
       
   103          * The flag for judge the plugin enable or not
       
   104          */               
       
   105         TBool iValid;
       
   106     };		
       
   107 
       
   108 #endif //T_AKNFEPUIINPUTMINIQWERTYSOGOUSTROKEPHRASEPLUGIN_H
       
   109 
       
   110 // End of file