idlefw/inc/framework/aicontentpluginmanager.h
author jake
Tue, 13 Apr 2010 15:07:27 +0300
branchv5backport
changeset 56 7b5c31fac191
parent 54 666a2952b5b3
permissions -rw-r--r--
Many of the components were not compilingm,because bld.inf had undefined flag #ifdef RD_CUSTOMIZABLE_AI. All the flags removed now. Components do not compile right away. E.g. many icons are missing and need to be copied from Symbian3. See example from MCSPlugin. Shortcut plugin does not need to be compiled as MCSPlugin replaces it.

/*
* 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:  Content plugin manager class for Active idle framework.
*
*/



#ifndef C_AICONTENTPLUGINMANAGER_H
#define C_AICONTENTPLUGINMANAGER_H

#include <e32base.h>
#include "aicontentmodel.h"
#include "aicontentpublisher.h"
#include "aifwdefs.h"
#include "aipluginsettings.h"
#include "aipluginfactory.h"

class MAiContentObserver;
class MAiEventHandlerExtension;
class MAiPluginTool;
class CAiContentPublisher;
class CAiPluginStateManager;
class CAiUiController;
class CImplementationInformation;

/**
 * @ingroup group_aifw
 * 
 *  Content plugin manager class for Active idle framework.
 *
 *  @lib aifw_hs
 *  @since S60 3.2
 */
NONSHARABLE_CLASS( CAiContentPluginManager ) : public CBase
                                               
	{
public: // Constructor and destructor	        	
		
    static CAiContentPluginManager* NewL();
                                              
    virtual ~CAiContentPluginManager();
		    
public: // New functions
    
    /**
     * Forward plugin event to plugins.
     *
     * @since S60 3.2
     * @param aParam event string.
     */
    void HandlePluginEvent( const TDesC& aParam );

    /**
     * Forward plugin event to plugins.
     *
     * @since S60 5.0
     * @param aPublisherInfo publisher info.
     * @param aParam event string.
     */
    void HandlePluginEventL( const TAiPublisherInfo& aPublisherInfo, const TDesC& aParam ); 
            
    /**
     * Queries wheter a plugin has settigns or not.
     */
    TBool HasMenuItemL( const TAiPublisherInfo& aPublisherInfo, const TDesC& aMenuItem );

    /**
     * Requests a Content publisher plug-in to refresh a content item.
     */
    TBool RefreshContent( const TDesC& aContentCid );

    /**
     * Sets plugins to online/offline
     * 
     * @since S60 5.0
     * @param aOnline ETrue to set plugins online, EFalse to offline
     * @paran aPublishers List of publishers
     */    
    void ProcessOnlineState( TBool aOnline );
            
    /**
     * Gets plugin state manager.     
     *
     * @since S60 5.0
     * @return plugin state manager.
     */        
    CAiPluginStateManager& StateManager() const;

    /**
     * Gets plugin factory.     
     *
     * @since S60 5.0
     * @return plugin factory.
     */        
    CAiPluginFactory& PluginFactory() const;
    
    
private: // Constructors

    CAiContentPluginManager();
                             
    void ConstructL();

private: // New functions
                                        
    void GetIdL( CAiContentPublisher& aContentPublisher,
                 TAiPublisherProperty aProperty,            
                 const TDesC& aName, TInt& aId ); 
            
    TInt RefreshContentL( const TDesC& aContentCid );

private: // Data

    /**
     * Plugins array.
     * Owned. 
     */
    RPointerArray< CAiContentPublisher > iPlugins;

    /**
     * Plugin factory.
     * Owned.
     */
    CAiPluginFactory* iPluginFactory;
    
    /**
     * System state observer.
     * Owned.
     */    
    CAiPluginStateManager* iStateManager;
    
    /**
     * Plugin tool from utility lib.
     * Owned.
     */
    MAiPluginTool* iPluginTool;     
    };

#endif // C_AICONTENTPLUGINMANAGER_H

// End of File.