CApSelect Class Reference

API published in: S60 1st Ed
API deprecated in: S60 3rd Ed FP 2

Link against: apengine.lib

Capability Information

Required Capabilities

None

Exceptions

Functions modifying database (Create, Update, Delete) need WriteDeviceData. (CApDataHandler, CApUtils Setxxx functions)

#include <apselect.h>

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.


Public Member Functions
virtual IMPORT_C	~CApSelect ()
	Destructor.
IMPORT_C void	SetFiltersL (TInt aIspFilter, TInt aBearerFilter, TInt aSortType)
	Sets filters and sorting order for the list of available access points.
IMPORT_C TInt	IspTypeFilter ()
	Gets the current ISP-type filter.
IMPORT_C TInt	BearerFilter ()
	Gets the current bearer-type filter.
IMPORT_C TInt	SortOrder ()
	Gets the current sorting order.
IMPORT_C TBool	MoveToFirst ()
	Navigates to the first access point in the list.
IMPORT_C TBool	MoveNext ()
	Navigates to the next access point in the list.
IMPORT_C TBool	MoveLast ()
	Navigates to the last access point in the list.
IMPORT_C TBool	MovePrev ()
	Navigates to the previous access point in the list.
IMPORT_C TUint32	Count ()
	Counts the items in the list.
IMPORT_C const TDesC &	Name ()
	Gets the name of the 'current' access point Ownership of the returned text is not passed.
IMPORT_C TUint32	Uid ()
	Gets the UID of the current access point.
IMPORT_C TCommsDbIspType	Type ()
	Gets the ISP-type of the current access point.
IMPORT_C TApBearerType	BearerType ()
	Gets the bearer-type of the current access point.
IMPORT_C TInt	AllListItemDataL (CApListItemList &aList)
	Provides all data in a CApListItemList array.
IMPORT_C TBool	IsReadOnly () const
	Returns whether the current item is read-only or not.
Static Public Member Functions
static IMPORT_C CApSelect *	NewLC (CCommsDatabase &aDb, TInt aIspFilter, TInt aBearerFilter, TInt aSortType)
	Two-phased constructor.
static IMPORT_C CApSelect *	NewLC (CCommsDatabase &aDb, TInt aIspFilter, TInt aBearerFilter, TInt aSortType, TInt aReqIpvType)
	Two-phased constructor.
static IMPORT_C CApSelect *	NewLC (CCommsDatabase &aDb, TInt aIspFilter, TInt aBearerFilter, TInt aSortType, TInt aReqIpvType, TVpnFilterType aVpnFilterType)
	Two-phased constructor.
static IMPORT_C CApSelect *	NewLC (CCommsDatabase &aDb, TInt aIspFilter, TInt aBearerFilter, TInt aSortType, TInt aReqIpvType, TVpnFilterType aVpnFilterType, TBool aIncludeEasyWlan)
	Two-phased constructor.
Protected Member Functions
IMPORT_C	CApSelect ()
	C++ default constructor.
IMPORT_C void	ConstructL (CCommsDatabase &aDb, TInt aIspFilter, TInt aBearerFilter, TInt aSortType)
	Second-phase constructor.
IMPORT_C void	ConstructL (CCommsDatabase &aDb, TInt aIspFilter, TInt aBearerFilter, TInt aSortType, TInt aReqIpvType)
	Second-phase constructor.
IMPORT_C void	ConstructL (CCommsDatabase &aDb, TInt aIspFilter, TInt aBearerFilter, TInt aSortType, TInt aReqIpvType, TVpnFilterType aVpnFilterType)
	Second-phase constructor.
IMPORT_C void	ConstructL (CCommsDatabase &aDb, TInt aIspFilter, TInt aBearerFilter, TInt aSortType, TInt aReqIpvType, TVpnFilterType aVpnFilterType, TBool aIncludeEasyWlan)
	Second-phase constructor.

Constructor & Destructor Documentation

virtual IMPORT_C CApSelect::~CApSelect ( ) [virtual]

Destructor.

Deprecated:

IMPORT_C CApSelect::CApSelect ( ) [protected]

C++ default constructor.

Deprecated:

Member Function Documentation

IMPORT_C TInt CApSelect::AllListItemDataL

Provides all data in a CApListItemList array.

Parameters:

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.

Deprecated:

IMPORT_C TInt CApSelect::BearerFilter

(

)

Gets the current bearer-type filter.

Returns:: The current bearer-type filter

Deprecated:

IMPORT_C TApBearerType CApSelect::BearerType

(

)

Gets the bearer-type of the current access point.

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

Deprecated:

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

Second-phase constructor.

Parameters:

	aDb	a pointer to a CCommsDataBase.
	aIspTypeFilter	Filtering criteria on ISP type Possible values are: KEApIspTypeInternetOnly, KEApIspTypeWAPOnly, KEApIspTypeInternetAndWAP, KEApIspTypeWAPMandatory KEApIspTypeAll and their combinations.
	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...

Deprecated:

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

Second-phase constructor.

Parameters:

	aDb	a pointer to a CCommsDataBase.
	aIspTypeFilter	Filtering criteria on ISP type Possible values are: KEApIspTypeInternetOnly, KEApIspTypeWAPOnly, KEApIspTypeInternetAndWAP, KEApIspTypeWAPMandatory KEApIspTypeAll and their combinations.
	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.

Deprecated:

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

Second-phase constructor.

Parameters:

	aDb	a pointer to a CCommsDataBase.
	aIspTypeFilter	Filtering criteria on ISP type Possible values are: KEApIspTypeInternetOnly, KEApIspTypeWAPOnly, KEApIspTypeInternetAndWAP, KEApIspTypeWAPMandatory KEApIspTypeAll and their combinations.
	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)

Deprecated:

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

Second-phase constructor.

Parameters:

	aDb	a pointer to a CCommsDataBase.
	aIspTypeFilter	Filtering criteria on ISP type Possible values are: KEApIspTypeInternetOnly, KEApIspTypeWAPOnly, KEApIspTypeInternetAndWAP, KEApIspTypeWAPMandatory KEApIspTypeAll and their combinations.
	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

Deprecated:

IMPORT_C TUint32 CApSelect::Count

(

)

Counts the items in the list.

Returns:: The number of items in the list.

Deprecated:

IMPORT_C TInt CApSelect::IspTypeFilter

(

)

Gets the current ISP-type filter.

Returns:: The current ISP-type filter

Deprecated:

IMPORT_C TBool CApSelect::IsReadOnly

(

)

const

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

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

Deprecated:

IMPORT_C TBool CApSelect::MoveLast

(

)

Navigates to the last access point in the list.

Returns:: Boolean indicating the success of the operation.

Deprecated:

IMPORT_C TBool CApSelect::MoveNext

(

)

Navigates to the next access point in the list.

Returns:: Boolean indicating the success of the operation.

Deprecated:

IMPORT_C TBool CApSelect::MovePrev

(

)

Navigates to the previous access point in the list.

Returns:: Boolean indicating the success of the operation.

Deprecated:

IMPORT_C TBool CApSelect::MoveToFirst

(

)

Navigates to the first access point in the list.

Returns:: Boolean indicating the success of the operation.

Deprecated:

IMPORT_C const TDesC& CApSelect::Name

(

)

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

Returns:: The name of the current access point

Deprecated:

static IMPORT_C CApSelect* 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.

Parameters:

	aDb	a pointer to a CCommsDataBase.
	aIspTypeFilter	Filtering criteria on ISP type Possible values are: KEApIspTypeInternetOnly, KEApIspTypeWAPOnly, KEApIspTypeInternetAndWAP, KEApIspTypeWAPMandatory KEApIspTypeAll and their combinations.
	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.

Deprecated:

static IMPORT_C CApSelect* 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.

Parameters:

	aDb	a pointer to a CCommsDataBase.
	aIspTypeFilter	Filtering criteria on ISP type Possible values are: KEApIspTypeInternetOnly, KEApIspTypeWAPOnly, KEApIspTypeInternetAndWAP, KEApIspTypeWAPMandatory KEApIspTypeAll and their combinations.
	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.

Deprecated:

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

Two-phased constructor.

Leaves on failure, places instance on cleanup stack.

Parameters:

	aDb	a pointer to a CCommsDataBase.
	aIspTypeFilter	Filtering criteria on ISP type Possible values are: KEApIspTypeInternetOnly, KEApIspTypeWAPOnly, KEApIspTypeInternetAndWAP, KEApIspTypeWAPMandatory KEApIspTypeAll and their combinations.
	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.

Deprecated:

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

Two-phased constructor.

Leaves on failure, places instance on cleanup stack.

Parameters:

	aDb	a pointer to a CCommsDataBase.
	aIspTypeFilter	Filtering criteria on ISP type Possible values are: KEApIspTypeInternetOnly, KEApIspTypeWAPOnly, KEApIspTypeInternetAndWAP, KEApIspTypeWAPMandatory KEApIspTypeAll and their combinations.
	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.

Deprecated:

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

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

Parameters:

	aIspTypeFilter	Filtering criteria on ISP type Possible values are: KEApIspTypeInternetOnly, KEApIspTypeWAPOnly, KEApIspTypeInternetAndWAP, KEApIspTypeWAPMandatory, KEApIspTypeAll and their combinations.
	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