TAknsItemID Class Reference

API published in: S60 2nd Ed

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

Capability Information

Required Capabilities

None

#include <aknsitemid.h>

Item identifier used to identify items supplied through skin interfaces.

Item ID consists of two integers: major and minor parts of the ID.

Note that only LinearOrder() member function requires linking against the library, all the other methods are inlined.


Public Member Functions
void	Set (const TInt aMajor, const TInt aMinor)
	Sets specified major and minor parts.
void	Set (const TUid aMajor, const TInt aMinor)
	Sets specified major and minor parts where major part is given as a UID.
void	Set (const TAknsItemID &aID)
	Sets major and minor parts according to the given item ID.
Static Public Member Functions
static IMPORT_C TInt	LinearOrder (const TAknsItemID &aFirst, const TAknsItemID &aSecond)
	Determines the order of two TAknsItemID objects.
Data Fields
TInt	iMajor
	Major part of the item ID as an integer.
TInt	iMinor
	Minor part of the item ID as an integer.

static IMPORT_C TInt TAknsItemID::LinearOrder	(	const TAknsItemID &	aFirst,
		const TAknsItemID &	aSecond
	)	`[static]`

Determines the order of two TAknsItemID objects.

Implements an algorithm that determines the order of two item ID objects.

Parameters:

	aFirst	Constant reference to the first object to be compared.
	aSecond	Constant reference to the second object to be compared.

Returns:: 0 if the two objects are equal, negative value if the first object is less than the second and positive value if the first object is greater than the second.

Implementation details:: To improve binary search, current implementation first compares minor part and after that the major part of the item ID. Since most lists have several objects with equal major parts this makes the algorithm more efficient.

void TAknsItemID::Set ( const TAknsItemID & aID ) [inline]

Sets major and minor parts according to the given item ID.

Parameters:

aID

Item ID to be used to get the values.

Sets specified major and minor parts where major part is given as a UID.

Parameters:

	aMajor	Major part of the item ID as a UID.
	aMinor	Minor part of the item ID.

Sets specified major and minor parts.

Parameters:

	aMajor	Major part of the item ID.
	aMinor	Minor part of the item ID.

TInt TAknsItemID::iMajor

Major part of the item ID as an integer.

TInt TAknsItemID::iMinor

Minor part of the item ID as an integer.

The documentation for this class was generated from the following file: