1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/ossrv/lowlevellibsandfws/pluginfw/Framework/frame/Interface.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,156 @@
1.4 +// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of "Eclipse Public License v1.0"
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +// This file contains the Interface Definition for the
1.18 +// CExampleInterface class.
1.19 +//
1.20 +//
1.21 +
1.22 +#if defined (_MSC_VER) && (_MSC_VER >= 1000)
1.23 +#pragma once
1.24 +#endif
1.25 +#ifndef _INC_INTERFACE_3A1D07A10155_INCLUDED
1.26 +#define _INC_INTERFACE_3A1D07A10155_INCLUDED
1.27 +
1.28 +#include <e32base.h>
1.29 +
1.30 +#include <ecom/ecom.h>
1.31 +
1.32 +/**
1.33 + @internalComponent
1.34 + @since 7.0
1.35 + An example abstract class being representative of the
1.36 + concrete class which the client wishes to use.
1.37 + It acts as a base, for a real class to provide all the
1.38 + functionality that a client requires.
1.39 + It supplies instantiation & destruction by using
1.40 + the ECom framework, and functional services
1.41 + by using the methods of the actual class.
1.42 + */
1.43 +
1.44 +class CExampleInterface : public CActive
1.45 +{
1.46 +public:
1.47 + // The interface for passing initialisation parameters
1.48 + // to the derived class constructor.
1.49 + typedef struct _exampleInterfaceInitParams
1.50 + {
1.51 + TInt integer;
1.52 + const TDesC* descriptor;
1.53 + } TExampleInterfaceInitParams;
1.54 +
1.55 + //The function which instantiates an object of this type
1.56 + //(eg NewL for a CBase derived object).
1.57 +
1.58 + static CExampleInterface* NewL();
1.59 +
1.60 + //The function which instantiates an object of this type
1.61 + // using the MatchString as the resolver parameters.
1.62 + //(eg NewL for a CBase derived object).
1.63 + static CExampleInterface* NewL(const TDesC8& aMatchString);
1.64 +
1.65 + //The function which instantiates an object of this type with the required parameters
1.66 + //(eg NewL for a CBase derived object).
1.67 +
1.68 + static CExampleInterface* NewL(TInt aIntParameterTest, const TDesC& aDesParameterTest);
1.69 +
1.70 + //The function which instantiates an object of this type
1.71 + //using ImplementationUid as a resolution parameter.
1.72 + //(eg NewL for a CBase derived object).
1.73 + static CExampleInterface* NewL2(const TUid aImplementationUid);
1.74 +
1.75 + //The function which instantiates an object of this type
1.76 + //(eg NewL for a CBase derived object).
1.77 + static CExampleInterface* NewL3();
1.78 +
1.79 + //The function which instantiates an object of this type
1.80 + //(eg NewL for a CBase derived object).
1.81 + static CExampleInterface* NewL4();
1.82 +
1.83 + //The functions which instantiate object of this type with extended interface
1.84 + static CExampleInterface* NewL5();
1.85 + static CExampleInterface* NewL6();
1.86 + static CExampleInterface* NewL7();
1.87 + static CExampleInterface* NewL8();
1.88 +
1.89 + //Standardised destructor.
1.90 + virtual ~CExampleInterface();
1.91 +
1.92 + //Request a list of all available implementations which
1.93 + //satisfy this given interface.
1.94 +
1.95 + static void ListImplementationsL(RImplInfoPtrArray& aImplInfoArray);
1.96 + static void ListAllImplementationsL(RImplInfoPtrArray& aImplInfoArray);
1.97 +
1.98 +
1.99 + //Pure interface method
1.100 + //Representative of a method provided on the interface by
1.101 + //the interface definer.
1.102 +
1.103 + virtual void DoMethodL() = 0;
1.104 +
1.105 + //Pure interface method
1.106 + //Representative of an asynchronous function which
1.107 + //an interface definer could specify.
1.108 + //It allows the client to call the function in the knowledge
1.109 + //that the object will commit suicide when the
1.110 + //function completes.
1.111 +
1.112 + virtual TInt FireAndForget() = 0;
1.113 +
1.114 + //Pure interface method,
1.115 + //Used to cross check the implementation returned by ECOM.
1.116 + virtual TUid ImplId() = 0;
1.117 +public:
1.118 + // Wrapper methods which get and release the extended interface using
1.119 + // the member iDtor_ID_Key
1.120 + TAny* GetExtendedInterfaceL(const TUid& aInterfaceUid);
1.121 + void ManuallyReleaseExtendedInterfaceL(const TUid& aInterfaceUid);
1.122 +
1.123 +protected:
1.124 + //Default c'tor
1.125 + inline CExampleInterface();
1.126 +
1.127 +//Attributes
1.128 +private:
1.129 +
1.130 + TUid iDtor_ID_Key;
1.131 +
1.132 + // Declare the Test bed state accessor as a friend
1.133 + friend class TExampleInterface_StateAccessor;
1.134 +
1.135 +};
1.136 +
1.137 +// Example extended interface classes
1.138 +class MExampleInterfaceExtended
1.139 +{
1.140 +public:
1.141 + //Pure interface method
1.142 + //Representative of a method provided on the interface by
1.143 + //the interface definer.
1.144 + virtual void DoMethodExtended() = 0;
1.145 +};
1.146 +
1.147 +class MExampleInterfaceExtended2
1.148 +{
1.149 +public:
1.150 +
1.151 + //Pure interface method
1.152 + //Representative of a method provided on the interface by
1.153 + //the interface definer.
1.154 + virtual void DoMethodExtended2() = 0;
1.155 +};
1.156 +#include "Interface.inl"
1.157 +
1.158 +#endif /* _INC_INTERFACE_3A1D07A10155_INCLUDED */
1.159 +