mmappfw_plat/mpx_base_view_plugins_api/inc/mpxaknviewplugin.h
author Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
Thu, 17 Dec 2009 08:55:47 +0200
changeset 0 a2952bb97e68
permissions -rw-r--r--
Revision: 200949 Kit: 200951

/*
* Copyright (c) 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:  MPX Avkon view plugin definition.
*
*/



#ifndef CMPXAKNVIEWPLUGIN_H
#define CMPXAKNVIEWPLUGIN_H


// INCLUDES
#include "mpxviewplugin.h"


// FORWARD DECLARATIONS
class CAknView;


// CLASS DECLARATION

/**
 *  MPX Avkon view plugin definition.
 *
 *  @lib mpxviewplugin.lib
 */
class CMPXAknViewPlugin : public CMPXViewPlugin
    {
public:

    /**
     * Destructor.
     *
     * @since S60 3.0
     */
    IMPORT_C virtual ~CMPXAknViewPlugin();

protected:

    /**
     * Interface method to construct Avkon view.
     *
     * @since S60 3.0
     * @return Pointer to a newly created Avkon view.
     */
    virtual CAknView* ConstructViewLC() = 0;

// from base class CMPXViewPlugin

    /**
     * Interface method to create view.
     * From CMPXViewPlugin
     *
     * @since S60 3.0
     */
    IMPORT_C virtual void CreateViewL();

    /**
     * Interface method to destroy view.     
     * From CMPXViewPlugin
     *
     * @since S60 v.0
     */
    IMPORT_C virtual void DestroyView();

    /**
     * Interface method to activate view.
     * From CMPXViewPlugin
     *
     * @since S60 3.0
     * @param aParam Parameter required to activate the view.
     */
    IMPORT_C virtual void ActivateViewL( const TDesC* aParam = NULL );
    
    /**
     * Interface method to activate as default view. 
     * Will not bring to foreground.
     * From CMPXViewPlugin    
     *
     * @since S60 3.0
     */
    IMPORT_C virtual void SetAsDefaultViewL();

    /**
     * Interface method to deactivate view.
     * From CMPXViewPlugin
     *
     * @since S60 3.0
     */
    IMPORT_C virtual void DeactivateView();

protected:  // data

    /**
     * Avkon view that associates with this plugin.
     * Not own.
     */
    CAknView* iView;
    };

#endif  // CMPXAKNVIEWPLUGIN_H

// End of File