Symbian^3 Application Developer Library >

CPhoneBookEntry Class Reference

class CPhoneBookEntry : public CBase

Inherits from

Public Member Functions
~CPhoneBookEntry ()
IMPORT_C TInt AddAdditionalNumber (const TDesC &)
IMPORT_C TInt AddEmailAddress (const TDesC &)
IMPORT_C TInt AddSecondName (const TDesC &)
IMPORT_C TInt ExternalizeToTlvEntry ( CPhoneBookBuffer &)
IMPORT_C const RArray < RBuf > & GetAdditionalNumbers ()
IMPORT_C const TDesC & GetDiallingNumber ()
IMPORT_C const RArray < RBuf > & GetEmailAddresss ()
IMPORT_C const TDesC & GetFirstName ()
IMPORT_C TInt GetIndex ()
IMPORT_C const RArray < RBuf > & GetSecondNames ()
IMPORT_C TInt InternalizeFromTlvEntry ( CPhoneBookBuffer &, TBool )
IMPORT_C CPhoneBookEntry * NewL ()
IMPORT_C CPhoneBookEntry * NewLC ()
IMPORT_C void Reset ()
IMPORT_C TInt SetDiallingNumber (const TDesC &)
IMPORT_C TInt SetFirstName (const TDesC &)
IMPORT_C void SetIndex ( TInt )
IMPORT_C TInt TlvLength ()
IMPORT_C TBool operator== (const CPhoneBookEntry &)
Private Member Functions
CPhoneBookEntry ()
void ConstructL ()
void DesSize ( TInt &, const TDesC &)
TInt GetText ( TPtrC16 &, CPhoneBookBuffer::TPhBkTagType , CPhoneBookBuffer &)
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
Private Attributes
RArray < RBuf > iAdditionalNumbers
RBuf iDiallingNumber
RArray < RBuf > iEmailAddresss
RBuf iFirstName
TInt iIndex
TBool iIndexSet
RArray < RBuf > iSecondNames

Constructor & Destructor Documentation

CPhoneBookEntry()

CPhoneBookEntry ( ) [private]

First phase construction

~CPhoneBookEntry()

~CPhoneBookEntry ( )

Destruction

Member Functions Documentation

AddAdditionalNumber(const TDesC &)

IMPORT_C TInt AddAdditionalNumber ( const TDesC & aAdditionalNumber )

Parameters

const TDesC & aAdditionalNumber An additional number to be added to the entries list.

AddEmailAddress(const TDesC &)

IMPORT_C TInt AddEmailAddress ( const TDesC & aEmailAddress )

Parameters

const TDesC & aEmailAddress An email address to be added to the entries list.

AddSecondName(const TDesC &)

IMPORT_C TInt AddSecondName ( const TDesC & aSecondName )

Parameters

const TDesC & aSecondName An secondname to be added to the entries list.

ConstructL()

void ConstructL ( ) [private]

Second phase construction

DesSize(TInt &, const TDesC &)

void DesSize ( TInt & aSize,
const TDesC & aDes
) const [private]

Helper function

Parameters

TInt & aSize The size to be updated.
const TDesC & aDes The descriptor being added.

ExternalizeToTlvEntry(CPhoneBookBuffer &)

IMPORT_C TInt ExternalizeToTlvEntry ( CPhoneBookBuffer & aPhoneBookBuffer ) const

Writes the entry to a CPhoneBookBuffer in the TLV format.

Parameters

CPhoneBookBuffer & aPhoneBookBuffer The buffer to write the entry to.

GetAdditionalNumbers()

IMPORT_C const RArray < RBuf > & GetAdditionalNumbers ( ) const

GetDiallingNumber()

IMPORT_C const TDesC & GetDiallingNumber ( ) const

GetEmailAddresss()

IMPORT_C const RArray < RBuf > & GetEmailAddresss ( ) const

GetFirstName()

IMPORT_C const TDesC & GetFirstName ( ) const

GetIndex()

IMPORT_C TInt GetIndex ( ) const

GetSecondNames()

IMPORT_C const RArray < RBuf > & GetSecondNames ( ) const

GetText(TPtrC16 &, CPhoneBookBuffer::TPhBkTagType, CPhoneBookBuffer &)

TInt GetText ( TPtrC16 & text,
CPhoneBookBuffer::TPhBkTagType aTagType,
CPhoneBookBuffer & aPhoneBookBuffer
) const [private]

Helper function

Gets a the next TPtrC16

Parameters

TPtrC16 & text A TPtrC to the next text entry
CPhoneBookBuffer::TPhBkTagType aTagType
CPhoneBookBuffer & aPhoneBookBuffer The phonebook buffer to read from

InternalizeFromTlvEntry(CPhoneBookBuffer &, TBool)

IMPORT_C TInt InternalizeFromTlvEntry ( CPhoneBookBuffer & aPhoneBookBuffer,
TBool aNewEntryTagRead = EFalse
)

Reads an entry from a CPhoneBookBuffer , this does not reset the object first.

Parameters

CPhoneBookBuffer & aPhoneBookBuffer The buffer to read from.
TBool aNewEntryTagRead = EFalse If the TLV being read has a new entry tag or not.

NewL()

IMPORT_C CPhoneBookEntry * NewL ( ) [static]

Factory function

NewLC()

IMPORT_C CPhoneBookEntry * NewLC ( ) [static]

Factory function

Reset()

IMPORT_C void Reset ( )

Resets the object to its initial state.

SetDiallingNumber(const TDesC &)

IMPORT_C TInt SetDiallingNumber ( const TDesC & aDiallingNumber )

Parameters

const TDesC & aDiallingNumber

SetFirstName(const TDesC &)

IMPORT_C TInt SetFirstName ( const TDesC & aFirstName )

Parameters

const TDesC & aFirstName The firstname to be set.

SetIndex(TInt)

IMPORT_C void SetIndex ( TInt aIndex )

Parameters

TInt aIndex The index to set.

TlvLength()

IMPORT_C TInt TlvLength ( ) const

operator==(const CPhoneBookEntry &)

IMPORT_C TBool operator== ( const CPhoneBookEntry & aPhoneBookEntry ) const

Parameters

const CPhoneBookEntry & aPhoneBookEntry

Member Data Documentation

RArray< RBuf > iAdditionalNumbers

RArray < RBuf > iAdditionalNumbers [private]

RBuf iDiallingNumber

RBuf iDiallingNumber [private]

RArray< RBuf > iEmailAddresss

RArray < RBuf > iEmailAddresss [private]

RBuf iFirstName

RBuf iFirstName [private]

TInt iIndex

TInt iIndex [private]

TBool iIndexSet

TBool iIndexSet [private]

RArray< RBuf > iSecondNames

RArray < RBuf > iSecondNames [private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.