epoc32/include/mmf/common/mmfdrmcustomcommands.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
// Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
// All rights reserved.
williamr@2
     3
// This component and the accompanying materials are made available
williamr@2
     4
// under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
williamr@2
     5
// which accompanies this distribution, and is available
williamr@2
     6
// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     7
//
williamr@2
     8
// Initial Contributors:
williamr@2
     9
// Nokia Corporation - initial contribution.
williamr@2
    10
//
williamr@2
    11
// Contributors:
williamr@2
    12
//
williamr@2
    13
// Description:
williamr@2
    14
//
williamr@2
    15
williamr@2
    16
#ifndef __MMF_DRM_CUSTOM_COMMANDS_H__
williamr@2
    17
#define __MMF_DRM_CUSTOM_COMMANDS_H__
williamr@2
    18
williamr@2
    19
williamr@2
    20
#include <e32base.h>
williamr@2
    21
#include <mmf/common/mmcaf.h>
williamr@2
    22
#include <mmf/common/mmfstandardcustomcommands.h>
williamr@2
    23
williamr@2
    24
williamr@2
    25
/**
williamr@2
    26
@publishedAll
williamr@2
    27
@released
williamr@2
    28
*/
williamr@2
    29
const TUid KUidInterfaceMMFDRMControl = {0x101F7D8D};
williamr@2
    30
williamr@2
    31
/**
williamr@2
    32
@internalComponent
williamr@2
    33
*/
williamr@2
    34
enum TMMFDRMControlMessages
williamr@2
    35
	{
williamr@2
    36
	EMMFDRMControlEvaluateIntent,
williamr@2
    37
	EMMFDRMControlExecuteIntent,
williamr@2
    38
	EMMFDRMControlDisableAutomaticIntent,
williamr@2
    39
	EMMFDRMControlSetAgentProperty,
williamr@2
    40
	EMMFDRMControlIsSupported
williamr@2
    41
	};
williamr@2
    42
williamr@2
    43
williamr@2
    44
/**
williamr@2
    45
@publishedAll
williamr@2
    46
@released
williamr@2
    47
williamr@2
    48
Mixin class to be derived from by controller plugins wishing to support the DRM Intent
williamr@2
    49
custom commands.
williamr@2
    50
*/
williamr@2
    51
class MMMFDRMCustomCommandImplementor
williamr@2
    52
	{
williamr@2
    53
public:
williamr@2
    54
williamr@2
    55
	/**
williamr@2
    56
	Disable the automatic (controller specified) execution of intent
williamr@2
    57
williamr@2
    58
	@param  aIntent
williamr@2
    59
	        The intent to execute
williamr@2
    60
williamr@2
    61
	*/
williamr@2
    62
	virtual TInt MdcDisableAutomaticIntent(TBool aDisableAutoIntent)=0;
williamr@2
    63
williamr@2
    64
williamr@2
    65
	/**
williamr@2
    66
	Executes a particular intent
williamr@2
    67
williamr@2
    68
	@param  aIntent
williamr@2
    69
	        The intent to execute
williamr@2
    70
williamr@2
    71
	*/
williamr@2
    72
	virtual TInt MdcExecuteIntent(ContentAccess::TIntent aIntent)=0;
williamr@2
    73
williamr@2
    74
	/**
williamr@2
    75
	Evaluate a particular intent
williamr@2
    76
williamr@2
    77
	@param  aIntent
williamr@2
    78
	        The intent to evaluate
williamr@2
    79
williamr@2
    80
	*/
williamr@2
    81
	virtual TInt MdcEvaluateIntent(ContentAccess::TIntent aIntent)=0;
williamr@2
    82
	
williamr@2
    83
	/**
williamr@2
    84
	
williamr@2
    85
	
williamr@2
    86
	*/
williamr@2
    87
	virtual TInt MdcSetAgentProperty(ContentAccess::TAgentProperty aProperty, TInt aValue)=0;
williamr@2
    88
	};
williamr@2
    89
williamr@2
    90
class CMMFDRMCustomCommandParser : public CMMFCustomCommandParserBase
williamr@2
    91
	{
williamr@2
    92
public:
williamr@2
    93
williamr@2
    94
	/**
williamr@2
    95
	Creates a new custom command parser capable of DRM Intent controller commands.
williamr@2
    96
williamr@2
    97
	@param  aImplementor
williamr@2
    98
	        A reference to the controller plugin that owns this new object.
williamr@2
    99
williamr@2
   100
	@return A pointer to the object created.
williamr@2
   101
williamr@2
   102
	@since  7.0s
williamr@2
   103
	*/
williamr@2
   104
	IMPORT_C static CMMFDRMCustomCommandParser* NewL(MMMFDRMCustomCommandImplementor& aImplementor);
williamr@2
   105
williamr@2
   106
	/**
williamr@2
   107
	Destructor.
williamr@2
   108
williamr@2
   109
	@since  7.0s
williamr@2
   110
	*/
williamr@2
   111
	IMPORT_C ~CMMFDRMCustomCommandParser();
williamr@2
   112
williamr@2
   113
	/**
williamr@2
   114
	Handles a request from the client. Called by the controller framework.
williamr@2
   115
williamr@2
   116
	@param  aMessage
williamr@2
   117
	        The message to be handled.
williamr@2
   118
williamr@2
   119
	@since  7.0s
williamr@2
   120
	*/
williamr@2
   121
	void HandleRequest(TMMFMessage& aMessage);
williamr@2
   122
williamr@2
   123
private:
williamr@2
   124
	/**
williamr@2
   125
	Constructor.
williamr@2
   126
williamr@2
   127
	@param  aImplementor
williamr@2
   128
	        A reference to the controller plugin that owns this new object.
williamr@2
   129
	@since  7.0s
williamr@2
   130
	*/
williamr@2
   131
	CMMFDRMCustomCommandParser(MMMFDRMCustomCommandImplementor& aImplementor);
williamr@2
   132
	// Internal request handling methods.
williamr@2
   133
williamr@2
   134
	void DoHandleRequestL(TMMFMessage& aMessage);
williamr@2
   135
	void DoEvaluateIntentL(TMMFMessage& aMessage);
williamr@2
   136
	void DoExecuteIntentL(TMMFMessage& aMessage);
williamr@2
   137
	void DoDisableAutomaticIntentL(TMMFMessage& aMessage);
williamr@2
   138
	void DoSetAgentPropertyL(TMMFMessage& aMessage);
williamr@2
   139
williamr@2
   140
private:
williamr@2
   141
	MMMFDRMCustomCommandImplementor& iImplementor;
williamr@2
   142
	};
williamr@2
   143
	
williamr@2
   144
	
williamr@2
   145
/**
williamr@2
   146
@publishedAll
williamr@2
   147
@released
williamr@2
   148
williamr@2
   149
Generic Mixin class to be used by a client utility wishing to pass DRM Intent
williamr@2
   150
custom commands to a controller plugin.
williamr@2
   151
*/
williamr@2
   152
class MMMFDRMCustomCommand
williamr@2
   153
	{
williamr@2
   154
public:
williamr@2
   155
williamr@2
   156
	/**
williamr@2
   157
	Disable the automatic (controller specified) execution of intent
williamr@2
   158
williamr@2
   159
	@param  aIntent
williamr@2
   160
	        The intent to execute
williamr@2
   161
williamr@2
   162
	*/
williamr@2
   163
	virtual TInt DisableAutomaticIntent(TBool aDisableAutoIntent)=0;
williamr@2
   164
williamr@2
   165
williamr@2
   166
	/**
williamr@2
   167
	Executes a particular intent
williamr@2
   168
williamr@2
   169
	@param  aIntent
williamr@2
   170
	        The intent to execute
williamr@2
   171
williamr@2
   172
	*/
williamr@2
   173
	virtual TInt ExecuteIntent(ContentAccess::TIntent aIntent)=0;
williamr@2
   174
williamr@2
   175
	/**
williamr@2
   176
	Evaluate a particular intent
williamr@2
   177
williamr@2
   178
	@param  aIntent
williamr@2
   179
	        The intent to evaluate
williamr@2
   180
williamr@2
   181
	*/
williamr@2
   182
	virtual TInt EvaluateIntent(ContentAccess::TIntent aIntent)=0;
williamr@2
   183
	
williamr@2
   184
	/**
williamr@2
   185
	
williamr@2
   186
	
williamr@2
   187
	*/
williamr@2
   188
	virtual TInt SetAgentProperty(ContentAccess::TAgentProperty aProperty, TInt aValue)=0;
williamr@2
   189
	};
williamr@2
   190
williamr@2
   191
class RMMFDRMCustomCommands : public RMMFCustomCommandsBase,
williamr@2
   192
                              public MMMFDRMCustomCommand
williamr@2
   193
	{
williamr@2
   194
public:
williamr@2
   195
williamr@2
   196
	/**
williamr@2
   197
	Constructor.
williamr@2
   198
williamr@2
   199
	@param  aController
williamr@2
   200
	        The client side controller object to be used by this custom command interface.
williamr@2
   201
williamr@2
   202
	*/
williamr@2
   203
	IMPORT_C RMMFDRMCustomCommands(RMMFController& aController);
williamr@2
   204
	
williamr@2
   205
	/**
williamr@2
   206
	*/
williamr@2
   207
	IMPORT_C TInt DisableAutomaticIntent(TBool aBool);
williamr@2
   208
williamr@2
   209
	/**
williamr@2
   210
	*/
williamr@2
   211
	IMPORT_C TInt EvaluateIntent(ContentAccess::TIntent aIntent);
williamr@2
   212
	
williamr@2
   213
	/**
williamr@2
   214
	*/
williamr@2
   215
	IMPORT_C TInt ExecuteIntent(ContentAccess::TIntent aIntent);
williamr@2
   216
	
williamr@2
   217
	/**
williamr@2
   218
	*/
williamr@2
   219
	IMPORT_C TInt SetAgentProperty(ContentAccess::TAgentProperty aProperty, TInt aValue);
williamr@2
   220
	
williamr@2
   221
	/**
williamr@2
   222
	*/
williamr@2
   223
	IMPORT_C TBool IsSupported();
williamr@2
   224
	
williamr@2
   225
	};
williamr@2
   226
williamr@2
   227
williamr@2
   228
#endif // __MMF_DRM_CUSTOM_COMMANDS_H__