1 /*

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

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

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

     6 * which accompanies this distribution, and is available

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

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:  A class responsible handling the views

    15  *

    16 */

    17 

    18 

    19 

    20 #ifndef MCCAPPENGINE_H_

    21 #define MCCAPPENGINE_H_

    22 

    23 #include <mccacontactobserver.h>

    24 

    25 // FORWARD DECLARATIONS

    26 class MCCAParameter;

    27 

    28 /**

    29 *	CCA engine class interface

    30 *

    31 *	CCA engine handles the creation and loading of the plugins.

    32 * This class also handles switching of the plugin views. With

    33 * this interface clients can recieve contact notifications via

    34 * MCCAppPluginsContactObserver

    35 */

    36 class MCCAppEngine

    37 		{

    38 public:

    39 		/*

    40      * CCApp engine is notified by a plugin of a contact event

    41      * 

    42      * @since S60 v5.0

    43      */     

    44      virtual void CCAppContactEventL() = 0;

    45      

    46     /**

    47      * Adds observer to start receiving MCCAppContactChangeObserver-events.

    48      * 

    49      * @since S60 v5.0

    50      * @param aObserver an observer

    51      */    

    52      virtual void AddObserverL( MCCAppPluginsContactObserver& aObserver ) = 0;

    53     

    54     /**

    55      * Removes observer from observer queue

    56      *

    57      * @since S60 v5.0

    58      * @param aObserver an observer

    59      */    

    60      virtual void RemoveObserver( MCCAppPluginsContactObserver& aObserver ) = 0;

    61      

    62      /**

    63      	* The CCA parameter.

    64      	* Plugins should not modify this parameter. They do not own it

    65      	*

    66      	* @since S60 v5.0

    67      	*/      

    68      virtual MCCAParameter& Parameter() = 0;

    69 

    70     /**

    71      * Shows the plugin in CCApplication.

    72      *

    73      * @since S60 v5.0

    74      * @param aUid Id of the plugin to be shown.

    75      */    

    76     virtual void ShowPluginL( TUid aUid ) = 0;

    77 

    78     /**

    79      * Hides the plugin from CCApplication.

    80      *

    81      * @since S60 v5.0

    82      * @param aUid Id of the plugin to be hidden.

    83      */    

    84     virtual void HidePluginL( TUid aUid ) = 0;

    85 

    86     /**

    87      * Returns an extension point for this interface or NULL.

    88      * @param aExtensionUid Uid of extension

    89      * @return Extension point or NULL

    90      */

    91     virtual TAny* CcaAppEngineExtension( 

    92             TUid /*aExtensionUid*/ ) { return NULL; }    

    93     

    94     

    95      };

    96 

    97 #endif /*MCCAPPENGINE_H_*/