UIQ Technology
Symbian OS Library

UIQ 3.1 SDK        UIQ developer portal

[Index] [Spacer] [Previous] [Next]



Location: ContacUIReturnData.h
Link against: qcontacui.lib

Class CContacuiReturnData

class CContacuiReturnData : public CBase;

Description

An object to collect information about a contact item. The data that will be stored is the id of the contact, the id of the field, the type of the field (TContactsListBoxFieldType) and the data in the field.

Derivation

Members

Defined in CContacuiReturnData:
ContactId(), FieldId(), IsMailable(), IsPhonable(), IsSmsable(), NewL(), NewL(), ReturnedData(), ~CContacuiReturnData()

Inherited from CBase:
Delete(), Extension_(), operator new()


Construction and destruction


NewL()

static IMPORT_C CContacuiReturnData *NewL(TContactItemId aId, TInt aFieldId, const TPtrC &aData, TContactsListBoxFieldType aType);

Description

Factory method that creates and return a new CContacuiReturnData instance.

Parameters

TContactItemId aId

The ID of the contact.

TInt aFieldId

The ID of the field in the contact.

const TPtrC &aData

The data in the field.

TContactsListBoxFieldType aType

The type of the data to be returned.

Return value

CContacuiReturnData *

A pointer to the newly created CContacuiReturnData object


NewL()

static IMPORT_C CContacuiReturnData *NewL(TContactItemId aId, TInt aFieldId, const TPtrC &aData, const CContentType *aType);

Description

Factory method that creates and return a new CContacuiReturnData instance.

Parameters

TContactItemId aId

The ID of the contact.

TInt aFieldId

The ID of the field in the contact.

const TPtrC &aData

The data in the field.

const CContentType *aType

The type of the data to be returned.

Return value

CContacuiReturnData *

A pointer to the newly created CContacuiReturnData object


~CContacuiReturnData()

IMPORT_C ~CContacuiReturnData();

Description

Destructor

[Top]


Member functions


ContactId()

IMPORT_C TContactItemId ContactId() const;

Description

Method that returns the ID of a contact.

Return value

TContactItemId

A ContactID of the type TContactItemId.


FieldId()

IMPORT_C TInt FieldId() const;

Description

Method that returns the ID of the contacts field.

Return value

TInt

A field ID of the type TInt.


ReturnedData()

IMPORT_C TPtrC ReturnedData() const;

Description

Method that returns the data in the field

Return value

TPtrC

The data in the field.


IsSmsable()

IMPORT_C TBool IsSmsable() const;

Description

Checks if iDataType is of smsable field type

Return value

TBool

Return true if the datatype is of smsable field type (mobile och landline phone field types)


IsMailable()

IMPORT_C TBool IsMailable() const;

Description

Checks if iDataType is of email field type

Return value

TBool

Return true if the datatype is a email field type


IsPhonable()

IMPORT_C TBool IsPhonable() const;

Description

Checks if iDataType is of phonable field type

Return value

TBool

Return true if the datatype is some kind of phone field type