TPbkContactItemField Class Reference

IMPORT_C TInt TPbkContactItemField::Compare

�	C++ default constructor.

IMPORT_C TPbkContactItemField::TPbkContactItemField	(�	CContactItemField *�	aField,
		CPbkFieldInfo *�	aFieldInfo
	)�

�

C++ constructor.

Parameters:

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

Member Function Documentation

const TPbkContactItemField &�

Compares two items against the group ordering.

Parameters:

aRhs�

Contact item field to compare to this field.

IMPORT_C const CContactItemField& TPbkContactItemField::ContactItemField

IMPORT_C CContactItemField& TPbkContactItemField::ContactItemField

�	Converts this field to a const CContactItemField. Returns: The embedded CContactItemField object.

IMPORT_C CContactDateField* TPbkContactItemField::DateTimeStorage

�	Converts this field to a CContactItemField. Returns: The embedded CContactItemField object.

IMPORT_C TBool TPbkContactItemField::DefaultEmailField

�	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.

IMPORT_C TBool TPbkContactItemField::DefaultEmailOverSmsField

�	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.

IMPORT_C TBool TPbkContactItemField::DefaultMmsField

�	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.

IMPORT_C TBool TPbkContactItemField::DefaultPhoneNumberField

�	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.

IMPORT_C TBool TPbkContactItemField::DefaultPocField

�	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.

IMPORT_C TBool TPbkContactItemField::DefaultSmsField

�	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.

IMPORT_C TBool TPbkContactItemField::DefaultVideoNumberField

�	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.

IMPORT_C TBool TPbkContactItemField::DefaultVoipField

�	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.

IMPORT_C CPbkFieldInfo& TPbkContactItemField::FieldInfo

�	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.

IMPORT_C void TPbkContactItemField::GetTextL

�	Returns the Phonebook field info object of this field. Returns: Field info for this field.

Fills aText with field's text content.

If field is of date type formats the date as text.

Parameters:

aText�

Fills parameter with field's content.

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.

IMPORT_C TPbkIconId TPbkContactItemField::IconId

IMPORT_C TBool TPbkContactItemField::IsEmpty

�	Returns an Phonebook icon id for this field. Returns: The Phonebook icon id for this field.

IMPORT_C TBool TPbkContactItemField::IsEmptyOrAllSpaces

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

IMPORT_C TBool TPbkContactItemField::IsHidden

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

IMPORT_C TBool TPbkContactItemField::IsSame

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

const TPbkContactItemField &�

aField

IMPORT_C CContactItemField& TPbkContactItemField::ItemField

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

IMPORT_C TPtrC TPbkContactItemField::Label

�	Returns the embedded contact item field. Returns: The embedded contact item field.

IMPORT_C void TPbkContactItemField::SetHidden

�	Returns the label text of this field. Returns: The label text of this field.

IMPORT_C TPbkFieldId TPbkContactItemField::PbkFieldId (� �)� const [virtual]

�	Returns the field id of this field data. Implements MPbkFieldData.

IMPORT_C TPtrC TPbkContactItemField::PbkFieldText (� �)� const [virtual]

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

IMPORT_C TTime TPbkContactItemField::PbkFieldTime (� �)� const [virtual]

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

IMPORT_C TStorageType TPbkContactItemField::PbkFieldType (� �)� const [virtual]

�	Returns the type of this field data. Returns: KStrorageTypeText or KStoragetTypeDateTime. Implements MPbkFieldData.

IMPORT_C void TPbkContactItemField::Set	(�	CContactItemField *�	aField,
		CPbkFieldInfo *�	aFieldInfo
	)�

�

Sets the contents of this object after construction.

Parameters:

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

Marks this field as hidden or unhidden.

Parameters:

aHidden�

ETrue marks as hidden EFalse removes the mark.

IMPORT_C void TPbkContactItemField::SetLabelL

Sets the label text of this field to aLabel.

Parameters:

aLabel�

Text to set as the label of this field.

IMPORT_C CArrayFix<TInt>* TPbkContactItemField::SpeedDialIndexesL

IMPORT_C TStorageType TPbkContactItemField::StorageType

�	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.

IMPORT_C TPtrC TPbkContactItemField::Text

�	Returns the storage type of this field. Returns: The storage type of this field.

IMPORT_C CContactTextField* TPbkContactItemField::TextStorage

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

IMPORT_C TTime TPbkContactItemField::Time

�	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.

IMPORT_C TInt TPbkContactItemField::UniqueFieldIdentity

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