idlehomescreen/inc/xntexteditor.h
author Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
Wed, 13 Oct 2010 14:18:30 +0300
branchRCL_3
changeset 102 ba63c83f4716
parent 88 3321d3e205b6
permissions -rw-r--r--
Revision: 201039 Kit: 201041

/*
* Copyright (c) 2005-2006 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:  Implementation wrapper for CEikEdwin
*
*/

#ifndef _XNTEXTEDITOR_H
#define _XNTEXTEDITOR_H

//  INCLUDES
#include "xncomponent.h"
#include <e32base.h>
#include "xnnode.h"
#include "mxncomponentinterface.h"


// CLASS DECLARATION

namespace XnTextEditorInterface
    {
    _LIT8( KType, "texteditor" );

    class MXnTextEditorInterface : public XnComponentInterface::MXnComponentInterface
        {
        public:
        		
            static inline const TDesC8& Type()
                {
                return KType;
                }
		
        public: // New functions

        /**
         * Sets the new text to the underlying CEikEdvin
         * @param aText The new content
         */
        virtual void SetTextL(const TDesC& aText) = 0;
        
        /**
         * Returns the text contained in the underlying CEikEdvin
         * @return HBufC* The text
         */
        virtual const HBufC* Text() = 0;

        /**
         * Handles editor events
         * 
         * @since S60 5.2
         * @param aReason, editor event       
         */
        virtual void HandleEditorEvent( TInt aReason ) = 0;

        private:
        };
    }   

/**
*  @ingroup group_xntexteditorfactory
*  @lib xntexteditorfactory.lib
*  @since S60
*/
class CXnTextEditor : public CXnComponent, public XnTextEditorInterface::MXnTextEditorInterface
    {
public:

/**
 * Editor events
 */
    enum TEditorEvent
                {
                KActivateTextEditor,
                KDeactivateTextEditor,
                KRemoveSplitInputFromStack,
                KKeepSplitInputInStack
                };
public:

	/**
	 * 2 phase construction.
	 */
	static CXnTextEditor* NewL();

	/**
	 * Destructor.
	 */
	virtual ~CXnTextEditor();

public: // New functions

    /**
     * Sets the new content to the underlying CEikEdvin
     * @param aText The new content
     */
    void SetTextL(const TDesC& aText);
    
    /**
     * Returns the text contained in the underlying CEikEdvin
     * @return HBufC* The text
     */
    const HBufC* Text();

    /**
     * Handles editor events
     * 
     * @since S60 5.2
     * @param aReason, editor event       
     */
    void HandleEditorEvent( TInt aReason );

public: // from CCoeControl

   	/**
     * Create a component interface according to the given type.
     * @param aType Type of the interface to create
     * @return Created interface or NULL if the provided type is not supported.
     */ 
    virtual XnComponentInterface::MXnComponentInterface* MakeInterfaceL( const TDesC8& aType );        
            
private:

	CXnTextEditor();
	void ConstructL();
    };

#endif      // _XNTEXTEDITOR_H
            
// End of File