lowlevellibsandfws/pluginfw/Framework/frame/RomOnlyResolver.h
changeset 0 e4d67989cc36
equal deleted inserted replaced
-1:000000000000 0:e4d67989cc36
       
     1 // Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies).
       
     2 // All rights reserved.
       
     3 // This component and the accompanying materials are made available
       
     4 // under the terms of "Eclipse Public License v1.0"
       
     5 // which accompanies this distribution, and is available
       
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     7 //
       
     8 // Initial Contributors:
       
     9 // Nokia Corporation - initial contribution.
       
    10 //
       
    11 // Contributors:
       
    12 //
       
    13 // Description:
       
    14 //
       
    15 
       
    16 
       
    17 #ifndef __ROMONLYRESOLVER_H__
       
    18 #define __ROMONLYRESOLVER_H__
       
    19 
       
    20 #include "DefaultResolver.h"
       
    21 #include "RegistryData.h"
       
    22 
       
    23 class TEComResolverParams;
       
    24 
       
    25 /**
       
    26 	@internalComponent
       
    27 	@since 7.0
       
    28 	Special resolver which controls the identification, (resolution), of which implementation 
       
    29 	will be used to satisfy an interface implementation instantiation. This version only allows
       
    30 	plug-ins which are installed in ROM or are updates of ones originally found in ROM.
       
    31  */
       
    32 class CRomOnlyResolver : public CDefaultResolver
       
    33 {
       
    34 public:
       
    35 /**
       
    36 	@fn				NewL(CRegistryData& aRegistry)
       
    37 	Intended Usage	: Standardized safe construction which leaves nothing 
       
    38 					on the cleanup stack.	
       
    39 	Error Condition	: Cannot fully construct because of memory limitations.	
       
    40 	@leave			KErrNoMemory
       
    41 	@since			7.0
       
    42 	@return			A pointer to the new class
       
    43 	@post			CRomOnlyResolver is fully constructed, 
       
    44 					and initialized.
       
    45  */
       
    46 	static CRomOnlyResolver* NewL(MPublicRegistry& aRegistry);
       
    47 
       
    48 /**
       
    49 	@fn				~CRomOnlyResolver()
       
    50 	Intended Usage	: Standard default d'tor	
       
    51 	Error Condition	: None	
       
    52 	@since			7.0
       
    53  */
       
    54 	~CRomOnlyResolver();
       
    55 
       
    56 /**
       
    57 	@fn				IdentifyImplementationL(TUid aInterfaceUid, 
       
    58 											const TEComResolverParams& aAdditionalParameters) const
       
    59 	Intended Usage	:	Request that the resolver identify the most appropriate 
       
    60 						interface implementation.
       
    61 	Error Condition	:	
       
    62 	@since			7.0
       
    63 	@param			aInterfaceUid The interface for which implementations are requested
       
    64 	@param			aAdditionalParameters Data to be used to refine the search further
       
    65 	@return			The Uid of the best fit interface implementation - KNullUid if no match is found
       
    66 	@pre 			Object is fully constructed and initialized
       
    67 	@post			Registry contents are not modified but registry keys may be updated
       
    68  */
       
    69 	TUid IdentifyImplementationL(TUid aInterfaceUid, 
       
    70 								 const TEComResolverParams& aAdditionalParameters)const ;
       
    71 
       
    72 /**
       
    73 	@fn				ListAllL(TUid aInterfaceUid, 
       
    74 							 const TEComResolverParams& aAdditionalParameters) const
       
    75 	Intended Usage	:	List all the implementations which satisfy the specified interface.
       
    76 	Error Condition	:	
       
    77 	@since			7.0
       
    78 	@param			aInterfaceUid The interface for which implementations are requested
       
    79 	@param			aAdditionalParameters Data to be used to refine the search further
       
    80 	@return			Pointer to an array of suitable implementations. Ownership of this array
       
    81 	is passed to the calling function.
       
    82 	@pre 			Object is fully constructed and initialized
       
    83 	@post			Registry contents are not modified but registry keys may be updated
       
    84  */
       
    85 	RImplInfoArray* ListAllL(TUid aInterfaceUid, 
       
    86 							 const TEComResolverParams& aAdditionalParameters)const ;
       
    87 
       
    88 private:
       
    89 /**
       
    90 	@internalComponent
       
    91 	@fn				CRomOnlyResolver(CRegistryData& aRegistry)
       
    92 	Intended Usage	: Standardized default c'tor	
       
    93 	Error Condition	: None	
       
    94 	@since			7.0
       
    95 	@post			CRomOnlyResolver is fully constructed
       
    96  */
       
    97 	explicit CRomOnlyResolver(MPublicRegistry& aRegistry);
       
    98 
       
    99 };
       
   100 
       
   101 #endif // __ROMONLYRESOLVER_H__
       
   102