1.1 --- a/epoc32/include/mtuireg.h Tue Mar 16 16:12:26 2010 +0000
1.2 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000
1.3 @@ -1,92 +0,0 @@
1.4 -// Copyright (c) 1998-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 the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
1.8 -// which accompanies this distribution, and is available
1.9 -// at the URL "http://www.symbianfoundation.org/legal/licencesv10.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 -// MTM client-side MTMUI registry class
1.18 -//
1.19 -//
1.20 -
1.21 -#if !defined __MTUIREG_H__
1.22 -#define __MTUIREG_H__
1.23 -
1.24 -
1.25 -#if !defined (__E32BASE_H__)
1.26 -#include <e32base.h> // CActive, TFileName etc.
1.27 -#endif
1.28 -
1.29 -#if !defined (__MTCLREG_H__)
1.30 -#include <mtclreg.h>
1.31 -#endif
1.32 -
1.33 -class CBaseMtmUi;
1.34 -
1.35 -/** UI MTM factory function.
1.36 -
1.37 -A concrete User Interface MTM must implement an exported factory function of
1.38 -this type. It should return an instance of the CBaseMtmUi-derived class that
1.39 -provides the implementation. The factory function is called by the User Interface
1.40 -MTM registry when a client requests this User Interface MTM.
1.41 -
1.42 -A CBaseMtmUi-derived class typically provides a NewL() function, which the
1.43 -factory function calls.
1.44 -
1.45 -The factory function is called by ordinal. The ordinal of the function must
1.46 -match that recorded in the MTM's registry information.
1.47 -
1.48 -For example, a User Interface MTM whose concrete class was CEgMtmUi could
1.49 -define a suitable factory function as:
1.50 -
1.51 -@code
1.52 -EXPORT_C CBaseMtmUi* NewEgMtmUiL(CBaseMtm& aMtm, CRegisteredMtmDll& aRegisteredDll)
1.53 - {
1.54 - return CEgMtmUi::NewL(aMtm, aRegisteredDll);
1.55 - }@endcode
1.56 -
1.57 -@param aBaseMtm The CBaseMtm requesting the object.
1.58 -@param aRegisteredMtmDll Registration data for the MTM DLL.
1.59 -@return A newly-created instance of the CBaseMtmUi-derived class
1.60 -for the User Interface MTM.
1.61 -@leave Any The factory function should leave if it cannot create the object. */
1.62 -typedef CBaseMtmUi* MtmUiFactoryFunctionL(CBaseMtm&, CRegisteredMtmDll&);
1.63 -
1.64 -// Client side MTM registry
1.65 -
1.66 -class CMtmUiRegistry : public CObserverRegistry
1.67 -/** Accesses the User Interface MTM registry.
1.68 -
1.69 -This registry holds details of the
1.70 -all the User Interface MTMs currently available on the system. Message client
1.71 -applications use this class to get a CBaseMtmUi-derived object by which to
1.72 -access User Interface MTM functionality.
1.73 -
1.74 -Note that the base class CMtmDllRegistry provides functions for discovering
1.75 -what MTMs are present in the registry.
1.76 -@publishedAll
1.77 -@released
1.78 -*/
1.79 - {
1.80 -public:
1.81 - IMPORT_C static CMtmUiRegistry* NewL(CMsvSession& aMsvSession,
1.82 - TTimeIntervalMicroSeconds32 aTimeoutMicroSeconds32=TTimeIntervalMicroSeconds32(30000000));
1.83 - virtual ~CMtmUiRegistry();
1.84 - IMPORT_C CBaseMtmUi* NewMtmUiL(CBaseMtm& aMtm);
1.85 - //
1.86 -protected:
1.87 - CMtmUiRegistry(CMsvSession& aMsvSession, TTimeIntervalMicroSeconds32 aTimeoutMicroSeconds32);
1.88 - //
1.89 -private:
1.90 - CBaseMtmUi* NewMtmL(const RLibrary& aLib, CBaseMtm& aMtm, CRegisteredMtmDll& aReg) const;
1.91 - };
1.92 -
1.93 -
1.94 -
1.95 -#endif // __MTUIREG_H__