/*

* Copyright (c) 2002-2007 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:  Interface of vkb ui state

*

*/

#ifndef C_PENINPUTVKBUISTATE_H

#define C_PENINPUTVKBUISTATE_H

// system includes

#include <peninputuistatebase.h>

// user includes

// class declarations

/**

 *  Basic class of vkb ui state

 *

 *  @lib peninputvkbjp.lib

 *  @since S60 v3.2

 */

class CPeninputVkbUiState : public CPeninputUiStateBase

    {

public:

    /**

     * Two-phased constructor.

     *

     * @since S60 v3.2

     * @param aUiStateMgr The common ui state manager

     * @param aContext The common layout context

     * @return The pointer point to CPeninputVkbUiState type object

     */

    static CPeninputVkbUiState* NewL(MPeninputUiStateMgr* aUiStateMgr, MPeninputLayoutContext* aContext);

    /**

     * Destructor.

     *

     * @since S60 v3.2

     */

    virtual ~CPeninputVkbUiState();

    // from MPeninputVkbUiState  

    /**

     * process internal event

     *

     * @since S60 v3.2

     * @param aEventType The internal event type

     * @param aEventData The internal event data

     * @return ETrue means event was responsed, otherwise EFalse

     */

    virtual TBool HandleControlEvent(TInt aEventType, const TDesC& aEventData);

protected:

    /**

     * C++ default constructor.

     *

     * @since S60 v3.2

     * @param aUiStateMgr The common ui state manager

     * @param aContext The common layout context

     */

    CPeninputVkbUiState(MPeninputUiStateMgr* aUiStateMgr, MPeninputLayoutContext* aContext);

    /**

     * Process virtual key event

     *

     * @since S60 v3.2

     * @param aEventType The event type

     * @param aEventData The event data

     * @return ETrue means event was responsed, otherwise EFalse

     */

    virtual TBool HandleVkbEvent(TInt aEventType, const TDesC& aEventData);

    /**

     * Process backspace key event

     *

     * @since S60 v3.2

     * @param aEventType The event type

     * @param aEventData The event data

     * @return ETrue means event was responsed, otherwise EFalse

     */

    virtual TBool HandleBackEvent(TInt aEventType, const TDesC& aEventData);

    /**

     * Process enter, space, tab key event

     *

     * @since S60 v3.2

     * @param aEventType The event type

     * @param aEventData The event data

     * @return ETrue means event was responsed, otherwise EFalse

     */

    virtual TBool HandleEnterSpaceTabEvent(TInt aEventType, const TDesC& aEventData);

    };

#endif  // C_PENINPUTVKBUISTATE_H

// End Of File