1 screensaverpluginintdef.h

     1 /*

     2 * Copyright (c) 2004 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 "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:  Defines screensaver plugin Ecom interface.

    15 *

    16 */

    17 

    18 #ifndef SCREEN_SAVER_PLUGIN_INT_DEF_H

    19 #define SCREEN_SAVER_PLUGIN_INT_DEF_H

    20 

    21 //  INCLUDES

    22 #include <e32base.h>

    23 #include <Ecom/ImplementationInformation.h>

    24 #include <Screensaverplugin.h>

    25 

    26 // CONSTANTS

    27 

    28 // MACROS

    29 

    30 // DATA TYPES

    31 

    32 // FUNCTION PROTOTYPES

    33 

    34 // FORWARD DECLARATIONS

    35 

    36 // CLASS DECLARATION

    37 

    38 /**

    39 * This base class for screensaver ECom plugin implemenation. Every plugin module

    40 * must inherit and implement this class. 

    41 */

    42 class CScreensaverPluginInterfaceDefinition: public CBase,

    43                                              public MScreensaverPlugin

    44     {

    45     public:         

    46         /*

    47         * Function which instantiates an object of this type

    48         */

    49         inline static CScreensaverPluginInterfaceDefinition* NewL(TUid aImplementationUid);

    50 

    51         /*

    52         * Function which lists the currently available screensaver implementations

    53         *

    54         * * @param aImplInfoArray A reference to a client-owned array, which on return

    55         *                         is filled with interface implementation data.

    56         *                         Any existing data in the array is destroyed.

    57         */

    58         inline static void ListImplementationsL(RImplInfoPtrArray& aImplInfoArray);

    59 

    60 		/**

    61 		*  Virtual desctructor.

    62 		*/

    63 		inline virtual ~CScreensaverPluginInterfaceDefinition();

    64 

    65     private:

    66         /**

    67         *  Required attribute for the framework

    68         *  (An identifier used during destruction)

    69         */

    70         TUid iDtor_ID_Key;

    71     };

    72 

    73 #include "ScreensaverpluginIntDef.inl"

    74 

    75 #endif   // SCREEN_SAVER_PLUGIN_INT_DEF_H

    76 // End of file.