clock2/clockengines/clocknitzplugin/inc/clocknitzplugin.h
changeset 0 f979ecb2b13e
child 86 ed599363c2d7
equal deleted inserted replaced
-1:000000000000 0:f979ecb2b13e
       
     1 /*
       
     2 * Copyright (c) 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 "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:   The header file of the CClockNitzPlugin class.
       
    15 *
       
    16 */
       
    17 
       
    18 #ifndef __CLOCKNITZ_PLUGIN_H__ 
       
    19 #define __CLOCKNITZ_PLUGIN_H__
       
    20 
       
    21 // System includes
       
    22 #include <etelmm.h>
       
    23 
       
    24 // User includes
       
    25 #include "clocktimesourceinterface.h"
       
    26 
       
    27 // Forward declarations
       
    28 class CClockNitzPluginImpl;
       
    29 
       
    30 // Constants
       
    31 static const TInt KNitzPluginId( 0x200159A5 );
       
    32 
       
    33 // Class declaration
       
    34 /** 
       
    35 * @class CClockNitzPlugin
       
    36 * @brief An instance of class CClockNitzPlugin which is an implementation of the
       
    37 *		 interface CClockTimeSourceInterface.
       
    38 * @dll clocknitzplugin.dll 
       
    39 */
       
    40 class CClockNitzPlugin : public CClockTimeSourceInterface
       
    41 	{
       
    42 	public:				// Constructor and destructor
       
    43 	
       
    44 		/**
       
    45 		* @brief Creates a CClockNitzPlugin object
       
    46 		* @return CClockNitzPlugin*
       
    47 		*/
       
    48         static CClockNitzPlugin* NewL();
       
    49 		
       
    50 		/**
       
    51 		* @brief Destroy the object and release all memory objects
       
    52 		*/
       
    53 	    virtual ~CClockNitzPlugin();
       
    54 	    
       
    55 	public:				// From base classes
       
    56 	
       
    57 		/**
       
    58 		* @brief From CClockTimeSourceInterface, pure virtual at the base. Need to implement here.
       
    59 		* @param aInterfaceAttribute of type TInterfaceAttribute, indicates the type of data requested.
       
    60 		* @param aTimeAttributes The type of data requested
       
    61 		*/
       
    62 		void GetTimeInformationL( TInterfaceAttribute aInterfaceAttribute, STimeAttributes* aTimeAttributes );
       
    63 		
       
    64 		/**
       
    65 		* @brief From CClockTimeSourceInterface, pure virtual at the base. Need to implement here.
       
    66 		* @param aInterfaceAttribute of type TInterfaceAttribute, indicates the type of data requested.
       
    67 		*/
       
    68 		virtual void NotifyOnTimeChange( TInterfaceAttribute aInterfaceAttribute );
       
    69 		
       
    70 		/**
       
    71 		* @brief Returns the plugin implementation id. Unique for each plugin.
       
    72 		* @return TInt The Uid of the plugin.
       
    73 		*/
       
    74 		TInt GetPluginUid();
       
    75 		
       
    76 		/**
       
    77 		* @brief Notifies any client in case NITZ info is received
       
    78 		*/
       
    79 		void NotifyNITZInfoChangeL();
       
    80 		
       
    81 	private:			// New functions
       
    82 		
       
    83 		/** 
       
    84 		* @brief Symbian OS 2nd phase constructor is private.
       
    85 		*/
       
    86 	    void ConstructL();
       
    87 		
       
    88 	private:			// Data
       
    89 	
       
    90 		/**
       
    91 		* @var iNitzPluginImpl
       
    92 		* @brief An object of type CClockNitzPluginImpl
       
    93 		*/
       
    94 		CClockNitzPluginImpl* 			iNitzPluginImpl;
       
    95 	};
       
    96 
       
    97 #endif	// __CLOCKNITZ_PLUGIN_H__
       
    98 
       
    99 // End of file
       
   100