epoc32/include/mw/screensaverpluginintdef.h
branchSymbian2
changeset 2 2fe1408b6811
parent 1 666f914201fb
child 4 837f303aceeb
     1.1 --- a/epoc32/include/mw/screensaverpluginintdef.h	Tue Nov 24 13:55:44 2009 +0000
     1.2 +++ b/epoc32/include/mw/screensaverpluginintdef.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -1,1 +1,76 @@
     1.4 -screensaverpluginintdef.h
     1.5 +/*
     1.6 +* Copyright (c) 2004 Nokia Corporation and/or its subsidiary(-ies).
     1.7 +* All rights reserved.
     1.8 +* This component and the accompanying materials are made available
     1.9 +* 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
    1.10 +* which accompanies this distribution, and is available
    1.11 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.12 +*
    1.13 +* Initial Contributors:
    1.14 +* Nokia Corporation - initial contribution.
    1.15 +*
    1.16 +* Contributors:
    1.17 +*
    1.18 +* Description:  Defines screensaver plugin Ecom interface.
    1.19 +*
    1.20 +*/
    1.21 +
    1.22 +#ifndef SCREEN_SAVER_PLUGIN_INT_DEF_H
    1.23 +#define SCREEN_SAVER_PLUGIN_INT_DEF_H
    1.24 +
    1.25 +//  INCLUDES
    1.26 +#include <e32base.h>
    1.27 +#include <Ecom/ImplementationInformation.h>
    1.28 +#include <Screensaverplugin.h>
    1.29 +
    1.30 +// CONSTANTS
    1.31 +
    1.32 +// MACROS
    1.33 +
    1.34 +// DATA TYPES
    1.35 +
    1.36 +// FUNCTION PROTOTYPES
    1.37 +
    1.38 +// FORWARD DECLARATIONS
    1.39 +
    1.40 +// CLASS DECLARATION
    1.41 +
    1.42 +/**
    1.43 +* This base class for screensaver ECom plugin implemenation. Every plugin module
    1.44 +* must inherit and implement this class. 
    1.45 +*/
    1.46 +class CScreensaverPluginInterfaceDefinition: public CBase,
    1.47 +                                             public MScreensaverPlugin
    1.48 +    {
    1.49 +    public:         
    1.50 +        /*
    1.51 +        * Function which instantiates an object of this type
    1.52 +        */
    1.53 +        inline static CScreensaverPluginInterfaceDefinition* NewL(TUid aImplementationUid);
    1.54 +
    1.55 +        /*
    1.56 +        * Function which lists the currently available screensaver implementations
    1.57 +        *
    1.58 +        * * @param aImplInfoArray A reference to a client-owned array, which on return
    1.59 +        *                         is filled with interface implementation data.
    1.60 +        *                         Any existing data in the array is destroyed.
    1.61 +        */
    1.62 +        inline static void ListImplementationsL(RImplInfoPtrArray& aImplInfoArray);
    1.63 +
    1.64 +		/**
    1.65 +		*  Virtual desctructor.
    1.66 +		*/
    1.67 +		inline virtual ~CScreensaverPluginInterfaceDefinition();
    1.68 +
    1.69 +    private:
    1.70 +        /**
    1.71 +        *  Required attribute for the framework
    1.72 +        *  (An identifier used during destruction)
    1.73 +        */
    1.74 +        TUid iDtor_ID_Key;
    1.75 +    };
    1.76 +
    1.77 +#include "ScreensaverpluginIntDef.inl"
    1.78 +
    1.79 +#endif   // SCREEN_SAVER_PLUGIN_INT_DEF_H
    1.80 +// End of file.