videofeeds/server/IptvEpgManager/inc/CIptvEpgPluginInterface.h
changeset 0 96612d01cf9f
equal deleted inserted replaced
-1:000000000000 0:96612d01cf9f
       
     1 /*
       
     2 * Copyright (c) 2004-2008 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 the License "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: 
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 
       
    21 #ifndef CIPTVEPGPLUGININTERFACE_H
       
    22 #define CIPTVEPGPLUGININTERFACE_H
       
    23 
       
    24 #include <e32base.h>
       
    25 #include <ecom/ecom.h>
       
    26 #include "MIptvEpgVodCallback.h"
       
    27 #include "MIptvEpgLiveTvCallback.h"
       
    28 
       
    29 #include "CIptvEpgService.h"
       
    30 
       
    31 class CIptvEpgPluginInterface : public CBase
       
    32 	{
       
    33 	public:
       
    34 
       
    35 	    /**
       
    36 	     * RSS Parser states.
       
    37 	     */
       
    38 	    typedef enum
       
    39 	        {
       
    40 	        EIptvRssNone,
       
    41 	        EIptvRssService,
       
    42 	        EIptvRssSearch,
       
    43 	        EIptvRssServiceGroup,
       
    44 	        EIptvRssAddServiceThumbnailToDlQueue,
       
    45 	        EIptvRssAddItemThumbnailToDlQueue
       
    46 	        } TIptvRSSAction;
       
    47 
       
    48 	    /**
       
    49          * Two-phased constructor.
       
    50          *
       
    51          * @param aImplementationUid Plugin UID.
       
    52          */
       
    53 		static CIptvEpgPluginInterface* NewL(const TUid aImplementationUid);
       
    54 		
       
    55 		/**
       
    56          * Destructor.
       
    57          */
       
    58 		virtual ~CIptvEpgPluginInterface();
       
    59 		
       
    60 		/**
       
    61          * Run plugin.
       
    62          */
       
    63 		virtual void RunPlugin() = 0;
       
    64 
       
    65         /**
       
    66          * Set callback pointer to MIptvEpgVodCallback. Plugin uses 
       
    67          * MIptvEpgVodCallback interface to supply Epg data to system.
       
    68          *
       
    69          * @param aVodCallback Pointer to callback interface.
       
    70          */
       
    71         virtual void SetVodCallback(MIptvEpgVodCallback* aVodCallback) = 0;
       
    72 
       
    73         /**
       
    74          * Set callback pointer to MIptvEpgLiveTvCallback.
       
    75          *
       
    76          * @param aLiveTvCallback Pointer to callback interface.
       
    77          */
       
    78         virtual void SetLiveTvCallback(MIptvEpgLiveTvCallback* aLiveTvCallback) = 0;
       
    79 
       
    80         /**
       
    81          * Set service information to plugin.
       
    82          */
       
    83         virtual void SetServiceInformation(
       
    84             CIptvEpgService* aService,
       
    85             TBool aUseSearchAddress = EFalse ) = 0;
       
    86 
       
    87         /**
       
    88          * Set service information to plugin.
       
    89          */
       
    90         virtual void SetServiceInformationL(
       
    91             CIptvEpgService* aService,
       
    92             TIptvRSSAction aAction ) = 0;
       
    93 
       
    94         /**
       
    95          * Set first update.
       
    96          *
       
    97          * @param aFirstUpdate aFirstUpdate is ETrue if plugin in running first time
       
    98          *                     after EPG database is created.
       
    99          */
       
   100         virtual void SetFirstUpdate( TBool aFirstUpdate ) = 0;
       
   101 		
       
   102 	private:
       
   103 		TUid iDestructorIDKey;
       
   104 	};
       
   105 
       
   106 // This includes the implementation of the ECOM instantiation functions and destructor
       
   107 #include "CIptvEpgPluginInterface.inl"
       
   108 
       
   109 #endif  // CIPTVEPGPLUGININTERFACE_H