MAknsControlContext Class Reference

API published in: S60 2nd Ed

Link against: aknskins.lib aknskinsrv.lib aknswallpaperutils.lib

Capability Information

Required Capabilities

None

#include <aknscontrolcontext.h>

Inherited by CAknsBasicBackgroundControlContext.

Detailed Description

Interface that provides context specific skin parameters.

This interface is used by AknsDrawUtils to query context specific parameters, such as background override. Application should instantiate a class that implements this interface and provide pointer to it using MObjectProvider::MopSupplyObject in the appropriate control.

This is a public class with exported functions. The class is not intended for user derivation - concrete classes implementing the interface are provided by the library. See CAknsBasicBackgroundControlContext and CAknsListBoxBackgroundControlContext for further details.


Public Member Functions
�	DECLARE_TYPE_ID (0x10005a29) public
�	Destructor.
virtual TInt�	SupplySkinParameter (TAknsCCParameter aParam)=0
�	Provides context specific integer parameter.
virtual TAny *�	SupplySkinObject (TAknsCCObject aObject)=0
�	Provides context specific object.
virtual TBool�	IsCompatibleWithType (const TAknsControlContextType aType) const =0
�	Determines whether this control context is compatible with the given derived type.
virtual TInt�	UpdateContext ()
�	Updates the control context, if necessary.
Static Public Member Functions
static IMPORT_C TTypeUid::Ptr�	SupplyMopObject (TTypeUid aId, MAknsControlContext *aContext)
�	Returns type UID pointer that can be used in MopSupplyObject.
Protected Member Functions
virtual TInt�	Reserved2 ()
�	Reserved for future use.

Member Function Documentation

MAknsControlContext::DECLARE_TYPE_ID (� 0x10005a29� �)� [inline]

�	Destructor. Destructor is provided only to enable deletion using base class pointer. Caller should never delete control context retrieved through `MObjectProvider` interface.

virtual TBool MAknsControlContext::IsCompatibleWithType (� const TAknsControlContextType� aType �)� const [pure virtual]

�

Determines whether this control context is compatible with the given derived type.

Parameters:

aType�

Type of the derived control context class (one of the values in TAknsControlContextType).

Returns:: ETrue if this control context instance is compatible with the given type (i.e. can be casted to the corresponding concrete class). EFalse otherwise.

Implemented in CAknsBasicBackgroundControlContext, CAknsFrameBackgroundControlContext, CAknsLayeredBackgroundControlContext, and CAknsListBoxBackgroundControlContext.

virtual TInt MAknsControlContext::Reserved2 (� �)� [protected, virtual]

�	Reserved for future use.

static IMPORT_C TTypeUid::Ptr MAknsControlContext::SupplyMopObject	(�	TTypeUid�	aId,
		MAknsControlContext *�	aContext
	)�	`[static]`

�

Returns type UID pointer that can be used in MopSupplyObject.

Parameters:

	aId�	Type UID, should be the same that was given as aId parameter of MopSupplyObject.
	aContext�	Pointer to an MAknsControlContext instance.

Returns:: Type UID pointer containing aContext, or NULL type UID pointer if given type UID does not match MAknsControlContext or aContext is NULL.

virtual TAny* MAknsControlContext::SupplySkinObject (� TAknsCCObject� aObject �)� [pure virtual]

�

Provides context specific object.

Parameters:

aObject�

Type of the object to be retrieved. Possible values are defined in TAknsCCObject enumeration.

Returns:: Pointer to object as defined in TAknsCCObject for that specific aObject parameter value. For unknown or unhandled values NULL must be returned.

Implemented in CAknsBasicBackgroundControlContext.

virtual TInt MAknsControlContext::SupplySkinParameter (� TAknsCCParameter� aParam �)� [pure virtual]

�

Provides context specific integer parameter.

Parameters:

aParam�

Type of the parameter to be retrieved. Possible values are defined in TAknsCCParameter enumeration.