Symbian^3 Application Developer Library >

CRequestorBase Class Reference

class CRequestorBase : public CBase
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.

Inherits from

Public Member Functions
~CRequestorBase ()
IMPORT_C void ExternalizeL ( RWriteStream &)
IMPORT_C void GetRequestor ( TRequestorType &, TRequestorFormat &, TPtrC &)
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 &)
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()
Public Member Enumerations
enum _TRequestorFormat { EFormatUnknown , EFormatApplication , EFormatTelephone , EFormatUrl , EFormatMail }
enum _TRequestorType { ERequestorUnknown , ERequestorService , ERequestorContact }
Public Member Type Definitions
typedef TInt TRequestorFormat
typedef TInt TRequestorType
Protected Attributes
TRequestorFormat iFormat
TRequestorType iRequestorType
Private Attributes
TAny * iBaseReservedPtr
HBufC * iData

Constructor & Destructor Documentation

CRequestorBase()

IMPORT_C CRequestorBase ( ) [protected]

Constructor for CRequestorBase .

~CRequestorBase()

IMPORT_C ~CRequestorBase ( )

Destructor for CRequestorBase .

Member Functions 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

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.

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

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.

ExternalizeL(RWriteStream &)

IMPORT_C void ExternalizeL ( RWriteStream & aStream ) const [virtual]

Stores this requestors member data to a stream.

Parameters

RWriteStream & 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

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.

InternalizeL(RReadStream &)

IMPORT_C void InternalizeL ( RReadStream & aStream ) [virtual]

Restores this requestors member data from a stream.

Parameters

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

RequestorData()

IMPORT_C TDesC & RequestorData ( ) const

Simple accessor for this requestors member data.

RequestorFormat()

IMPORT_C TRequestorFormat RequestorFormat ( ) const

Simple accessor for this requestors member data.

RequestorType()

IMPORT_C TRequestorType RequestorType ( ) const

Simple accessor for this requestors member data.

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

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.

Member Enumerations Documentation

Enum _TRequestorFormat

TRequestorFormat

Enumerators

EFormatUnknown

Requestor format unknown

EFormatApplication

EFormatApplication

EFormatTelephone

EFormatTelephone

EFormatUrl

EFormatUrl

EFormatMail

EFormatMail

Enum _TRequestorType

TRequestorType

Enumerators

ERequestorUnknown

Unknown Requestor

ERequestorService

Requestor of type Service

ERequestorContact

Requestor of type Contact

Member Type Definitions Documentation

Typedef TRequestorFormat

typedef TInt TRequestorFormat

defined type for TRequestorFormat

Typedef TRequestorType

typedef TInt TRequestorType

defined type for TRequestorType

Member Data Documentation

TAny * iBaseReservedPtr

TAny * iBaseReservedPtr [private]

Reserved data for future extension

HBufC * iData

HBufC * iData [private]

This is owned by the CRequestor

TRequestorFormat iFormat

TRequestorFormat iFormat [protected]

Requestor format

TRequestorType iRequestorType

TRequestorType iRequestorType [protected]

Requestor type

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.