CRequestorBase Class Reference

#include <lbsrequestor.h>

class CRequestorBase : public CBase

Inherits from

CRequestorBase
- CBase

Public Member Type Definitions
typedef	TInt TRequestorFormat
typedef	TInt TRequestorType

Protected Attributes
TRequestorFormat	iFormat
TRequestorType	iRequestorType

Public Member Enumerations
enum	_TRequestorFormat { EFormatUnknown, EFormatApplication, EFormatTelephone, EFormatUrl, EFormatMail }
enum	_TRequestorType { ERequestorUnknown, ERequestorService, ERequestorContact }

Public Member Functions
	~CRequestorBase()
virtual IMPORT_C void	ExternalizeL(RWriteStream &)
IMPORT_C void	GetRequestor(TRequestorType &, TRequestorFormat &, TPtrC &)
virtual IMPORT_C void	InternalizeL(RReadStream &)
IMPORT_C TDesC &	RequestorData()
IMPORT_C TRequestorFormat	RequestorFormat()
IMPORT_C TRequestorType	RequestorType()
IMPORT_C void	SetRequestorL(TRequestorType, TRequestorFormat, const TDesC &)

Protected Member Functions
	CRequestorBase()
IMPORT_C void	ConstructL(TRequestorType, TRequestorFormat, const TDesC &)
virtual IMPORT_C TAny *	ExtendedInterface(TInt, TAny , TAny )

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()

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

Member Type Definition Documentation

Typedef TRequestorFormat

typedef TInt

TRequestorFormat

defined type for TRequestorFormat

Typedef TRequestorType

typedef TInt

TRequestorType

defined type for TRequestorType

Member Attribute Documentation

iFormat

TRequestorFormat

iFormat

[protected]

Requestor format

iRequestorType

TRequestorType

iRequestorType

[protected]

Requestor type

Member Enumeration Documentation

Enum _TRequestorFormat

TRequestorFormat

Enumerator	Value	Description
EFormatUnknown		Requestor format unknown
EFormatApplication		EFormatApplication
EFormatTelephone		EFormatTelephone
EFormatUrl		EFormatUrl
EFormatMail		EFormatMail

Enum _TRequestorType

TRequestorType

Enumerator	Value	Description
ERequestorUnknown		Unknown Requestor
ERequestorService		Requestor of type Service
ERequestorContact		Requestor of type Contact

Constructor & Destructor Documentation

CRequestorBase ( )

IMPORT_C

CRequestorBase

(

)

[protected]

Constructor for CRequestorBase.

~CRequestorBase ( )

IMPORT_C

~CRequestorBase

(

)

Destructor for CRequestorBase.

Member Function Documentation

ConstructL ( TRequestorType, TRequestorFormat, const TDesC & )

IMPORT_C void	ConstructL	(	TRequestorType	aType,
			TRequestorFormat	aFormat,
			const TDesC &	aData
		)	[protected]

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

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

ExtendedInterface ( TInt, TAny , TAny )

IMPORT_C TAny *	ExtendedInterface	(	TInt	aFunctionNumber,
			TAny *	aPtr1,
			TAny *	aPtr2
		)	[protected, virtual]

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

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

Return Value: TAny* a pointer to any function

ExternalizeL ( RWriteStream & )

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

const [virtual]

Stores this requestors member data to a stream.

Parameters
aStream	the stream to which the requestors data is written.

GetRequestor ( TRequestorType &, TRequestorFormat &, TPtrC & )

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

Simple accessor for this requestors member data.

Parameters
aType	will be set to the type of requestor.
aFormat	will be set to the type of data held in aData.
aData	will be set to point to this requestors data.

InternalizeL ( RReadStream & )

IMPORT_C void

InternalizeL

(

RReadStream &

aStream

)

[virtual]

Restores this requestors member data from a stream.

Parameters
aStream	the stream from which the requestors data is read.

RequestorData ( )

IMPORT_C TDesC &

RequestorData

(

)

const

Simple accessor for this requestors member data.

Return Value: the requestor data.

RequestorFormat ( )

IMPORT_C TRequestorFormat

RequestorFormat

(

)

const

Simple accessor for this requestors member data.

Return Value: the type of data held in this requestor.

RequestorType ( )

IMPORT_C TRequestorType

RequestorType

(

)

const

Simple accessor for this requestors member data.

Return Value: the type of requestor, a service or a contact.

SetRequestorL ( TRequestorType, TRequestorFormat, const TDesC & )

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

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

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

CRequestorBase Class Reference

Inherits from

Detailed Description

Member Type Definition Documentation

Typedef TRequestorFormat

Typedef TRequestorType

Member Attribute Documentation

iFormat

iRequestorType

Member Enumeration Documentation

Enum _TRequestorFormat

Enum _TRequestorType

Constructor & Destructor Documentation

CRequestorBase ( )

~CRequestorBase ( )

Member Function Documentation

ConstructL ( TRequestorType, TRequestorFormat, const TDesC & )

ExtendedInterface ( TInt, TAny *, TAny * )

ExternalizeL ( RWriteStream & )

GetRequestor ( TRequestorType &, TRequestorFormat &, TPtrC & )

InternalizeL ( RReadStream & )

RequestorData ( )

RequestorFormat ( )

RequestorType ( )

SetRequestorL ( TRequestorType, TRequestorFormat, const TDesC & )

ExtendedInterface ( TInt, TAny , TAny )