Class CRequestorBase

class CRequestorBase : public CBase;

Description

Each instance of a CRequestor class is used to hold the identity of one of the parties involved requesting the location. The class contains three data fields that indicate: (1) If the requesting party is a "service" or an actual person ("contact"). (2) A descriptor that identifiers the requestor and (3) a field that indicates which format the information is in

• for example, a telephone number, URL or email address.

Derivation

• CBase - Base class for all classes to be instantiated on the heap

• CRequestorBase - Each instance of a CRequestor class is used to hold the identity of one of the parties involved requesting the location

Members

Defined in CRequestorBase:
CRequestorBase(), ConstructL(), EFormatApplication, EFormatMail, EFormatTelephone, EFormatUnknown, EFormatUrl, ERequestorContact, ERequestorService, ERequestorUnknown, ExtendedInterface(), ExternalizeL(), GetRequestor(), InternalizeL(), RequestorData(), RequestorFormat(), RequestorType(), SetRequestorL(), TRequestorFormat, TRequestorType, _TRequestorFormat, _TRequestorType, iFormat, iRequestorType, ~CRequestorBase()

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

IMPORT_C ~CRequestorBase();

Description

Destructor for CRequestorBase.

protected: IMPORT_C CRequestorBase();

Description

Constructor for CRequestorBase.

protected: IMPORT_C void ConstructL(TRequestorType aType, TRequestorFormat aFormat, const TDesC &aData);

Description

Second phase constructor. Must be called by all derived classes to initialise CRequestorBase.

Parameters

TRequestorType aType identifies the type of requestor, a service or a contact. TRequestorFormat aFormat determines the type of data held in aData const TDesC &aData is requestor data. Can be a telephone number, a URL etc.

IMPORT_C void SetRequestorL(TRequestorType aType, TRequestorFormat aFormat, const TDesC &aData);

Description

Replaces the requestor data for this object with the specified data.

Parameters

TRequestorType aType identifies the type of requestor, a service or a contact. TRequestorFormat aFormat determines the type of data held in aData const TDesC &aData is requestor data. Can be a telephone number, a URL etc.

IMPORT_C void GetRequestor(TRequestorType &aType, TRequestorFormat &aFormat, TPtrC &aData) const;

Description

Simple accessor for this requestors member data.

Parameters

TRequestorType &aType will be set to the type of requestor. TRequestorFormat &aFormat will be set to the type of data held in aData. TPtrC &aData will be set to point to this requestors data.

IMPORT_C TRequestorType RequestorType() const;

Description

Simple accessor for this requestors member data.

Return value

TRequestorType the type of requestor, a service or a contact.

IMPORT_C TRequestorFormat RequestorFormat() const;

Description

Simple accessor for this requestors member data.

Return value

TRequestorFormat the type of data held in this requestor.

IMPORT_C TDesC &RequestorData() const;

Description

Simple accessor for this requestors member data.

Return value

TDesC & the requestor data.

virtual IMPORT_C void InternalizeL(RReadStream &aStream);

Description

Restores this requestors member data from a stream.

Parameters

RReadStream &aStream the stream from which the requestors data is read.

virtual IMPORT_C void ExternalizeL(RWriteStream &aStream) const;

Description

Stores this requestors member data to a stream.

Parameters

RWriteStream &aStream the stream to which the requestors data is written.

protected: virtual IMPORT_C TAny *ExtendedInterface(TInt aFunctionNumber, TAny *aPtr1, TAny *aPtr2);

Description

This method is used to allow polymorphic extensions to the API without breaking BC. See documentation for explanation.

Parameters

TInt aFunctionNumber contains the Id of the function to be invoked. TAny *aPtr1 a pointer to any data TAny *aPtr2 a pointer to any data.

Return value

TAny * TAny* a pointer to any function

_TRequestorType

Description

TRequestorType

ERequestorUnknown Unknown Requestor ERequestorService Requestor of type Service ERequestorContact Requestor of type Contact

_TRequestorFormat

Description

TRequestorFormat

EFormatUnknown Requestor format unknown EFormatApplication EFormatApplication EFormatTelephone EFormatTelephone EFormatUrl EFormatUrl EFormatMail EFormatMail

typedef TInt CRequestorBase::TRequestorType;

Description

defined type for TRequestorType

typedef TInt CRequestorBase::TRequestorFormat;

Description

defined type for TRequestorFormat

protected: TRequestorType iRequestorType;

Description

Requestor type

protected: TRequestorFormat iFormat;

Description

Requestor format