epoc32/include/mw/screensaverpluginintdef.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100 (2010-03-31)
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@2
     1
/*
williamr@2
     2
* Copyright (c) 2004 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@4
     5
* under the terms of "Eclipse Public License v1.0"
williamr@2
     6
* which accompanies this distribution, and is available
williamr@4
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@2
    14
* Description:  Defines screensaver plugin Ecom interface.
williamr@2
    15
*
williamr@2
    16
*/
williamr@2
    17
williamr@2
    18
#ifndef SCREEN_SAVER_PLUGIN_INT_DEF_H
williamr@2
    19
#define SCREEN_SAVER_PLUGIN_INT_DEF_H
williamr@2
    20
williamr@2
    21
//  INCLUDES
williamr@2
    22
#include <e32base.h>
williamr@4
    23
#include <ecom/implementationinformation.h>
williamr@4
    24
#include <screensaverplugin.h>
williamr@2
    25
williamr@2
    26
// CONSTANTS
williamr@2
    27
williamr@2
    28
// MACROS
williamr@2
    29
williamr@2
    30
// DATA TYPES
williamr@2
    31
williamr@2
    32
// FUNCTION PROTOTYPES
williamr@2
    33
williamr@2
    34
// FORWARD DECLARATIONS
williamr@2
    35
williamr@2
    36
// CLASS DECLARATION
williamr@2
    37
williamr@2
    38
/**
williamr@2
    39
* This base class for screensaver ECom plugin implemenation. Every plugin module
williamr@2
    40
* must inherit and implement this class. 
williamr@2
    41
*/
williamr@2
    42
class CScreensaverPluginInterfaceDefinition: public CBase,
williamr@2
    43
                                             public MScreensaverPlugin
williamr@2
    44
    {
williamr@2
    45
    public:         
williamr@2
    46
        /*
williamr@2
    47
        * Function which instantiates an object of this type
williamr@2
    48
        */
williamr@2
    49
        inline static CScreensaverPluginInterfaceDefinition* NewL(TUid aImplementationUid);
williamr@2
    50
williamr@2
    51
        /*
williamr@2
    52
        * Function which lists the currently available screensaver implementations
williamr@2
    53
        *
williamr@2
    54
        * * @param aImplInfoArray A reference to a client-owned array, which on return
williamr@2
    55
        *                         is filled with interface implementation data.
williamr@2
    56
        *                         Any existing data in the array is destroyed.
williamr@2
    57
        */
williamr@2
    58
        inline static void ListImplementationsL(RImplInfoPtrArray& aImplInfoArray);
williamr@2
    59
williamr@2
    60
		/**
williamr@2
    61
		*  Virtual desctructor.
williamr@2
    62
		*/
williamr@2
    63
		inline virtual ~CScreensaverPluginInterfaceDefinition();
williamr@2
    64
williamr@2
    65
    private:
williamr@2
    66
        /**
williamr@2
    67
        *  Required attribute for the framework
williamr@2
    68
        *  (An identifier used during destruction)
williamr@2
    69
        */
williamr@2
    70
        TUid iDtor_ID_Key;
williamr@2
    71
    };
williamr@2
    72
williamr@2
    73
#include "ScreensaverpluginIntDef.inl"
williamr@2
    74
williamr@2
    75
#endif   // SCREEN_SAVER_PLUGIN_INT_DEF_H
williamr@2
    76
// End of file.