Collapse all Symbian^3 Product Developer Library

CApListItem Class Reference

class CApListItem : public CBase

Representation of a list item.< This class is used to hold the main information of an access point. It is used in CApSelect.

Inherits from

CApListItem
- CBase

Public Member Functions
	~CApListItem()
IMPORT_C TApBearerType	BearerType()
IMPORT_C void	CopyFromL(const CApListItem &)
IMPORT_C TBool	IsReadOnly()
TBool	IsVpnAp()
IMPORT_C const TDesC &	Name()
IMPORT_C CApListItem *	NewLC()
IMPORT_C CApListItem *	NewLC(TCommsDbIspType, TUint32, const TDesC &, TApBearerType)
IMPORT_C CApListItem *	NewLC(TCommsDbIspType, TUint32, const TDesC &, TApBearerType, const TDesC &, TBool)
IMPORT_C CApListItem *	NewLC(CApListItem *)
IMPORT_C void	SetItemL(TCommsDbIspType, TUint32, const TDesC &, TApBearerType)
IMPORT_C void	SetItemL(TCommsDbIspType, TUint32, const TDesC &, TApBearerType, const TDesC &)
void	SetVpnFlag(TBool)
IMPORT_C const TDesC &	StartPage()
IMPORT_C TCommsDbIspType	Type()
IMPORT_C TUint32	Uid()

Protected Member Functions
	CApListItem()
IMPORT_C void	ConstructL(TCommsDbIspType, TUint32, const TDesC &, TApBearerType)
IMPORT_C void	ConstructL(TCommsDbIspType, TUint32, const TDesC &, TApBearerType, const TDesC &)
IMPORT_C void	ConstructL()
void	CreateExtraL()

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

Private Attributes
TApBearerType	iBearerType
TApListItemExtra *	iExt
TCommsDbIspType	iIspType
HBufC *	iName
HBufC *	iStartPage
TUint32	iUid

Constructor & Destructor Documentation

CApListItem()

IMPORT_C

CApListItem

(

)

[protected]

C++ default constructor.

~CApListItem()

IMPORT_C

~CApListItem

(

)

[virtual]

Destructor.

Member Functions Documentation

BearerType()

IMPORT_C TApBearerType

BearerType

(

)

Gets the bearer-type of the current access point

ConstructL(TCommsDbIspType, TUint32, const TDesC &, TApBearerType)

IMPORT_C void	ConstructL	(	TCommsDbIspType	aIspType,
			TUint32	aUid,
			const TDesC &	aName,
			TApBearerType	aBearerType
		)	[protected]

NOTE: This function is deprecated, use the one with the additional aStartPage parameter below. Second-phase constructor.

Parameters

TCommsDbIspType aIspType	The type of the access point (Internet only, Wap only, Internet AND Wap)
TUint32 aUid	The ID of the access point
const TDesC & aName	The name of the access point
TApBearerType aBearerType	The bearer type of the access point

ConstructL(TCommsDbIspType, TUint32, const TDesC &, TApBearerType, const TDesC &)

IMPORT_C void	ConstructL	(	TCommsDbIspType	aIspType,
			TUint32	aUid,
			const TDesC &	aName,
			TApBearerType	aBearerType,
			const TDesC &	aStartPage
		)	[protected]

Second-phase constructor.

Parameters

TCommsDbIspType aIspType	The type of the access point (Internet only, Wap only, Internet AND Wap)
TUint32 aUid	The ID of the access point
const TDesC & aName	The name of the access point
TApBearerType aBearerType	The bearer type of the access point
const TDesC & aStartPage

ConstructL()

IMPORT_C void

ConstructL

(

)

[protected]

Second-phase constructor.

CopyFromL(const CApListItem &)

IMPORT_C void

CopyFromL

(

const CApListItem &

aCopyFrom

)

Copies the data from another CApListItem Substitutes the "Assignment operator."

Parameters

const CApListItem & aCopyFrom

CreateExtraL()

void

CreateExtraL

(

)

[protected]

IsReadOnly()

IMPORT_C TBool

IsReadOnly

(

)

const

Returns whether the access point is read-only or not.

IsVpnAp()

TBool

IsVpnAp

(

)

const

Returnes whether the given access point is a VPN ap or not.

Name()

IMPORT_C const TDesC &

Name

(

)

Gets the name of the 'current' access point Ownership of the returned text is not passed.

NewLC()

IMPORT_C CApListItem *

NewLC

(

)

[static]

Two-phased constructor. Leaves on failure, places instance on cleanup stack.

NewLC(TCommsDbIspType, TUint32, const TDesC &, TApBearerType)

IMPORT_C CApListItem *	NewLC	(	TCommsDbIspType	aIspType,
			TUint32	aUid,
			const TDesC &	aName,
			TApBearerType	aBearerType
		)	[static]

NOTE: This function is deprecated, use the one with the additional aStartPage parameter below. Two-phased constructor. Leaves on failure, places instance on cleanup stack.

Parameters

TCommsDbIspType aIspType	The type of the access point (Internet only, Wap only, Internet AND Wap)
TUint32 aUid	The ID of the access point
const TDesC & aName	The name of the access point
TApBearerType aBearerType	The bearer type of the access point

NewLC(TCommsDbIspType, TUint32, const TDesC &, TApBearerType, const TDesC &, TBool)

IMPORT_C CApListItem *	NewLC	(	TCommsDbIspType	aIspType,
			TUint32	aUid,
			const TDesC &	aName,
			TApBearerType	aBearerType,
			const TDesC &	aStartPage,
			TBool	aReadOnly = ETrue
		)	[static]

Two-phased constructor. Leaves on failure, places instance on cleanup stack.

Parameters

TCommsDbIspType aIspType	The type of the access point (Internet only, Wap only, Internet AND Wap)
TUint32 aUid	The ID of the access point
const TDesC & aName	The name of the access point
TApBearerType aBearerType	The bearer type of the access point
const TDesC & aStartPage
TBool aReadOnly = ETrue	Whether the given item is read-only or not

NewLC(CApListItem *)

IMPORT_C CApListItem *

NewLC

(

CApListItem *

aItem

)

[static]

Two-phased constructor. Leaves on failure, places instance on cleanup stack.

Parameters

CApListItem * aItem

a pointer to a CApListItem.

SetItemL(TCommsDbIspType, TUint32, const TDesC &, TApBearerType)

IMPORT_C void	SetItemL	(	TCommsDbIspType	aIspType,
			TUint32	aUid,
			const TDesC &	aName,
			TApBearerType	aBearerType
		)

NOTE: This function is deprecated, use the one with the additional aStartPage parameter below. Sets item values of the access point. Leaves on failure.

Parameters

TCommsDbIspType aIspType	The type of the access point (Internet only, Wap only, Internet AND Wap)
TUint32 aUid	The ID of the access point
const TDesC & aName	The name of the access point
TApBearerType aBearerType	The bearer type of the access point

SetItemL(TCommsDbIspType, TUint32, const TDesC &, TApBearerType, const TDesC &)

IMPORT_C void	SetItemL	(	TCommsDbIspType	aIspType,
			TUint32	aUid,
			const TDesC &	aName,
			TApBearerType	aBearerType,
			const TDesC &	aStartpage
		)

Sets item values of the access point. Leaves on failure.

Parameters

TCommsDbIspType aIspType	The type of the access point (Internet only, Wap only, Internet AND Wap)
TUint32 aUid	The ID of the access point
const TDesC & aName	The name of the access point
TApBearerType aBearerType	The bearer type of the access point
const TDesC & aStartpage	The starting page of the access point

SetVpnFlag(TBool)

void

SetVpnFlag

(

TBool

aIsVpn

)

Sets whether the given access point is a VPN ap or not.

Parameters

TBool aIsVpn

StartPage()

IMPORT_C const TDesC &

StartPage

(

)

const

Returns the startpage of the current access point if any, otherwise, an empty string is returned. Ownership of the returned text is not passed.

Type()

IMPORT_C TCommsDbIspType

Type

(

)

Gets the ISP-type of the current access point

Uid()

IMPORT_C TUint32

Uid

(

)

Gets the UID of the current access point

Member Data Documentation

TApBearerType iBearerType

TApBearerType

iBearerType

[private]

TApListItemExtra * iExt

TApListItemExtra *

iExt

[private]

TCommsDbIspType iIspType

TCommsDbIspType

iIspType

[private]

The type of the access point (Internet only, Wap only, Internet AND Wap)

HBufC * iName

HBufC *

iName

[private]

HBufC * iStartPage

HBufC *

iStartPage

[private]

TUint32 iUid

TUint32

iUid

[private]