remotecontrol/remotecontrolfw/client/extapi1/public/remconabsvolcontroller.h
author hgs
Wed, 13 Oct 2010 16:20:29 +0300
changeset 51 20ac952a623c
permissions -rw-r--r--
201040_02
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
51
20ac952a623c 201040_02
hgs
parents:
diff changeset
     1
// Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
20ac952a623c 201040_02
hgs
parents:
diff changeset
     2
// All rights reserved.
20ac952a623c 201040_02
hgs
parents:
diff changeset
     3
// This component and the accompanying materials are made available
20ac952a623c 201040_02
hgs
parents:
diff changeset
     4
// under the terms of "Eclipse Public License v1.0"
20ac952a623c 201040_02
hgs
parents:
diff changeset
     5
// which accompanies this distribution, and is available
20ac952a623c 201040_02
hgs
parents:
diff changeset
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
20ac952a623c 201040_02
hgs
parents:
diff changeset
     7
//
20ac952a623c 201040_02
hgs
parents:
diff changeset
     8
// Initial Contributors:
20ac952a623c 201040_02
hgs
parents:
diff changeset
     9
// Nokia Corporation - initial contribution.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    10
//
20ac952a623c 201040_02
hgs
parents:
diff changeset
    11
// Contributors:
20ac952a623c 201040_02
hgs
parents:
diff changeset
    12
//
20ac952a623c 201040_02
hgs
parents:
diff changeset
    13
// Description:
20ac952a623c 201040_02
hgs
parents:
diff changeset
    14
//
20ac952a623c 201040_02
hgs
parents:
diff changeset
    15
20ac952a623c 201040_02
hgs
parents:
diff changeset
    16
/**
20ac952a623c 201040_02
hgs
parents:
diff changeset
    17
 @file
20ac952a623c 201040_02
hgs
parents:
diff changeset
    18
 @publishedAll
20ac952a623c 201040_02
hgs
parents:
diff changeset
    19
 @released
20ac952a623c 201040_02
hgs
parents:
diff changeset
    20
*/
20ac952a623c 201040_02
hgs
parents:
diff changeset
    21
20ac952a623c 201040_02
hgs
parents:
diff changeset
    22
#ifndef REMCONABSVOLCONTROLLER_H
20ac952a623c 201040_02
hgs
parents:
diff changeset
    23
#define REMCONABSVOLCONTROLLER_H
20ac952a623c 201040_02
hgs
parents:
diff changeset
    24
20ac952a623c 201040_02
hgs
parents:
diff changeset
    25
#include <e32base.h>
20ac952a623c 201040_02
hgs
parents:
diff changeset
    26
#include <remcon/remconinterfacebase.h>
20ac952a623c 201040_02
hgs
parents:
diff changeset
    27
#include <remcon/remconinterfaceif.h>
20ac952a623c 201040_02
hgs
parents:
diff changeset
    28
20ac952a623c 201040_02
hgs
parents:
diff changeset
    29
class MRemConAbsVolControllerObserver;
20ac952a623c 201040_02
hgs
parents:
diff changeset
    30
class CRemConInterfaceSelector;
20ac952a623c 201040_02
hgs
parents:
diff changeset
    31
20ac952a623c 201040_02
hgs
parents:
diff changeset
    32
/**
20ac952a623c 201040_02
hgs
parents:
diff changeset
    33
Client-instantiable type supporting sending AbsVol API responses.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    34
*/
20ac952a623c 201040_02
hgs
parents:
diff changeset
    35
NONSHARABLE_CLASS(CRemConAbsVolController) : public CRemConInterfaceBase, 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    36
								             public MRemConInterfaceIf
20ac952a623c 201040_02
hgs
parents:
diff changeset
    37
	{
20ac952a623c 201040_02
hgs
parents:
diff changeset
    38
public:
20ac952a623c 201040_02
hgs
parents:
diff changeset
    39
	/**
20ac952a623c 201040_02
hgs
parents:
diff changeset
    40
	Factory function.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    41
	@param aInterfaceSelector The interface selector. The client must have 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    42
	created one of these first.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    43
	@param aObserver The observer of this interface.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    44
	@return A new CRemConAbsVolController, owned by the interface selector.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    45
	*/
20ac952a623c 201040_02
hgs
parents:
diff changeset
    46
	IMPORT_C static CRemConAbsVolController* NewL(CRemConInterfaceSelector& aInterfaceSelector, 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    47
		MRemConAbsVolControllerObserver& aObserver);
20ac952a623c 201040_02
hgs
parents:
diff changeset
    48
	
20ac952a623c 201040_02
hgs
parents:
diff changeset
    49
	/** Destructor. */
20ac952a623c 201040_02
hgs
parents:
diff changeset
    50
	IMPORT_C ~CRemConAbsVolController();
20ac952a623c 201040_02
hgs
parents:
diff changeset
    51
20ac952a623c 201040_02
hgs
parents:
diff changeset
    52
public:
20ac952a623c 201040_02
hgs
parents:
diff changeset
    53
	/**
20ac952a623c 201040_02
hgs
parents:
diff changeset
    54
	Sends a 'get absolute volume' command. The absolute volume will be 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    55
	returned in response(s) via the observer interface.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    56
	Only one command per controller session can be outstanding at any one time.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    57
	@param aStatus Used by RemCon to indicate completion of the send request. 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    58
	@param aNumRemotes The number of remotes to which the command was sent.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    59
	*/
20ac952a623c 201040_02
hgs
parents:
diff changeset
    60
	IMPORT_C void GetAbsoluteVolume(TRequestStatus& aStatus, TUint& aNumRemotes);
20ac952a623c 201040_02
hgs
parents:
diff changeset
    61
20ac952a623c 201040_02
hgs
parents:
diff changeset
    62
	/**
20ac952a623c 201040_02
hgs
parents:
diff changeset
    63
	Sends a 'set absolute volume' command. The volume is set to aAbsVol, on a 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    64
	range of zero to aMaxVol. Any responses will be returned via the observer 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    65
	interface.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    66
	Only one command per controller session can be outstanding at any one time.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    67
	@param aStatus Used by RemCon to indicate completion of the send request.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    68
	@param aAbsVol The relative volume.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    69
	@param aMaxVol The maximum against which aAbsVol is relative.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    70
	@param aNumRemotes The number of remotes to which the command was sent.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    71
	*/
20ac952a623c 201040_02
hgs
parents:
diff changeset
    72
	IMPORT_C void SetAbsoluteVolume(TRequestStatus& aStatus, TUint aAbsVol, TUint aMaxVol, TUint& aNumRemotes);
20ac952a623c 201040_02
hgs
parents:
diff changeset
    73
20ac952a623c 201040_02
hgs
parents:
diff changeset
    74
private:
20ac952a623c 201040_02
hgs
parents:
diff changeset
    75
	/** 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    76
	Constructor.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    77
	@param aInterfaceSelector The interface selector.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    78
	@param aObserver The observer of this interface.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    79
	*/
20ac952a623c 201040_02
hgs
parents:
diff changeset
    80
	CRemConAbsVolController(CRemConInterfaceSelector& aInterfaceSelector, 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    81
		MRemConAbsVolControllerObserver& aObserver);
20ac952a623c 201040_02
hgs
parents:
diff changeset
    82
20ac952a623c 201040_02
hgs
parents:
diff changeset
    83
private: // from CRemConInterfaceBase
20ac952a623c 201040_02
hgs
parents:
diff changeset
    84
	TAny* GetInterfaceIf(TUid aUid);
20ac952a623c 201040_02
hgs
parents:
diff changeset
    85
20ac952a623c 201040_02
hgs
parents:
diff changeset
    86
private: // from MRemConInterfaceIf
20ac952a623c 201040_02
hgs
parents:
diff changeset
    87
	void MrcibNewMessage(TUint aOperationId, const TDesC8& aData);
20ac952a623c 201040_02
hgs
parents:
diff changeset
    88
20ac952a623c 201040_02
hgs
parents:
diff changeset
    89
private: // unowned
20ac952a623c 201040_02
hgs
parents:
diff changeset
    90
	MRemConAbsVolControllerObserver& iObserver;
20ac952a623c 201040_02
hgs
parents:
diff changeset
    91
20ac952a623c 201040_02
hgs
parents:
diff changeset
    92
private: // owned
20ac952a623c 201040_02
hgs
parents:
diff changeset
    93
	static const TUint KMaxOperationDataSize = 0x20;
20ac952a623c 201040_02
hgs
parents:
diff changeset
    94
	TBuf8<KMaxOperationDataSize> iOutData;
20ac952a623c 201040_02
hgs
parents:
diff changeset
    95
	};
20ac952a623c 201040_02
hgs
parents:
diff changeset
    96
20ac952a623c 201040_02
hgs
parents:
diff changeset
    97
#endif // REMCONABSVOLCONTROLLER_H