Collapse all Symbian^3 Product Developer Library

CPbkCodField Class Reference

class CPbkCodField : public CBase

Provides information about phonebook's Object for call fields. These fields have been defined in PbkFields.hrh file and field value is either EPbkFieldIdCodTextID or EPbkFieldIdCodImageID. The first field value is used if contact contains text object for call and the latter is used when contact contains image object for call. This API can be used for field value fetching and contains also getter for text. If image value needs to be fetched then CPbkImageManager.h (PbkView.dll) should be used instead. PbkEng.lib

Since: Series 60 3.0

Inherits from

CPbkCodField
- CBase

Public Member Functions
	~CPbkCodField()
IMPORT_C TPbkFieldId	CodFieldId(CPbkContactItem &)
IMPORT_C TPbkFieldId	CodFieldIdL(TContactItemId)
IMPORT_C HBufC *	GetTextL(TContactItemId)
IMPORT_C CPbkCodField *	NewL(CPbkContactEngine &)

Private Member Functions
	CPbkCodField(CPbkContactEngine &)

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
CPbkContactEngine &	iPbkContactEngine

Constructor & Destructor Documentation

CPbkCodField(CPbkContactEngine &)

CPbkCodField

(

CPbkContactEngine &

aPbkContactEngine

)

[private]

C++ constructor.

Parameters

CPbkContactEngine & aPbkContactEngine

~CPbkCodField()

~CPbkCodField

(

)

Destructor.

Member Functions Documentation

CodFieldId(CPbkContactItem &)

IMPORT_C TPbkFieldId

CodFieldId

(

CPbkContactItem &

aPbkContactItem

)

const

The object for call phonebook field id value of contact. The object for call field id value is either EPbkFieldIdCodTextID or EPbkFieldIdCodImageID if field is found. KErrNotFound returned if field object for call is not found.

Parameters

CPbkContactItem & aPbkContactItem

Reference to a contact item

CodFieldIdL(TContactItemId)

IMPORT_C TPbkFieldId

CodFieldIdL

(

TContactItemId

aContactItemId

)

const

Parameters

TContactItemId aContactItemId

GetTextL(TContactItemId)

IMPORT_C HBufC *

GetTextL

(

TContactItemId

aContactItemId

)

const

Returns the string of text for call field. If field id is EPbkFieldIdCodTextID then text for call string is returned. The filename of image is returned if object for call field id value is EPbkFieldIdCodImageID. Leaves with KErrNotFound if the contact item id is not found.

Exceptions

KErrNotSupported

if the field content cannot be represented as text.

Parameters

TContactItemId aContactItemId

Contact item id

NewL(CPbkContactEngine &)

IMPORT_C CPbkCodField *

NewL

(

CPbkContactEngine &

aPbkContactEngine

)

[static]

Two-phased constructor.

Parameters

CPbkContactEngine & aPbkContactEngine

Reference to Phonebook contact engine.

Member Data Documentation

CPbkContactEngine & iPbkContactEngine

CPbkContactEngine &

iPbkContactEngine

[private]