/*
* Copyright (c) 2009-2010 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: header for finger hwr UiLayout
*
*/
#ifndef C_PENINPUTFINGERHWRARLAYOUT_H
#define C_PENINPUTFINGERHWRARLAYOUT_H
// INCLUDES
#include "peninputpluginutils.h"
#include "peninputlayout.h"
#include "peninputfingerhwrarstoreconstants.h"
#include "peninputfingerhwrarcontrolid.h"
// FORWARD DECLARATIONS
class CPeninputFingerHwrArStateManagerBase;
class CPeninputFingerHwrArDataStore;
class CRepository;
class CPeninputFingerHwrArWnd;
// class DECLARATIONS
/**
* class CPeninputHwrfscnLayout.
*
* Chinese full screen handwriting ui layout class.
*
* @lib peninputfingerhwr.lib
* @since S60 v5.0
*/
class CPeninputFingerHwrArLayout : public CFepUiLayout
{
public:
/**
* The writing speed.
*
*@since S60 v5.0
*/
enum TWritingSpeed
{
EWritingSpeedVeryFast = 1,
EWritingSpeedFast,
EWritingSpeedNormal,
EWritingSpeedSlow,
EWritingSpeedVerySlow
};
public:
/**
* Symbian constructor.
*
* @since S60 5.0
*
* @param aLayoutOwner The MLayoutOwner
* @param aInitData Init data for layout
* @return Pointer to created CPeninputHwrfscnLayout object
*/
static CPeninputFingerHwrArLayout* NewL(MLayoutOwner* aLayoutOwner,
const TAny* aInitData);
public:
//from CFepUiLayout
/**
* From CFepUiLayout.
* Handle layout command event
*
* @since Series 60 5.0
* @param aCmd Command Id.
* @param aData Data for command.
* @return Errors when return value small than 0.
*/
TInt HandleCommand(const TInt aCmd, TUint8* aData);
/**
* From CFepUiLayout.
* Handle layout command event
*
* @since Series 60 5.0
* @param aCmd Command Id.
* @param aData Data for command.
* @return Errors when return value small than 0.
*/
TInt HandleCommandL(const TInt aCmd, TUint8* aData);
/**
* From CFepUiLayout.
* Inform layout the size changing event
*
* @since Series 60 5.0
* @param pData The event data.
* @return KErrNone if successfully size changing.
*/
TInt SizeChanged(const TAny* pData);
/**
* From CFepUiLayout.
* Handle editor text coming
* Called by animation dll when app editor text is coming.
* If a ui layout has a editor area, it must implements this function to get the text
*
* @since Series 60 5.0
* @param aData The fep input context field data
* @return KErrNone is operation succeeded.
*/
TInt OnAppEditorTextComing(const TFepInputContextFieldData& aData);
/**
* From CFepUiLayout.
* Handle application info change
*
* @since Series 60 5.0
* @param aInfo The information.
* @param aType The information type.
* @return none
*/
void HandleAppInfoChange(const TDesC& aInfo, TPeninputAppInfo aType);
/**
* From CFepUiLayout
* Called by owner when the system resource changed event.
*
* @since S60 v4.0
* @param aType the event type
* @return KErrNone if successfully size changing.
*/
TInt OnResourceChange(TInt aType);
/**
* From MPenUiLayoutBase
* Return the peninput ui type
*
* @since Series 60 5.0
* @return The ui type @see TPenInputUiType
*/
TInt PenInputType();
/**
* From MFepLayoutBase
* Called by owner when the layout is going to be hidden
*
* @since S60 5.0
* @return none
*/
void OnDeActivate();
void CallBackL();
/**
* Check if the First string will be allowed to submitted directly to editor without selection
*/
TBool IsAllowedToSubmitDefaultCandiate();
public:
//from MEventObserver;
/**
* From MEventObserver
* handle control event.
*
* @since Series 60 5.0
* @param aEventType The event type
* @param aCtrl The control who sends the event
* @param aEventData The event data
* @return none
*/
void HandleControlEvent(TInt aEventType, CFepUiBaseCtrl* aCtrl,
const TDesC& aEventData);
void HandleControlEventL(TInt aEventType, CFepUiBaseCtrl* aCtrl,
const TDesC& aEventData);
public:
/**
* Get the data stroe object.
*
* @since Series 60 5.0
* @return The CPeninputHwrfscnDataStore reference
*/
CPeninputFingerHwrArDataStore& DataStore();
/**
* Replace the char before the cursor in forground app with a new char.
*
* @since S60 5.0
* @param aOldCharCode The old char need to be replaced
* @param aNewCharCode The new char for replacing the old char
* @return none
*/
void Replace(const TDesC& aOldCharCode, const TDesC& aNewCharCode,
const TBool aIsPart = EFalse);
/**
* Submit string to layout owner.
*
* @since S60 5.0
* @param aCharCode The buffer needed to be submitted.
* @return none
*/
void SubmitStringToFep(const TDesC& aCharCode);
/**
* Submit char to layout owner.
*
* @since S60 5.0
* @param aCharCode The buffer needed to be submitted.
* @return none
*/
void SubmitCharToFep(const TInt aCharCode);
/**
* repository callback for settings.
*
* @since S60 5.0
* @param aPtr callback data.
* @return error code.
*/
static TInt HandleGSRepositoryCallBack(TAny* aPtr);
/**
* load default settings.
*
* @since S60 5.0
* @param aSetPosFlag The buffer needed to be submitted.
* @return none
*/
void LoadAndPublishDefaultL();
/**
* sync stroke end mark of writingbox with hwr engine.
*
* @param aEndMark a TPoint object as new stroke end mark.
* @return none
*/
void SyncHwrStrokeEndMark(const TPoint& aEndMark);
private:
/**
* C++ constructor
*
* @since S60 5.0
* @param aLayoutOwner The MLayoutOwner pointer.
* @return none
*/
CPeninputFingerHwrArLayout(MLayoutOwner* aLayoutOwner);
/**
* standard c++ destructor.
*
* @since S60 5.0
* @return none
*/
~CPeninputFingerHwrArLayout();
/**
* Symbian second-phase constructor
*
* @since S60 5.0
* @param aInitData The init data passed by layout engine.
* @return none
*/
void ConstructL(const TAny* aInitData);
/**
* Create the hwr box window
*
* @since S60 5.0
* @return none
*/
void CreateHwrWindowL();
/**
* Create the state manager
*
* @since S60 5.0
* @return none
*/
void CreateStateManagerL();
private:
/**
* handler of button down event.
*
* @since S60 5.0
* @param aEventType event type id.
* @param aCtrl event src.
* @param aEventData event data.
* @return none
*/
void OnCtrlButtonDownL(TInt aEventType, CFepUiBaseCtrl* aCtrl,
const TDesC& aEventData);
/**
* handler of button up event.
*
* @since S60 5.0
* @param aEventType event type id.
* @param aCtrl event src.
* @param aEventData event data.
* @return none
*/
void OnCtrlButtonUpL(TInt aEventType, CFepUiBaseCtrl* aCtrl,
const TDesC& aEventData);
/**
* handler of rep-button clicked event.
*
* @since S60 5.0
* @param aCtrl event src.
* @param aData event data.
* @return none
*/
void OnRepButtonClickedL(CFepUiBaseCtrl* aCtrl, const TDesC& aData);
/**
* clicked event handler of the BACKSPACE button.
*
* @since S60 5.0
* @return none
*/
void OnBackspaceClickedL();
/**
* handler of virtual key down event.
*
* @since S60 5.0
* @param aCtrl event src.
* @param aData event data.
* @return none
*/
void OnVirtualKeyDownL(CFepUiBaseCtrl* aCtrl, const TDesC& aData);
/**
* handler of virtual key up event.
*
* @since S60 5.0
* @param aCtrl event src.
* @param aData event data.
* @return none
*/
void OnVirtualKeyUpL(CFepUiBaseCtrl* aCtrl, const TDesC& aData);
/**
* handler of candidate list event.
*
* @since S60 5.0
* @param aCtrl event src.
* @param aData event data.
* @return none
*/
void OnCandidateSelectedL(CFepUiBaseCtrl* aCtrl, const TDesC& aData);
/**
* clicked event handler of icf.
*
* @since S60 5.0
* @return none
*/
void OnIcfClicked();
/**
* handler of StrokeStarted event.
*
* @since S60 5.0
* @return none
*/
void OnHwrStrokeStartedL();
/**
* handler of StrokeFinished event.
*
* @since S60 5.0
* @return none
*/
void OnHwrStrokeFinishedL();
/**
* handler of CharacterFinished event.
*
* @since S60 5.0
* @return none
*/
void OnHwrCharacterFinishedL();
private:
/**
* get value from repository
*
* @since S60 v5.0
* @param aWatcher repository reader.
* @param aId value id.
* @return value
*/
TInt GetNewValue(CAknFepRepositoryWatcher* aWatcher, const TInt aId);
/**
* get hwr trail color from repository
*
* @since S60 v5.0
* @return color value.
*/
TInt GetPenTrailColor();
/**
* set hwr writing speed.
*
* @since S60 v5.0
* @param aWritingSpeed speed
* @return none
*/
void SetWritingSpeed(const TInt aWritingSpeed);
/**
* set hwr writing pen width.
*
* @since S60 v5.0
* @param aPenSize The pen size
* @return none
*/
void SetBoxPenSize(const TSize aPenSize);
/**
* set hwr writing pen color.
*
* @since S60 v5.0
* @param aWritingSpeed speed
* @return none
*/
void SetBoxPenColor(const TInt aPenColor);
/**
* set guide line on or off.
*
* @since S60 v5.0
* @param aGuideLineOn guide line on or off.
* @return none
*/
void SetGuideLineOn(const TBool aGuideLineOn);
/**
* change current state manager to standby state.
*
* @since S60 v5.0
* @return none
*/
void ChangeCurStateToStandby();
/**
* handler of NumMapping changed event.
*
* @since S60 5.0
* @return none
*/
void OnNumMappingChangedL();
/**
* revert special characters direction before sending to editor.
*
* @since S60 v5.2
* @return none
*/
TBool RevertSymbolDirection(TInt aInChar, TInt & aOutChar);
private:
/**
* main window.
* not own
*/
CPeninputFingerHwrArWnd* iHwrWnd;
/**
* The data store
* Own
*/
CPeninputFingerHwrArDataStore* iDataStore;
/**
* The state manager
* Own
*/
CPeninputFingerHwrArStateManagerBase* iStateMgr;
/**
* The resource Id
*
*/
TInt iResId;
/**
* Repository watcher
*/
CAknFepRepositoryWatcher* iGSRepositoryWatcher;
/**
* Repository object.
*/
CRepository* iRepositorySetting;
/**
* Check if the stroke of drawing the character on the
* HWR box is started
*/
TBool iIsStrokeOfDrawingCharacerStarted;
/**
* Check if the editor is MFNE
*/
TBool iIsEditorMFNE;
/**
* Last overlap index.
*/
TInt iLastOverlapIdx;
};
#endif //C_PENINPUTFINGERHWRARLAYOUT_H