epoc32/include/caf/agent.h
branchSymbian2
changeset 2 2fe1408b6811
child 4 837f303aceeb
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/caf/agent.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -0,0 +1,78 @@
     1.4 +/*
     1.5 +* Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.6 +* All rights reserved.
     1.7 +* This component and the accompanying materials are made available
     1.8 +* under the terms of the License "Eclipse Public License v1.0"
     1.9 +* which accompanies this distribution, and is available
    1.10 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.11 +*
    1.12 +* Initial Contributors:
    1.13 +* Nokia Corporation - initial contribution.
    1.14 +*
    1.15 +* Contributors:
    1.16 +*
    1.17 +* Description: 
    1.18 +*
    1.19 +*/
    1.20 +
    1.21 +
    1.22 +
    1.23 +
    1.24 +/**
    1.25 + @file
    1.26 + @publishedPartner
    1.27 + @released
    1.28 +*/
    1.29 +
    1.30 +#ifndef __CAF_AGENT_H__
    1.31 +#define __CAF_AGENT_H__
    1.32 +
    1.33 +#include <e32base.h>
    1.34 +
    1.35 +/** Maximum length of an Agent name, a longer name will be truncated */
    1.36 +const TInt KMaxAgentNameLength = KMaxFileName;
    1.37 +const TInt KMaxSIDLength = 8;
    1.38 +
    1.39 +namespace ContentAccess
    1.40 +	{
    1.41 +
    1.42 +	/** Represents the name of a single CAF agent. This allows 
    1.43 +	applications to reference a particular agent within the 
    1.44 +	Content Access Framework.
    1.45 +
    1.46 +	@publishedPartner
    1.47 +	@released
    1.48 +	*/
    1.49 +	class TAgent 
    1.50 +		{
    1.51 +	public:
    1.52 +		/** The name of the agent 
    1.53 +		@return The name of the agent
    1.54 +		*/
    1.55 +		IMPORT_C const TDesC& Name() const;
    1.56 +
    1.57 +		/** The UID of the agent DLL
    1.58 +		@return The UID of the agent ECOM implementation DLL 
    1.59 +
    1.60 +		@internalComponent
    1.61 +		@released
    1.62 +		*/
    1.63 +		TUid ImplementationUid() const;
    1.64 +
    1.65 +		/** Set the value of this TAgent
    1.66 +		@param aName The name of the agent
    1.67 +		@param aUid The agent implementation Uid
    1.68 +		
    1.69 +		@internalComponent
    1.70 +		@released
    1.71 +		*/
    1.72 +		void SetValue(const TDesC& aName, TUid aUid);
    1.73 +
    1.74 +	private:
    1.75 +
    1.76 +		TBuf <KMaxAgentNameLength> iName;
    1.77 +		TUid iImplementationUid;
    1.78 +		};
    1.79 +	}
    1.80 +
    1.81 +#endif