CApSelect Class Reference

#include <mw/ApSelect.h>

Link against: APEngine.lib

class CApSelect : public CBase

Inherits from

CApSelect

Public Member Functions
virtual	~CApSelect()
IMPORT_C TInt	AllListItemDataL(CApListItemList &)
IMPORT_C TInt	BearerFilter()
IMPORT_C TApBearerType	BearerType()
IMPORT_C TUint32	Count()
IMPORT_C TBool	IsReadOnly()
IMPORT_C TInt	IspTypeFilter()
IMPORT_C TBool	MoveLast()
IMPORT_C TBool	MoveNext()
IMPORT_C TBool	MovePrev()
IMPORT_C TBool	MoveToFirst()
IMPORT_C const TDesC &	Name()
IMPORT_C CApSelect *	NewLC(CCommsDatabase &, TInt, TInt, TInt)
IMPORT_C CApSelect *	NewLC(CCommsDatabase &, TInt, TInt, TInt, TInt)
IMPORT_C CApSelect *	NewLC(CCommsDatabase &, TInt, TInt, TInt, TInt, TVpnFilterType)
IMPORT_C CApSelect *	NewLC(CCommsDatabase &, TInt, TInt, TInt, TInt, TVpnFilterType, TBool)
IMPORT_C void	SetFiltersL(TInt, TInt, TInt)
IMPORT_C TInt	SortOrder()
IMPORT_C TCommsDbIspType	Type()
IMPORT_C TUint32	Uid()

Protected Member Functions
	CApSelect()
IMPORT_C void	ConstructL(CCommsDatabase &, TInt, TInt, TInt)
IMPORT_C void	ConstructL(CCommsDatabase &, TInt, TInt, TInt, TInt)
IMPORT_C void	ConstructL(CCommsDatabase &, TInt, TInt, TInt, TInt, TVpnFilterType)
IMPORT_C void	ConstructL(CCommsDatabase &, TInt, TInt, TInt, TInt, TVpnFilterType, TBool)

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

This class is used to help client's access point selection. Selection can be tailored with specific filters, rules and sort order. Provides methods for setting and getting filters and sort order.

Constructor & Destructor Documentation

CApSelect ( )

IMPORT_C

CApSelect

(

)

[protected]

C++ default constructor.

Deprecated

~CApSelect ( )

IMPORT_C

~CApSelect

(

)

[virtual]

Destructor.

Deprecated

Member Function Documentation

AllListItemDataL ( CApListItemList & )

IMPORT_C TInt

AllListItemDataL

(

CApListItemList &

aList

)

Provides all data in a CApListItemList array. Deprecated

Parameter	Description
aList	A reference to a CApListItemList object to hold the values.

Returns: The number of items in the list. All elements in the aList array and their memory will be freed inside the routine. The routine expands or shrinks the array as necessary to minimize memory consumption.

BearerFilter ( )

IMPORT_C TInt

BearerFilter

(

)

Gets the current bearer-type filter Deprecated

Returns: The current bearer-type filter

BearerType ( )

IMPORT_C TApBearerType

BearerType

(

)

Gets the bearer-type of the current access point Deprecated

Returns: The bearer-type of the current access point.

ConstructL ( CCommsDatabase &, TInt, TInt, TInt )

IMPORT_C void	ConstructL	(	CCommsDatabase &	aDb,
			TInt	aIspFilter,
			TInt	aBearerFilter,
			TInt	aSortType
		)	[protected]

Second-phase constructor. Deprecated

Parameter	Description
aDb	a pointer to a CCommsDataBase.
aBearerFilter	Filtering criteria on bearer type Possible values are the TApBearer enums and their combinations (or-ed).
aSortType	Specifies the sort order to use. Possible values are: KEApSortUidAscending, KEApSortUidDescending, KEApSortNameAscending, KEApSortNameDescending

ConstructL ( CCommsDatabase &, TInt, TInt, TInt, TInt )

IMPORT_C void	ConstructL	(	CCommsDatabase &	aDb,
			TInt	aIspFilter,
			TInt	aBearerFilter,
			TInt	aSortType,
			TInt	aReqIpvType
		)	[protected]

Second-phase constructor. Deprecated

Parameter	Description
aDb	a pointer to a CCommsDataBase.
aBearerFilter	Filtering criteria on bearer type Possible values are the TApBearer enums and their combinations (or-ed).
aSortType	Specifies the sort order to use. Possible values are: KEApSortUidAscending, KEApSortUidDescending, KEApSortNameAscending, KEApSortNameDescending
aReqIpvType	Filtering criteria on the IPv type of the access point. In case of GPRS, GPRS_PDP_TYPE holds it, while in case of CSD, all CSD access points are considered to be IPv4 & IPv6 (both)

ConstructL ( CCommsDatabase &, TInt, TInt, TInt, TInt, TVpnFilterType )

IMPORT_C void	ConstructL	(	CCommsDatabase &	aDb,
			TInt	aIspFilter,
			TInt	aBearerFilter,
			TInt	aSortType,
			TInt	aReqIpvType,
			TVpnFilterType	aVpnFilterType
		)	[protected]

Second-phase constructor. Deprecated

Parameter	Description
aDb	a pointer to a CCommsDataBase.
aBearerFilter	Filtering criteria on bearer type Possible values are the TApBearer enums and their combinations (or-ed).
aSortType	Specifies the sort order to use. Possible values are: KEApSortUidAscending, KEApSortUidDescending, KEApSortNameAscending, KEApSortNameDescending
aReqIpvType	Filtering criteria on the IPv type of the access point. In case of GPRS, GPRS_PDP_TYPE holds it, while in case of CSD, all CSD access points are considered to be IPv4 & IPv6 (both)
aVpnFilterType	a TVpnFilterType enum specifying the vpn filtering.

ConstructL ( CCommsDatabase &, TInt, TInt, TInt, TInt, TVpnFilterType, TBool )

IMPORT_C void	ConstructL	(	CCommsDatabase &	aDb,
			TInt	aIspFilter,
			TInt	aBearerFilter,
			TInt	aSortType,
			TInt	aReqIpvType,
			TVpnFilterType	aVpnFilterType,
			TBool	aIncludeEasyWlan
		)	[protected]

Second-phase constructor. Deprecated

Parameter	Description
aDb	a pointer to a CCommsDataBase.
aBearerFilter	Filtering criteria on bearer type Possible values are the TApBearer enums and their combinations (or-ed).
aSortType	Specifies the sort order to use. Possible values are: KEApSortUidAscending, KEApSortUidDescending, KEApSortNameAscending, KEApSortNameDescending
aReqIpvType	Filtering criteria on the IPv type of the access point. In case of GPRS, GPRS_PDP_TYPE holds it, while in case of CSD, all CSD access points are considered to be IPv4 & IPv6 (both)
aVpnFilterType	a TVpnFilterType enum specifying the vpn filtering.
aIncludeEasyWlan	TBool specifying whther to include EasyWlan access point in the list or not...

Count ( )

IMPORT_C TUint32

Count

(

)

Counts the items in the list Deprecated

Returns: The number of items in the list.

IsReadOnly ( )

IMPORT_C TBool

IsReadOnly

(

)

const

Returns whether the current item is read-only or not. Deprecated

Returns: Returns whether the current item is read-only or not.

IspTypeFilter ( )

IMPORT_C TInt

IspTypeFilter

(

)

Gets the current ISP-type filter Deprecated

Returns: The current ISP-type filter

MoveLast ( )

IMPORT_C TBool

MoveLast

(

)

Navigates to the last access point in the list. Deprecated

Returns: Boolean indicating the success of the operation.

MoveNext ( )

IMPORT_C TBool

MoveNext

(

)

Navigates to the next access point in the list. Deprecated

Returns: Boolean indicating the success of the operation.

MovePrev ( )

IMPORT_C TBool

MovePrev

(

)

Navigates to the previous access point in the list. Deprecated

Returns: Boolean indicating the success of the operation.

MoveToFirst ( )

IMPORT_C TBool

MoveToFirst

(

)

Navigates to the first access point in the list. Deprecated

Returns: Boolean indicating the success of the operation.

Name ( )

IMPORT_C const TDesC &

Name

(

)

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

Returns: The name of the current access point

NewLC ( CCommsDatabase &, TInt, TInt, TInt )

IMPORT_C CApSelect *	NewLC	(	CCommsDatabase &	aDb,
			TInt	aIspFilter,
			TInt	aBearerFilter,
			TInt	aSortType
		)	[static]

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

Parameter	Description
aDb	a pointer to a CCommsDataBase.
aBearerFilter	Filtering criteria on bearer type Possible values are the TApBearer enums and their combinations (or-ed).
aSortType	Specifies the sort order to use. Possible values are: KEApSortUidAscending, KEApSortUidDescending, KEApSortNameAscending, KEApSortNameDescending

Returns: The constructed CApSelect.

NewLC ( CCommsDatabase &, TInt, TInt, TInt, TInt )

IMPORT_C CApSelect *	NewLC	(	CCommsDatabase &	aDb,
			TInt	aIspFilter,
			TInt	aBearerFilter,
			TInt	aSortType,
			TInt	aReqIpvType
		)	[static]

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

Parameter	Description
aDb	a pointer to a CCommsDataBase.
aBearerFilter	Filtering criteria on bearer type Possible values are the TApBearer enums and their combinations (or-ed).
aSortType	Specifies the sort order to use. Possible values are: KEApSortUidAscending, KEApSortUidDescending, KEApSortNameAscending, KEApSortNameDescending
aReqIpvType	Filtering criteria on the IPv type of the access point. In case of GPRS, GPRS_PDP_TYPE holds it, while in case of CSD, all CSD access points are considered to be IPv4 & IPv6 (both)

Returns: The constructed CApSelect.

NewLC ( CCommsDatabase &, TInt, TInt, TInt, TInt, TVpnFilterType )

IMPORT_C CApSelect *	NewLC	(	CCommsDatabase &	aDb,
			TInt	aIspFilter,
			TInt	aBearerFilter,
			TInt	aSortType,
			TInt	aReqIpvType,
			TVpnFilterType	aVpnFilterType
		)	[static]

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

Parameter	Description
aDb	a pointer to a CCommsDataBase.
aBearerFilter	Filtering criteria on bearer type Possible values are the TApBearer enums and their combinations (or-ed).
aSortType	Specifies the sort order to use. Possible values are: KEApSortUidAscending, KEApSortUidDescending, KEApSortNameAscending, KEApSortNameDescending
aReqIpvType	Filtering criteria on the IPv type of the access point. In case of GPRS, GPRS_PDP_TYPE holds it, while in case of CSD, all CSD access points are considered to be IPv4 & IPv6 (both)
aVpnFilterType	a TVpnFilterType enum specifying the vpn filtering.

Returns: The constructed CApSelect.

NewLC ( CCommsDatabase &, TInt, TInt, TInt, TInt, TVpnFilterType, TBool )

IMPORT_C CApSelect *	NewLC	(	CCommsDatabase &	aDb,
			TInt	aIspFilter,
			TInt	aBearerFilter,
			TInt	aSortType,
			TInt	aReqIpvType,
			TVpnFilterType	aVpnFilterType,
			TBool	aIncludeEasyWlan
		)	[static]

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

Parameter	Description
aDb	a pointer to a CCommsDataBase.
aBearerFilter	Filtering criteria on bearer type Possible values are the TApBearer enums and their combinations (or-ed).
aSortType	Specifies the sort order to use. Possible values are: KEApSortUidAscending, KEApSortUidDescending, KEApSortNameAscending, KEApSortNameDescending
aReqIpvType	Filtering criteria on the IPv type of the access point. In case of GPRS, GPRS_PDP_TYPE holds it, while in case of CSD, all CSD access points are considered to be IPv4 & IPv6 (both)
aVpnFilterType	a TVpnFilterType enum specifying the vpn filtering.
aIncludeEasyWlan	TBool specifying whther to include EasyWlan access point in the list or not...

Returns: The constructed CApSelect.

SetFiltersL ( TInt, TInt, TInt )

IMPORT_C void	SetFiltersL	(	TInt	aIspFilter,
			TInt	aBearerFilter,
			TInt	aSortType
		)

Sets filters and sorting order for the list of available access points Deprecated

Parameter	Description
aBearerFilter	Filtering criteria on bearer type Possible values are the TApBearer enums and their combinations (or-ed).
aSortType	Specifies the sort order to use. Possible values are: KEApSortUidAscending, KEApSortUidDescending, KEApSortNameAscending, KEApSortNameDescending

SortOrder ( )

IMPORT_C TInt

SortOrder

(

)

Gets the current sorting order Deprecated

Returns: The current sorting order

Type ( )

IMPORT_C TCommsDbIspType

Type

(

)

Gets the ISP-type of the current access point Deprecated

Returns: The ISP-type of the current access point.

Uid ( )

IMPORT_C TUint32

Uid

(

)

Gets the UID of the current access point Deprecated

Returns: The UID of the current access point