Collapse all Symbian^3 Application Developer Library

TPbkContactEntry Class Reference

class TPbkContactEntry

Public Member Functions
	TPbkContactEntry ()
TContactItemId	ContactId ()
void	Destroy ()
TPbkIconId	IconId ()
const TDesC &	Name ()
TPtr	NameBuf ()
void	ReserveNameMaxLengthL ( TInt )
void	Reset ()
void	ResetName ()
void	SetContactItemId ( TContactItemId )
void	SetIconId ( TPbkIconId )

Private Member Functions
void	Destroy ( TAny *)
IMPORT_C HBufC *	ReserveL ( HBufC *, TInt )
void	ResetHBufC ( HBufC *)
const TDesC &	ToTDesC ( HBufC *)

Private Attributes
TContactItemId	iContactId
TPbkIconId	iIconId
HBufC *	iName

Constructor & Destructor Documentation

TPbkContactEntry()

TPbkContactEntry

(

)

[inline]

Default constructor.

Member Functions Documentation

ContactId()

TContactItemId

ContactId

(

)

const [inline]

Returns the contact id of this entry.

Destroy()

void

Destroy

(

)

[inline]

Destroys all resources held by this object. After calling Destroy() this object is unusable.

Destroy(TAny *)

void

Destroy

(

TAny *

aSelf

)

[private, static]

Parameters

TAny * aSelf

IconId()

TPbkIconId

IconId

(

)

const [inline]

Returns the Phonebook icon id, EPbkNullIconId means no icon.

Name()

const TDesC &

Name

(

)

const [inline]

Returns the name. iName

NameBuf()

TPtr

NameBuf

(

)

[inline]

Returns a modifiable descriptor to the name buffer. Call ReserveNameMaxLengthL() first to allocate space for the buffer.

ReserveL(HBufC *, TInt)

IMPORT_C HBufC *	ReserveL	(	HBufC *	aBuf,
			TInt	aMaxLength
		)	[private, static]

Reserves space for a HBufC member.

Parameters

HBufC * aBuf	the buffer member to be enlarged
TInt aMaxLength	the maximum number of characters the buffer should be able to hold. If aMaxLength==0 this function does nothing.

ReserveNameMaxLengthL(TInt)

void

ReserveNameMaxLengthL

(

TInt

aMaxLength

)

[inline]

Reserves space for the name. Does not change existing name text.

Parameters

TInt aMaxLength

Reset()

void

Reset

(

)

[inline]

Resets the contents of this entry.

ResetHBufC(HBufC *)

void

ResetHBufC

(

HBufC *

aBuf

)

[private, static, inline]

Resets member aBuf to empty text. ToTDesC(aBuf).Length()==0

Parameters

HBufC * aBuf

ResetName()

void

ResetName

(

)

[inline]

Resets the name of this entry.

Name() .Length()==0

SetContactItemId(TContactItemId)

void

SetContactItemId

(

TContactItemId

aContactId

)

[inline]

Sets the contact item id.

Parameters

TContactItemId aContactId

SetIconId(TPbkIconId)

void

SetIconId

(

TPbkIconId

aIconId

)

[inline]

Sets the icon id.

Parameters

TPbkIconId aIconId

ToTDesC(HBufC *)

const TDesC &

ToTDesC

(

HBufC *

aBuf

)

[private, static, inline]

Returns contents of aBuf as a const TDesC& or KNullDesC if !aBuf.

Parameters

HBufC * aBuf

Member Data Documentation

TContactItemId iContactId

TContactItemId

iContactId

[private]

TPbkIconId iIconId

TPbkIconId

iIconId

[private]

HBufC * iName

HBufC *

iName

[private]