fep/aknfep/peninputplugins/PeninputPluginKr/inc/PeninputPluginKr.h
branchRCL_3
changeset 44 ecbabf52600f
equal deleted inserted replaced
43:ebd48d2de13c 44:ecbabf52600f
       
     1 /*
       
     2 * Copyright (c) 2002-2006 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 *
       
    16 */
       
    17 
       
    18 #ifndef __PENINPUTPLUGINKR_H__
       
    19 #define __PENINPUTPLUGINKR_H__
       
    20 
       
    21 #include <e32base.h>	// CBase
       
    22 #include <e32std.h>	 // TBuf
       
    23 #include <aknfeppeninputimeplugin.h>
       
    24 #include <centralrepository.h>
       
    25 #include <aknlistquerydialog.h>
       
    26 
       
    27 class RPeninputServer;
       
    28 class CPtiEngine;
       
    29 class CPluginKrFepManagerBase;
       
    30 class CPeninputPluginKrCombineListQueryDialog;
       
    31 
       
    32 class CPeninputPluginKr : public CAknFepPenInputImePlugin
       
    33     {
       
    34 public:
       
    35 
       
    36     static CPeninputPluginKr* NewLC(TAny* aInitParams);
       
    37     
       
    38     static CPeninputPluginKr* NewL(TAny* aInitParams);
       
    39     
       
    40     virtual ~CPeninputPluginKr();
       
    41 
       
    42 private:
       
    43 
       
    44     CPeninputPluginKr(RPeninputServer* aServer);
       
    45     
       
    46     void ConstructL();
       
    47 
       
    48 private: // from CAknFepPenInputImePlugin
       
    49 
       
    50     /**
       
    51      * Get layout UI interface
       
    52      * 
       
    53      * @since S60 v3.2
       
    54      * @param aFepManager Fep manager interface pointer
       
    55      * @param aLanguage Language that layout UI need to support
       
    56      * @param aMode Speicifed layout UI mode to create
       
    57      * @param aData Initialization data.
       
    58      *
       
    59      * @return The layout UI interface..
       
    60      */
       
    61     virtual MAknFepManagerInterface* GetInputMethodUiL(
       
    62         MAknFepManagerUIInterface* aFepManager,
       
    63         TLanguage aLanguage, 
       
    64         TInt aMode,
       
    65         const TDesC8& aData,
       
    66         const TBool aIsSplitView = EFalse);
       
    67     
       
    68     /**
       
    69      * Get layout UI interface
       
    70      * 
       
    71      * @since S60 v3.2
       
    72      * @param aFepManager Fep manager interface pointer
       
    73      * @param aLayoutId Speicifed layout UI id to create
       
    74      * @param aData Initialization data.
       
    75      *
       
    76      * @return The layout UI interface..
       
    77      */
       
    78     virtual MAknFepManagerInterface* GetInputMethodUiL(
       
    79         MAknFepManagerUIInterface* aFepManager,
       
    80         TInt aLayoutId,
       
    81         const TDesC8& aData);
       
    82     
       
    83     /**
       
    84      * Activate current IME plugin.
       
    85      * 
       
    86      * @since S60 v3.2
       
    87      *
       
    88      * @return None.
       
    89      */
       
    90     virtual void Activate();
       
    91 
       
    92     /**
       
    93      * Deactivate current IME plugin.
       
    94      * 
       
    95      * @since S60 v3.2
       
    96      *
       
    97      * @return None.
       
    98      */
       
    99     virtual void DeActivate();
       
   100 
       
   101     /**
       
   102      * Get current IME plugin implementation ID.
       
   103      * 
       
   104      * @since S60 v3.2
       
   105      *
       
   106      * @return IME plugin implementation id.
       
   107      */
       
   108     virtual TInt ImeImplId();
       
   109 
       
   110     /**
       
   111      * Get current layout UI implementation id.
       
   112      * 
       
   113      * @since S60 v3.2
       
   114      *
       
   115      * @return None.
       
   116      */
       
   117     virtual TInt LayoutUiImplId();
       
   118 
       
   119     /**
       
   120      * Handle pen input server event.
       
   121      * 
       
   122      * @param aEventId The event id, defined in <peninputcmd.h>
       
   123      * @param aData The event related data.
       
   124      * @since S60 v3.2
       
   125      *
       
   126      * @return None.
       
   127      */
       
   128     virtual TBool HandleServerEventL(
       
   129         TInt aEventId, 
       
   130         const TDesC& aData);
       
   131 
       
   132     /**
       
   133      * Get suppored layout UI modes(VKB/HWR).
       
   134      * 
       
   135      * @since S60 v3.2
       
   136      *
       
   137      * @return Supported modes.
       
   138      */
       
   139     virtual TInt SupportModes(
       
   140         CPtiEngine* aPtiEngine, 
       
   141         RArray<TImePlguinImplDetail>& aSupportList) const;
       
   142     
       
   143     /**
       
   144      * Get current layout UI mode.
       
   145      * 
       
   146      * @since S60 v3.2
       
   147      *
       
   148      * @return Current layout UI mode.
       
   149      */
       
   150     virtual TInt CurrentMode() const;
       
   151     
       
   152     /**
       
   153      * Handle the menu command.The menu is launched by FEP
       
   154      * The menu command is first passed to IME plugin, if 
       
   155      * this function return EFalse, FEP handles it defaultly.
       
   156      * 
       
   157      * @param aCommandId The menu command id
       
   158      * @return ETrue if IME plugin handled the command; 
       
   159      *         EFalse otherwise.
       
   160      */
       
   161     virtual TBool HandleMenuCommandL(TInt aCommandId);
       
   162     
       
   163     /**
       
   164      * Dynamiclly update menu items during it displays. 
       
   165      * 
       
   166      * aMenuPane The menu pane pointer.
       
   167      * @return None.
       
   168      */
       
   169     virtual void DynInitMenuPaneL(
       
   170         CAknFepUiInterfaceMenuPane* aMenuPane);
       
   171     
       
   172 
       
   173 private:
       
   174     
       
   175     void FindUiLayoutImplementationL();
       
   176     
       
   177     CPluginKrFepManagerBase* GetPluginUiL( TInt aMode );
       
   178     
       
   179     TInt SupportModesL(
       
   180         CPtiEngine* /*aPtiEngine*/,
       
   181         RArray<TImePlguinImplDetail>& aSupportList) const; 
       
   182 
       
   183     CPluginKrFepManagerBase* CPeninputPluginKr::GetCurrentUi();
       
   184 
       
   185     /**
       
   186      * Get VKB UI interface
       
   187      *
       
   188      * @return VKB UI pointer
       
   189      */
       
   190     CPluginKrFepManagerBase* GetVkbUiL();
       
   191 
       
   192     /**
       
   193      * Get Itut UI interface
       
   194      *
       
   195      * @return Itut UI pointer
       
   196      */
       
   197     CPluginKrFepManagerBase* GetItutUiL();
       
   198 
       
   199     /**
       
   200      * Get FSQ UI interface
       
   201      *
       
   202      * @return FSQ UI pointer
       
   203      */
       
   204     CPluginKrFepManagerBase* GetFSQUiL(TInt aLang);
       
   205     
       
   206     void ShowListQueryL( const TInt aResourceId, CRepository* aRepository );
       
   207     
       
   208 private:
       
   209     
       
   210     RPeninputServer& iPeninputServer;
       
   211 
       
   212     RArray<TInt> iUiLayoutImpIdList;
       
   213 
       
   214     TInt iPenInputMode;
       
   215     
       
   216      /**
       
   217      * Pen input server pointer. Not own.
       
   218      */
       
   219     RPointerArray<CPluginKrFepManagerBase> iAllUiManagers;
       
   220     
       
   221     CPluginKrFepManagerBase* iPluginKrFepManager;
       
   222     
       
   223     CPeninputPluginKrCombineListQueryDialog* iCombineQueryDialg;
       
   224     
       
   225     
       
   226     TInt iResId;
       
   227     
       
   228     };
       
   229 
       
   230 #endif  // __PENINPUTPLUGINKR_H__
       
   231