Collapse all Symbian^3 Application Developer Library

MAknsControlContext Class Reference

class MAknsControlContext

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.

AknSkins.lib

Since: 2.0

Public Member Functions
	DECLARE_TYPE_ID (0x10005a29)
TBool	IsCompatibleWithType (const TAknsControlContextType )
IMPORT_C TTypeUid::Ptr	SupplyMopObject ( TTypeUid , MAknsControlContext *)
TAny *	SupplySkinObject ( TAknsCCObject )
TInt	SupplySkinParameter ( TAknsCCParameter )
TInt	UpdateContext ()

Protected Member Functions
TInt	Reserved2 ()

Member Functions Documentation

DECLARE_TYPE_ID(0x10005a29)

DECLARE_TYPE_ID

(

0x10005a29

)

[inline]

Type ID declaration. Type ID is used to make it possible to retrieve control context through MObjectProvider::MopSupplyObject interface. Destructor. Destructor is provided only to enable deletion using base class pointer. Caller should never delete control context retrieved through MObjectProvider interface.

Parameters

0x10005a29

IsCompatibleWithType(const TAknsControlContextType)

TBool

IsCompatibleWithType

(

const TAknsControlContextType

aType

)

const [pure virtual]

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

Since: 2.0

Parameters

const TAknsControlContextType aType

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

Reserved2()

TInt

Reserved2

(

)

[protected, virtual]

Reserved for future use.

Since: 2.0

SupplyMopObject(TTypeUid, MAknsControlContext *)

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

Returns type UID pointer that can be used in MopSupplyObject.

Since: 2.0

Parameters

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

SupplySkinObject(TAknsCCObject)

TAny *

SupplySkinObject

(

TAknsCCObject

aObject

)

[pure virtual]

Provides context specific object.

Since: 2.0

Parameters

TAknsCCObject aObject

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

SupplySkinParameter(TAknsCCParameter)

TInt

SupplySkinParameter

(

TAknsCCParameter

aParam

)

[pure virtual]

Provides context specific integer parameter.

Since: 2.0

Parameters

TAknsCCParameter aParam

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

UpdateContext()

TInt

UpdateContext

(

)

[virtual]

Updates the control context, if necessary. This method is called by the framework before drawing with the context.

Base class implementation returns 0.

Since: 2.6