TPbkContactItemField Class Reference

#include <app/TPbkContactItemField.h>

class TPbkContactItemField : public MPbkFieldData

Inherits from

TPbkContactItemField
- MPbkFieldData

Public Member Functions
	TPbkContactItemField()
	TPbkContactItemField(CContactItemField , CPbkFieldInfo )
IMPORT_C TInt	Compare(const TPbkContactItemField &)
IMPORT_C CContactItemField &	ContactItemField()
IMPORT_C const CContactItemField &	ContactItemField()
IMPORT_C CContactDateField *	DateTimeStorage()
IMPORT_C TBool	DefaultEmailField()
IMPORT_C TBool	DefaultEmailOverSmsField()
IMPORT_C TBool	DefaultMmsField()
IMPORT_C TBool	DefaultPhoneNumberField()
IMPORT_C TBool	DefaultPocField()
IMPORT_C TBool	DefaultSmsField()
IMPORT_C TBool	DefaultVideoNumberField()
IMPORT_C TBool	DefaultVoipField()
IMPORT_C CPbkFieldInfo &	FieldInfo()
IMPORT_C void	GetTextL(TDes &)
IMPORT_C TPbkIconId	IconId()
IMPORT_C TBool	IsEmpty()
IMPORT_C TBool	IsEmptyOrAllSpaces()
IMPORT_C TBool	IsHidden()
IMPORT_C TBool	IsSame(const TPbkContactItemField &)
IMPORT_C CContactItemField &	ItemField()
IMPORT_C TPtrC	Label()
virtual IMPORT_C TPbkFieldId	PbkFieldId()
virtual IMPORT_C TPtrC	PbkFieldText()
virtual IMPORT_C TTime	PbkFieldTime()
virtual IMPORT_C TStorageType	PbkFieldType()
IMPORT_C void	Set(CContactItemField , CPbkFieldInfo )
IMPORT_C void	SetHidden(TBool)
IMPORT_C void	SetLabelL(const TDesC &)
IMPORT_C CArrayFix< TInt > *	SpeedDialIndexesL()
IMPORT_C TStorageType	StorageType()
IMPORT_C TPtrC	Text()
IMPORT_C CContactTextField *	TextStorage()
IMPORT_C TTime	Time()
IMPORT_C TInt	UniqueFieldIdentity()

Inherited Functions
	MPbkFieldData::~MPbkFieldData()

Detailed Description

Phonebook Contact item field class. This class extends Symbian Contacts model CContactItemField class capabilities to better suit Phonebook's needs.

Constructor & Destructor Documentation

TPbkContactItemField ( )

IMPORT_C

TPbkContactItemField

(

)

C++ default constructor.

TPbkContactItemField ( CContactItemField , CPbkFieldInfo )

IMPORT_C	TPbkContactItemField	(	CContactItemField *	aField,
			CPbkFieldInfo *	aFieldInfo
		)

C++ constructor.

Parameter	Description
aField	Contacts Model field this object is wrapping.
aFieldInfo	Phonebook field type of aField.

Member Function Documentation

Compare ( const TPbkContactItemField & )

IMPORT_C TInt

Compare

(

const TPbkContactItemField &

aRhs

)

const

Compares two items against the group ordering.

Parameter	Description
aRhs	Contact item field to compare to this field.

ContactItemField ( )

IMPORT_C CContactItemField &

ContactItemField

(

)

Converts this field to a CContactItemField.

Returns: The embedded CContactItemField object.

ContactItemField ( )

IMPORT_C const CContactItemField &

ContactItemField

(

)

const

Converts this field to a const CContactItemField.

Returns: The embedded CContactItemField object.

DateTimeStorage ( )

IMPORT_C CContactDateField *

DateTimeStorage

(

)

const

Returns time storage of this field. If the storage type is not KStorageTypeDateTime the function raises a panic.

Returns: The time storage object of this field.

DefaultEmailField ( )

IMPORT_C TBool

DefaultEmailField

(

)

const

Returns ETrue is this field is a default email field.

See also: CPbkContactItem::DefaultEmailField CPbkContactItem::SetDefaultEmailField

Returns: ETrue is this field is a default email field.

DefaultEmailOverSmsField ( )

IMPORT_C TBool

DefaultEmailOverSmsField

(

)

const

Returns ETrue is this field is a default SMS With Email field.

See also: CPbkContactItem::DefaultEmailOverSmsField CPbkContactItem::SetDefaultEmailOverSmsField

Returns: ETrue is this field is a default SMS With Email field.

DefaultMmsField ( )

IMPORT_C TBool

DefaultMmsField

(

)

const

Returns ETrue is this field is a default MMS field.

See also: CPbkContactItem::DefaultMmsField CPbkContactItem::SetDefaultMmsField

Returns: ETrue is this field is a default MMS field.

DefaultPhoneNumberField ( )

IMPORT_C TBool

DefaultPhoneNumberField

(

)

const

Returns ETrue is this field is a default phone number field.

See also: CPbkContactItem::DefaultPhoneNumberField CPbkContactItem::SetDefaultPhoneNumberField

Returns: ETrue is this field is a default phone number field.

DefaultPocField ( )

IMPORT_C TBool

DefaultPocField

(

)

const

Returns ETrue is this field is a default POC field.

See also: CPbkContactItem::DefaultPocField CPbkContactItem::SetDefaultPocField

Returns: ETrue is this field is a default POC field.

DefaultSmsField ( )

IMPORT_C TBool

DefaultSmsField

(

)

const

Returns ETrue is this field is a default SMS field.

See also: CPbkContactItem::DefaultSmsField CPbkContactItem::SetDefaultSmsField

Returns: ETrue is this field is a default SMS field.

DefaultVideoNumberField ( )

IMPORT_C TBool

DefaultVideoNumberField

(

)

const

Returns ETrue if this field is a default video number field.

See also: CPbkContactItem::DefaultVideoNumberField CPbkContactItem::SetDefaultVideoNumberField

Returns: ETrue if this field is a default video number field.

DefaultVoipField ( )

IMPORT_C TBool

DefaultVoipField

(

)

const

Returns ETrue is this field is a default VOIP field.

See also: CPbkContactItem::DefaultVoipField CPbkContactItem::SetDefaultVoipField

Returns: ETrue is this field is a default VOIP field.

FieldInfo ( )

IMPORT_C CPbkFieldInfo &

FieldInfo

(

)

const

Returns the Phonebook field info object of this field.

Returns: Field info for this field.

GetTextL ( TDes & )

IMPORT_C void

GetTextL

(

TDes &

aText

)

const

Fills aText with field's text content. If field is of date type formats the date as text.

Exceptions

KErrOverflow	if aText is not big enough for the text. aText contents will be clipped to aText.MaxLength().
KErrNotSupported	if the field content cannot be represented as text.

Parameter	Description
aText	Fills parameter with field's content.

IconId ( )

IMPORT_C TPbkIconId

IconId

(

)

const

Returns an Phonebook icon id for this field.

Returns: The Phonebook icon id for this field.

IsEmpty ( )

IMPORT_C TBool

IsEmpty

(

)

const

Returns ETrue if this field's contents is empty.

Returns: ETrue if this field's contents is empty.

IsEmptyOrAllSpaces ( )

IMPORT_C TBool

IsEmptyOrAllSpaces

(

)

const

Returns ETrue if this field's contents is empty or all spaces.

Returns: ETrue if this field's contents is empty or all spaces.

IsHidden ( )

IMPORT_C TBool

IsHidden

(

)

const

Check if field is marked hidden.

Returns: ETrue if this field is hidden, EFalse if not.

IsSame ( const TPbkContactItemField & )

IMPORT_C TBool

IsSame

(

const TPbkContactItemField &

aField

)

const

Returns ETrue if this is the same field as aField.

Returns: ETrue if this is the same field as aField.

ItemField ( )

IMPORT_C CContactItemField &

ItemField

(

)

const

Returns the embedded contact item field.

Returns: The embedded contact item field.

Label ( )

IMPORT_C TPtrC

Label

(

)

const

Returns the label text of this field.

Returns: The label text of this field.

PbkFieldId ( )

IMPORT_C TPbkFieldId

PbkFieldId

(

)

const [virtual]

Reimplemented from MPbkFieldData::PbkFieldId()const

Returns the field id of this field data.

PbkFieldText ( )

IMPORT_C TPtrC

PbkFieldText

(

)

const [virtual]

Reimplemented from MPbkFieldData::PbkFieldText()const

Returns the text value of this field data. PbkFieldType()==KStrorageTypeText.

PbkFieldTime ( )

IMPORT_C TTime

PbkFieldTime

(

)

const [virtual]

Reimplemented from MPbkFieldData::PbkFieldTime()const

Returns the Time value of this field data. PbkFieldType()==KStoragetTypeDateTime.

PbkFieldType ( )

IMPORT_C TStorageType

PbkFieldType

(

)

const [virtual]

Reimplemented from MPbkFieldData::PbkFieldType()const

Returns the type of this field data.

Returns: KStrorageTypeText or KStoragetTypeDateTime.

Set ( CContactItemField , CPbkFieldInfo )

IMPORT_C void	Set	(	CContactItemField *	aField,
			CPbkFieldInfo *	aFieldInfo
		)

Sets the contents of this object after construction.

Parameter	Description
aField	Contacts Model field this object is wrapping
aFieldInfo	Phonebook field type of aField

SetHidden ( TBool )

IMPORT_C void

SetHidden

(

TBool

aHidden

)

Marks this field as hidden or unhidden.

Parameter	Description
aHidden	ETrue marks as hidden EFalse removes the mark.

SetLabelL ( const TDesC & )

IMPORT_C void

SetLabelL

(

const TDesC &

aLabel

)

Sets the label text of this field to aLabel.

Parameter	Description
aLabel	Text to set as the label of this field.

SpeedDialIndexesL ( )

IMPORT_C CArrayFix< TInt > *

SpeedDialIndexesL

(

)

const

Returns an array of speed dial indexes assigned to this field, NULL if none.

Returns: An array of speed dial indexes assigned to this field, NULL if none.

StorageType ( )

IMPORT_C TStorageType

StorageType

(

)

const

Returns the storage type of this field.

Returns: The storage type of this field.

Text ( )

IMPORT_C TPtrC

Text

(

)

const

Returns this field's textual content.

Returns: This field's textual content. StorageType()==KStorageTypeText.

TextStorage ( )

IMPORT_C CContactTextField *

TextStorage

(

)

const

Returns the text storage object of this field. If the storage type is not KStorageTypeText the function raises a panic.

Returns: The text storage object of this field.

Time ( )

IMPORT_C TTime

Time

(

)

const

Returns this field's date/time content.

Returns: This field's date/time content. StorageType()==KStorageTypeDateTime.

UniqueFieldIdentity ( )

IMPORT_C TInt

UniqueFieldIdentity

(

)

const

Returns an unique id for this field. NOTE: Returned id is valid only as long as this object is in memory in other words the id is not persistent!

Returns: The unique id for this field.

TPbkContactItemField Class Reference

Inherits from

Detailed Description

Constructor & Destructor Documentation

TPbkContactItemField ( )

TPbkContactItemField ( CContactItemField *, CPbkFieldInfo * )

Member Function Documentation

Compare ( const TPbkContactItemField & )

ContactItemField ( )

ContactItemField ( )

DateTimeStorage ( )

DefaultEmailField ( )

DefaultEmailOverSmsField ( )

DefaultMmsField ( )

DefaultPhoneNumberField ( )

DefaultPocField ( )

DefaultSmsField ( )

DefaultVideoNumberField ( )

DefaultVoipField ( )

FieldInfo ( )

GetTextL ( TDes & )

IconId ( )

IsEmpty ( )

IsEmptyOrAllSpaces ( )

IsHidden ( )

IsSame ( const TPbkContactItemField & )

ItemField ( )

Label ( )

PbkFieldId ( )

PbkFieldText ( )

PbkFieldTime ( )

PbkFieldType ( )

Set ( CContactItemField *, CPbkFieldInfo * )

SetHidden ( TBool )

SetLabelL ( const TDesC & )

SpeedDialIndexesL ( )

StorageType ( )

Text ( )

TextStorage ( )

Time ( )

UniqueFieldIdentity ( )

TPbkContactItemField ( CContactItemField , CPbkFieldInfo )

Set ( CContactItemField , CPbkFieldInfo )