/*

* Copyright (c) 2003 Nokia Corporation and/or its subsidiary(-ies). 

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of "Eclipse Public License v1.0""

* which accompanies this distribution, and is available

* at the URL "http://www.eclipse.org/legal/epl-v10.html".

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description:           

*

*/

#ifndef __AKN_FEP_PLUGIN_MANAGER__

#define __AKN_FEP_PLUGIN_MANAGER__

// INCLUDES

#include <gulicon.h>

#include <barsread.h>

#include <aknfeppensupportinterface.h>

#include <peninputclient.h>

#include <aknextendedinputcapabilities.h>

#include <eikedwob.h>          // for MEikEdwinObserver

#include "AknFepGlobalEnums.h"

#include <aknfeppeninputenums.h>

#include "AknFepPluginMenuManager.h"

#include "AknFepSharedDataInterface.h"

#include "AknFepManager.h"

#include "AknFepCaseManager.h"

#include <peninputsrveventhandler.h>

// FORWARD DECLARATIONS

//class MPeninputServerEventHandler;

class MAknFepManagerInterface;

class CAknFepUiSpellContainer;

class CPenInputGSInterface;

class CConnectAo;

// CLASS DECLARATION

/** 

 * Plugin command type

 */

enum TPluginCmd

    { 

    EPluginCloseMode,

    EPluginSyncFepAwareText,

    EPluginSetDataQueryShown,

    EPluginActivate,

    EPluginMenuCmd,

    EPluginFocusChanged,

    EPluginResourceChanged,

    EPluginFaseSwap,

    EPluginKeyEvent,

    EPluginUpdateIndicator,

    EPluginActivateInGlobalNote,

    EGainForeground,

    ELostForeground,    

    EPluginEditorActivate,

    EPluginForegroundChanged,

    EPluginFocusItemDestroy,

    EPluginLanguageChanged,

    EPluginPreview,

    EPluginPromptChanged,

    EPluginShowCandidate,

    EPluginShowTooltip,

    EPluginHideTooltip

    };

/** 

 * Plugin synchronization type

 */

enum TPluginSync

    { 

    EPluginSyncCurSel,

    EPluginSyncUpdatedText,

    EPluginSyncAll

    };

#ifdef RD_SCALABLE_UI_V2

/**

 * CAknFepPluginManager class.

 *

 *  @lib AknFep.lib

 *  @since 2.8

 */

class CAknFepPluginManager : 

    public CBase,

    public MAknFepPenSupportInterface,

    public MPeninputServerEventHandler,

    public MEikEdwinObserver

    { 

public:

	/**

	 * Simulate event mode

	 * @remark: Used in SubmitUiPluginTextL()

	 */	

	enum TSimulateEventMode

		{

		EIgnor,

		ERawEvent,

		EKeyEvent	

		};

     /**

     * NewL first phase construction

     *

     * @param aFepMan fep manager

     *

     */

    static CAknFepPluginManager* NewL( CAknFepManager& aFepMan,

                                      CAknFepSharedDataInterface& aSharedData,

                                      CAknFepLanguageManager& aLangMan,

                                      CAknFepCaseManager& aCaseMan );

     /**

     * Destructor

     */

    virtual ~CAknFepPluginManager();

private:

     /**

     * private constructor

     */

    CAknFepPluginManager( CAknFepManager& aFepMan,

                         CAknFepSharedDataInterface& aSharedData,

                         CAknFepLanguageManager& aLangMan,

                         CAknFepCaseManager& aCaseMan );     

     /**

     * Construct

     *

     * @param aFepMan fep manager

     *

     */

    void ConstructL();

public :

    enum TSpellCBA

        {

        ESpellCBANone,

        ESpellCBACancelEmpty,

        ESpellCBAOkCancel,

        };

public:

// From MAknFepPenSupportInterface

    /**

     *  From MAknFepPenSupportInterface

     *  Activate pen input method

     *

     *  @since 3.2

     *  @Return None

     */

    void ActivatePenInputL();

    /**

     *  From MAknFepPenSupportInterface

     *  Deactivate pen input method

     *

     *  @since 3.2  

     *  @Return None

     */

    void DeactivatePenInputL();

// From MPeninputServerEventHandler

    /**

     * From MPeninputServerEventHandler

     * Handle pen input server events.

     *

     * @since 3.2

     * @param aEventId Event to handle.

     * @return ETrue If server event handled

     */

    TBool HandleServerEventL(TInt aEventId);

    /**

     *  Handle events from FEP

     *  suggested mode.

     *  

     *  @since 3.2

     *  @param aEventType, event type from FEP

     *  @param aEventData, event data from FEP

     *  @return ETrue successful, EFalse otherwise

     */

    void HandleEventsFromFepL( TInt aEventType, TInt aEventData );

    /**

     *  Change current input method to plugin input method with

     *  suggested mode.

     *  

     *  @since 3.2

     *  @return ETrue successful, EFalse otherwise

     */

    TBool TryChangePluginInputModeByModeL(TPluginInputMode aSuggestMode, TInt aOpenMode, 

                                          TInt aSuggestRange);

    /**

     *  Close plugin input mode, reset iPluginInputMode

     *  to EPluginInputModeNone

     *

     *  @since 3.2

     *  @param aRestore, If ETrue, restor rembered HKB mode

     *  @return None

     */

    void ClosePluginInputModeL(TBool aRestore);

        /**

     *  Close plugin input UI, only close UI

     *

     *  @param aResetState If ETrue, reset UI state

     *  to initial.

     *  @return None.

     */

    void ClosePluginInputUiL(TBool aResetState);

    /**

     * Handle resource change.

     * 

     * @param aType The resource type

     * @return None.

     */

    void OnResourceChangedL(TInt aType);

    /**

     *  Synchronize plugin UI text with editor

     *

     *  @since 3.2

     *  @return None

     */

    void SyncFepAwareText( TPluginSync aSyncType = EPluginSyncCurSel, TBool aSendNow = ETrue );

    /**

     * Processes commands from the edit menu

     * 

     * @since 3.2

     * @param aCommandId The menu command id

     * @return None.

     */

    void ProcessMenuCommandL(TInt aCommandId);

    /**

     * Handle key events

     * 

     * @since 3.2

     * @param aCommandId The key id

     * @return None.

     */

    void HandleKeyEventL(TInt aKeyId);

    /**

     * initialize the edit menu depending on fep and editor state

     * 

     * @since 3.2

     * @param aMenuPane The pointer to menu pane

     * @return None.

     */

    void InitMenuPaneL( CAknEdwinState* aEditorState, 

        CAknFepUiInterfaceMenuPane* aMenuPane, TInt aResourceId );

    /**

     * Handles notifications that the UI has changed focus

     * 

     * @since 3.2

     * @param aFepFullyConstructed The flag of fep fully constructed

     * @return None.

     */

    void OnFocusChangedL( TBool aGainForeground );

    /**

     * Set ICF data

     *

     * @since 3.2

     * @param aTextChanged If editor text changed

     * @param aIcfData ICF data

     * @return None

     */

    void SendIcfDataL(  TPluginSync aSyncType = EPluginSyncCurSel );            

    /**

     * Set editor cursor selection according plugin UI 

     * cursor state

     *

     * @since 3.2

     * @param aCurSel Cursor position.

     * @param aSyncCursor ETrue if plug in UI need update cursor, EFalse otherwise

     * @return None

     */

    void SetCursorSelectionL(const TCursorSelection& aCurSel, TBool aSyncCursor);

    HBufC*  GetNumberKeymapResource(TInt aCaseMode);

    HBufC*  DoGetNumberKeymapResourceL(TInt aCaseMode);

    MAknFepManagerInterface* CurrentFepInputUI();

    void SetFingerMatchSelectionState(TBool aMatchStateOn);

    TBool IsVisible();

    TBool DoNextCandidates();

    void DoPreviousCandidates();

    // send all predictive candidates at once

    void ShowAllCandidates();

    void ResetCandidateList();

    void UpdateITUTIndicator();

    void SetITUTSpellingStateL(TBool aState);

    void DisplaySpellEditor(const TInt aEditorFlag, const TDesC& aInitText, 

                            TCursorSelection aCurSel);

    void DisplaySpellEditorL(const TInt aEditorFlag, const TDesC& aInitText, 

                           TCursorSelection aCurSel);                            

    void DestroySpellEditor();

    HBufC* SpellTextInput();

    void SetTCursorSelection();

    void HandleEdwinEventL(CEikEdwin* , TEdwinEvent aEventType);

    TInt GetSoftKeyResID();

    void HasNoFreeSpace();

    TBool EnterMatchSelectionState();

    TPluginInputMode PluginInputMode();

    void UpdateCaseMode();

    TBool IsGlobleNotes();

    TBool IsDimed();

    /**

     *  Save the cursor visibility. This function is called from fep side, 

     *  because of sync cursor visibility

     *

     *  @since v5.0

     */

    void SetCursorVisibility(TBool aVisibility, TBool aReportPlugin = EFalse);

    /**

     * Get the correct indicator for VKB;

     *

     * @return The correct indicator state for VKB.     

     */

    TAknEditingState VKBIndicatorState( TAknEditingState aOldState );

    void ClosePeninputSetting();

    /**

     * Show tooltip on FSQ to show the best guess word shown inline,

     * when it is necessary

     *

     * @param aText The tooltip text to be displayed

     * @return None

     */

    void ShowTooltipOnFSQL( TInt aSecondaryIdx );    

    /**

     * Hide tooltip on FSQ if necessary

     *

     * @return None

     */

     void HideTooltipOnFSQL();  

    /**

     * Open a candidate list to show contents in aItemArray

     *

     * @param aCandidateList ITI candidate data

     * @return None

     */

    void ShowCandidateListL( TFepITICandidateList aCandidateList );

    /**

     * Hide candidate list

     *

     */

    void HideCandidateListL();

    /**

     * Commit candidate word on FSQ

     * 

     * @param aIndex the index in candidate lists;

     * @return None

     */    

    void CommitCandidateWordOnFSQL( TInt aIndex );

    /**

     * Check if ITI features is enabled when FSQ is opened.

     */

    TBool EnableITIOnFSQ();

    /**

     * Check if ITI can be supported by FSQ.

     */

    TBool IsSupportITIOnFSQ();

    /**

     * Restore some configuration after closing FSQ.

     *     

     */

    void ResetItiStateL();    

/*    

#ifdef RD_TACTILE_FEEDBACK

    TBool VKBIsOpened();

#endif // RD_TACTILE_FEEDBACK

*/

    void HandleiDimGainForeground(TBool aGain);

    void OnServerReady(TInt aErr);

public: // inline    

    /**

     * Get current plugin input UI

     *

     * @since 3.2

     * @return The pointer to MAknFepManagerInterface

     */      

    inline MAknFepManagerInterface* CurrentPluginInputFepUI();

    /**

     * Get current plugin input mode

     *

     * @since 3.2

     * @return current plugin input mode

     */      

    inline TBool PluginNativeRange();

    inline void SetPluginNativeRange( TBool aPluginNativeRange );

    inline TBool SyncWithPluginRange();

    inline RPointerArray<HBufC>& MatchCandidateList();    

    inline TBool IsMatchState();  

    inline TBool IsSpellVisible();

    inline void SetCursorSelection(TCursorSelection& aCursorSel); 

    inline TCursorSelection CursorSelection(); 

    inline void SetCaseUpdatesSupressed(TBool aCaseUpdatesSupressed);

    inline TBool CaseUpdatesSupressed();

    inline void SetBeforeSpell(TBool aBeforeSpell);

    inline TBool BeforeSpell();

    inline HBufC* GetSpellText();

    inline void SpellText(HBufC* aSpellText);

    inline TBool IsNonLatinLanguage(TLanguage aLang);

    inline TInt PreviousPermitMode();

    /**

     *  In T9 predictive text input, if user press "Spell" button, a edit word query dialog is opened.  

     *  This Flag is set for this case to indicate whether edit wod query dialog is opened.

     *  @param aIsEditWordQueryDlg  ETrue means dialog is open,

                                    EFalse means dialog is not open.

     *  @since v5.0

     */    

    inline void SetInEditWordQueryFlag(TBool aIsEditWordQueryDlg );    

    void LaunchPenInputLanguageSelectionL( TBool aLaunchedByTouchWin = EFalse );

    void LaunchPenInputRecognitionWithDictionarySelectionL();

  inline TBool IsInGlobleNoteEditor();

    void SetMenuState(TBool aUpdateEditor = ETrue);

    void ResetMenuState(TBool aUnDim = ETrue);

    /**

     * When ITI setting opened, set this flag to ETrue

     *  

     * @param aOpen  ETrue means dialog is open,

     *               EFalse means dialog is not open.

     * @return None  

     */    

    inline void ITISettingDialogOpen( TBool aOpen );

    /**

     * Check if tooltip box on FSQ is opened.

     *

     * @return if ETrue: Tooltip box on FSQ is enabled.

     */    

    inline TBool IsTooltipOpenOnFSQ();

private: 

    /**

     *  Initialize plugin UI, set permitted ranges, primary

     *  range, case mode and etc.

     *  

     *  @since 3.2

     *  @Return None

     */

    void InitializePluginInputL(TInt aOpenMode, TInt aSuggestRange, TBool aCleanContent);

    /**

     * Launch plugin menu

     *

     * @since 3.2

     * @param aResource Menu resource id.

     * @return None

     */

    void LaunchPenInputMenuL(TInt aResourceId, TBool aRemeber = ETrue);

    /**