Collapse all Symbian^3 Application Developer Library

TPbk2IconId Class Reference

class TPbk2IconId

Phonebook 2 icon identification. This class is responsible for implementing a unique identifier for icons in the Phonebook context.

Public Member Functions
	TPbk2IconId ()
	TPbk2IconId (const TUid &, TInt )
	TPbk2IconId ( TResourceReader &)
TBool	IsOwner (const TUid &)
IMPORT_C TBool	operator== (const TPbk2IconId &)

Private Attributes
TInt	iIconId
TUid	iOwnersUid
TInt32	iSpare1
TInt32	iSpare2

Constructor & Destructor Documentation

TPbk2IconId()

IMPORT_C

TPbk2IconId

(

)

Default C++ constructor. Constructs a null icon id.

TPbk2IconId(const TUid &, TInt)

IMPORT_C	TPbk2IconId	(	const TUid &	aOwnerUid,
			TInt	aIconId
		)

Constructor that takes the owner uid and icon id.

Parameters

const TUid & aOwnerUid	The UID that specifies whose icon this is. It's used the identify icons from different components that are used in the same data structure. The UID could be e.g a Phonebook 2 UID for application defined icons and ECom implementation UID for UI extension icons.
TInt aIconId	The id of the icon under the owner.

TPbk2IconId(TResourceReader &)

IMPORT_C

TPbk2IconId

(

TResourceReader &

aReader

)

Constructor that takes a resource reader that points to a PHONEBOOK2_ICON_ID structure.

Parameters

TResourceReader & aReader

Resource reader to a PHONEBOOK2_ICON_ID resource structure.

Member Functions Documentation

IsOwner(const TUid &)

TBool

IsOwner

(

const TUid &

aUid

)

const [inline]

Checks if passed uid is owner of this structure

Parameters

const TUid & aUid

Owner UID to check.

operator==(const TPbk2IconId &)

IMPORT_C TBool

operator==

(

const TPbk2IconId &

aRhs

)

const

Comparison that returns ETrue if the icon ids are the same.

Parameters

const TPbk2IconId & aRhs

An icon id to compare.

Member Data Documentation

TInt iIconId

TInt

iIconId

[private]

TUid iOwnersUid

TUid

iOwnersUid

[private]

TInt32 iSpare1

TInt32

iSpare1

[private]

TInt32 iSpare2

TInt32

iSpare2

[private]