epoc32/include/remconabsvoltarget.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
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.

// Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
// All rights reserved.
// This component and the accompanying materials are made available
// under the terms of "Eclipse Public License v1.0"
// which accompanies this distribution, and is available
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
//
// Initial Contributors:
// Nokia Corporation - initial contribution.
//
// Contributors:
//
// Description:
//

/**
 @file
 @publishedAll
 @released
*/

#ifndef REMCONABSVOLTARGET_H
#define REMCONABSVOLTARGET_H

#include <e32base.h>
#include <remcon/remconinterfacebase.h>
#include <remcon/remconinterfaceif.h>

class MRemConAbsVolTargetObserver;
class CRemConInterfaceSelector;

/**
Client-instantiable type supporting sending AbsVol API responses.
*/
NONSHARABLE_CLASS(CRemConAbsVolTarget) : public CRemConInterfaceBase, 
								         public MRemConInterfaceIf
	{
public:
	/**
	Factory function.
	@param aInterfaceSelector The interface selector. The client must have 
	created one of these first.
	@param aObserver The observer of this interface.
	@return A new CRemConAbsVolTarget, owned by the interface selector.
	*/
	IMPORT_C static CRemConAbsVolTarget* NewL(CRemConInterfaceSelector& aInterfaceSelector, 
		MRemConAbsVolTargetObserver& aObserver);
	
	/** Destructor. */
	IMPORT_C ~CRemConAbsVolTarget();

public:
	/**
	Sends a response to a 'get absolute volume' command.
	Only one response per target session can be outstanding at any one time.
	@param aStatus Used by RemCon to indicate completion of the send request.
	@param aAbsVol The volume, on a scale of 0 to aMaxVol.
	@param aMaxVol The maximum volume, to which aAbsVol is relative.
	@param aError The response error.
	*/
	IMPORT_C void GetAbsoluteVolumeResponse(TRequestStatus& aStatus, 
		TUint aAbsVol, 
		TUint aMaxVol, 
		TInt aError);

	/**
	Sends a response to a 'set absolute volume' command.
	Only one response per target session can be outstanding at any one time.
	@param aStatus Used by RemCon to indicate completion of the request.
	@param aError The response error.
	*/
	IMPORT_C void SetAbsoluteVolumeResponse(TRequestStatus& aStatus, 
		TInt aError);

private:
	/** 
	Constructor.
	@param aInterfaceSelector The interface selector.
	@param aObserver The observer of this interface.
	*/
	CRemConAbsVolTarget(CRemConInterfaceSelector& aInterfaceSelector, 
		MRemConAbsVolTargetObserver& aObserver);

private: // from CRemConInterfaceBase
	TAny* GetInterfaceIf(TUid aUid);

private: // from MRemConInterfaceIf
	void MrcibNewMessage(TUint aOperationId, const TDesC8& aData);

private: // unowned
	MRemConAbsVolTargetObserver& iObserver;

private: // owned
	// For operation-specific data.
	static const TUint KMaxOperationDataSize = 0x20;
	TBuf8<KMaxOperationDataSize> iOutData;
	
	// not used by this class, but required for calling RRemCon::Send ...
	TUint iNumRemotes;
	
	};

#endif // REMCONABSVOLTARGET_H