Collapse all Symbian^3 Application Developer Library

MHWRMHapticsPluginCallback Class Reference

class MHWRMHapticsPluginCallback

Callback interface for the HWRMHaptics plugins. Used to return data and/or error codes from an asynchronous plugin calls.

Since: S60 5.1

Public Member Functions
void	PluginEnabled ( THWRMLogicalActuators , TBool )
void	ProcessResponseL ( TInt , TUint8 , const TDesC8 &)

Member Functions Documentation

PluginEnabled(THWRMLogicalActuators, TBool)

void	PluginEnabled	(	THWRMLogicalActuators	aActuator,
			TBool	aEnabled
		)	[pure virtual]

Method to indicate the state of the plugin to haptics subsystem. The value is directly forwarded to the user of the haptics subsystem, if it has requested notification of actuator status changes.

Plugin implementation should not assume that this information is always passed to the user or that it would affect its implementation. I.e. the plugin should be able to handle commands also when it is in disabled state, since the user may still request command processing from the plugin.

Note: When the plugin is instantiated, the initial state of the plugin should always be informed through this callback method. The user of haptics subsystem may use this information e.g. as a notification when to start playing haptics effect.

Parameters

THWRMLogicalActuators aActuator	Logical actuator type, whose state is informed by this call.
TBool aEnabled	Whether or not the plugin is currently enabled. If ETrue, the plugin is enabled and ready to be used. If EFalse, plugin is currently disabled and cannot perform commands passed to it.

ProcessResponseL(TInt, TUint8, const TDesC8 &)

void	ProcessResponseL	(	TInt	aCommandId,
			TUint8	aTransId,
			const TDesC8 &	aData
		)	[pure virtual]

Method to return data in response to a message from a HWRMHaptics plugin. Related ProcessCommandL call must return before this method can be called.

Parameters

TInt aCommandId	Command ID for which the response comes
TUint8 aTransId	Unique transcation identifier of the original command.
const TDesC8 & aData	Data returned from call. Data package contents are defined by command.