TAknsItemID Class Reference

#include <mw/AknsItemID.h>

Link against: AknSkinSrv.lib

class TAknsItemID
Public Attributes
TInt iMajor
TInt iMinor
Public Member Functions
IMPORT_C TIntLinearOrder(const TAknsItemID &, const TAknsItemID &)
voidSet(const TInt, const TInt)
voidSet(const TUid, const TInt)
voidSet(const TAknsItemID &)

Detailed Description

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.

Since
2.0

Member Attribute Documentation

iMajor

TInt iMajor

Major part of the item ID as an integer.

iMinor

TInt iMinor

Minor part of the item ID as an integer.

Member Function Documentation

LinearOrder ( const TAknsItemID &, const TAknsItemID & )

IMPORT_C TIntLinearOrder(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.

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.
Parameters
aFirstConstant reference to the first object to be compared.
aSecondConstant reference to the second object to be compared.
Return Value
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.

Set ( const TInt, const TInt )

voidSet(const TIntaMajor,
const TIntaMinor
)[inline]

Sets specified major and minor parts.

Parameters
aMajorMajor part of the item ID.
aMinorMinor part of the item ID.

Set ( const TUid, const TInt )

voidSet(const TUidaMajor,
const TIntaMinor
)[inline]

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

Parameters
aMajorMajor part of the item ID as a UID.
aMinorMinor part of the item ID.

Set ( const TAknsItemID & )

voidSet(const TAknsItemID &aID)[inline]

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

Parameters
aIDItem ID to be used to get the values.