CApSettingsHandler Class Reference

#include <mw/ApSettingsHandlerUI.h>

Link against: ApSettingsHandlerUI.lib

class CApSettingsHandler : public CBase

Inherits from

CApSettingsHandler

Public Member Functions
	~CApSettingsHandler()
IMPORT_C TInt	Cvt()
IMPORT_C CApSettingsHandler *	NewLC(TBool, TSelectionListType, TSelectionMenuType, TInt, TInt, TInt)
IMPORT_C CApSettingsHandler *	NewLC(CActiveApDb &, TBool, TSelectionListType, TSelectionMenuType, TInt, TInt, TInt)
IMPORT_C CApSettingsHandler *	NewLC(TBool, TSelectionListType, TSelectionMenuType, TInt, TInt, TInt, TInt)
IMPORT_C CApSettingsHandler *	NewLC(CActiveApDb &, TBool, TSelectionListType, TSelectionMenuType, TInt, TInt, TInt, TInt)
IMPORT_C CApSettingsHandler *	NewLC(TBool, TSelectionListType, TSelectionMenuType, TInt, TInt, TInt, TInt, TVpnFilterType)
IMPORT_C CApSettingsHandler *	NewLC(CActiveApDb &, TBool, TSelectionListType, TSelectionMenuType, TInt, TInt, TInt, TInt, TVpnFilterType)
IMPORT_C CApSettingsHandler *	NewLC(CActiveApDb &, TBool, TSelectionListType, TSelectionMenuType, TInt, TInt, TInt, TInt, TVpnFilterType, TBool)
IMPORT_C TInt	RunSettingsL(TUint32, TUint32 &)
IMPORT_C void	SetFilterL(TInt, TInt, TInt)
IMPORT_C void	SetTextOverrideL(TTextID, const TDesC &)
IMPORT_C const TDesC &	TextOverrideL(TTextID)

Protected Member Functions
	CApSettingsHandler(TBool, TSelectionListType, TSelectionMenuType)
	CApSettingsHandler(TBool, TSelectionListType, TSelectionMenuType, TUid)
	CApSettingsHandler(TBool, TSelectionListType, TSelectionMenuType, TBool)
TInt	ConfirmDeleteL(TUint32, TBool)
IMPORT_C void	ConstructL(TInt, TInt, TInt)
IMPORT_C void	ConstructL(CActiveApDb &, TInt, TInt, TInt)
IMPORT_C void	ConstructL(TInt, TInt, TInt, TVpnFilterType)
IMPORT_C void	ConstructL(CActiveApDb &, TInt, TInt, TInt, TVpnFilterType)
IMPORT_C void	ConstructL(CActiveApDb &, TInt, TInt, TInt, TVpnFilterType, TBool)
void	DoConstructL(CActiveApDb *, TInt, TInt, TInt, TVpnFilterType, TBool)
TUint32	DoHandleApBlankNewL(TInt, TInt)
TUint32	DoHandleApUseOldNewL(TUint32)
void	DoRunListSettingsL(TUint32, TUint32 &)
void	DoRunSetPageSettingsL(TUint32, TUint32 &)
TInt	DoRunSettingsL(TUint32, TUint32 &)
TInt	DoRunViewerL(TUint32)
TUint32	EditAfterCreateL(TUint32, CApAccessPointItem *)
TInt	GetVariantL()
TUint32	HandleApBlankNewL(TInt, TInt)
void	HandleApDeleteCmdL(TUint32, TBool)
TUint32	HandleApUseOldNewL()
void	HandleNetworkDeleteCmdL(TUint32)
void	HandleRunSettingsL(TUint32, TUint32 &)
IMPORT_C TInt	RunViewerL(TUint32)
TUint32	SelectApToCopyL()

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

CApSettingsHandler class: It is the main handler for the Access Point settings. It contains the only public API for other (sub)systems.

Constructor & Destructor Documentation

CApSettingsHandler ( TBool, TSelectionListType, TSelectionMenuType )

IMPORT_C	CApSettingsHandler	(	TBool	aStartWithSelection,
			TSelectionListType	aListType,
			TSelectionMenuType	aSelMenuType
		)	[protected]

Constructor. Deprecated

Parameter	Description
aStartWithSelection	A boolean value indicating whether to select or edit an ap.
aListType	A TSelectionListType enum indicating the desired list type.
aSelMenuType	A TSelectionMenuType enum indicating the desired menu type.

CApSettingsHandler ( TBool, TSelectionListType, TSelectionMenuType, TUid )

IMPORT_C	CApSettingsHandler	(	TBool	aStartWithSelection,
			TSelectionListType	aListType,
			TSelectionMenuType	aSelMenuType,
			TUid	aHelpMajor
		)	[protected]

Constructor. Deprecated

Parameter	Description
aStartWithSelection	A boolean value indicating whether to select or edit an ap.
aListType	A TSelectionListType enum indicating the desired list type.
aSelMenuType	A TSelectionMenuType enum indicating the desired menu type.
aHelpMajor	Major help ID

CApSettingsHandler ( TBool, TSelectionListType, TSelectionMenuType, TBool )

CApSettingsHandler	(	TBool	aStartWithSelection,
		TSelectionListType	aListType,
		TSelectionMenuType	aSelMenuType,
		TBool	aNeedIpv6Support
	)	[protected]

Constructor.

Parameter	Description
aStartWithSelection	A boolean value indicating whether to select or edit an ap.
aListType	A TSelectionListType enum indicating the desired list type.
aSelMenuType	A TSelectionMenuType enum indicating the desired menu type.
aNeedIpv6Support	Whether IPv6 is supported or not

~CApSettingsHandler ( )

IMPORT_C

~CApSettingsHandler

(

)

Destructor.

Deprecated

Member Function Documentation

ConfirmDeleteL ( TUint32, TBool )

TInt	ConfirmDeleteL	(	TUint32	aUid,
			TBool	aIsLast
		)	[protected]

Gets confirmation about deleting an access point

Parameter	Description
aUid	A TUint32 holding the WAP access point ID of the access point to be deleted.
aIsLast	A TBool specifying whether the access point to be deleted is the last one or not.

Returns: A TInt stating the result

ConstructL ( TInt, TInt, TInt )

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

Second-phase constructor. Deprecated

Parameter	Description
aBearerFilter	Filtering criteria on bearer type
aSortType	Specifies the sort order to use.

ConstructL ( CActiveApDb &, TInt, TInt, TInt )

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

Second-phase constructor. Deprecated

Parameter	Description
aDb	A database to work on
aBearerFilter	Filtering criteria on bearer type
aSortType	Specifies the sort order to use.

ConstructL ( TInt, TInt, TInt, TVpnFilterType )

IMPORT_C void	ConstructL	(	TInt	aIspFilter,
			TInt	aBearerFilter,
			TInt	aSortType,
			TVpnFilterType	aVpnFilterType
		)	[protected]

Second-phase constructor. Deprecated

Parameter	Description
aBearerFilter	Filtering criteria on bearer type
aSortType	Specifies the sort order to use.
aVpnFilterType	a TVpnFilterType representing the possible additional VPN filtering.

ConstructL ( CActiveApDb &, TInt, TInt, TInt, TVpnFilterType )

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

Second-phase constructor. Deprecated

Parameter	Description
aDb	A database to work on
aBearerFilter	Filtering criteria on bearer type
aSortType	Specifies the sort order to use.
aVpnFilterType	a TVpnFilterType representing the possible additional VPN filtering.

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

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

Second-phase constructor. Deprecated

Parameter	Description
aDb	A database to work on
aBearerFilter	Filtering criteria on bearer type
aSortType	Specifies the sort order to use.
aVpnFilterType	a TVpnFilterType representing the possible additional VPN filtering.
aIncludeEasyWlan	a TBool indicating whether it should include the easy wlan AP in the list or not.

Cvt ( )

IMPORT_C TInt

Cvt

(

)

[static]

Component Validation Test. Deprecated

Returns: KErrNone.

DoConstructL ( CActiveApDb *, TInt, TInt, TInt, TVpnFilterType, TBool )

void	DoConstructL	(	CActiveApDb *	aDb,
			TInt	aIspFilter,
			TInt	aBearerFilter,
			TInt	aSortType,
			TVpnFilterType	aVpnFilterType,
			TBool	aIncludeEasyWlan
		)	[protected]

Second-phase internal constructor.

Parameter	Description
aDb	A database to work on
aBearerFilter	Filtering criteria on bearer type
aSortType	Specifies the sort order to use.
aVpnFilterType	a TVpnFilterType representing the possible additional VPN filtering.
aIncludeEasyWlan	a TBool indicating whether it should include the easy wlan AP in the list or not.

DoHandleApBlankNewL ( TInt, TInt )

TUint32	DoHandleApBlankNewL	(	TInt	aBearers,
			TInt	aIsps
		)	[protected]

handles the Create blank new access Point command.

DoHandleApUseOldNewL ( TUint32 )

TUint32

DoHandleApUseOldNewL

(

TUint32

aSelected

)

[protected]

handles the Create new access Point by using existing one command. Called after user has selected the AP to copy Creates the new Ap and offers it for editing.

Parameter	Description
aSelected	The UID of the AP to copy. Shall not be KErrNone.

Returns: The UID of the newly created Ap

DoRunListSettingsL ( TUint32, TUint32 & )

void	DoRunListSettingsL	(	TUint32	aHighLight,
			TUint32 &	aSelected
		)	[protected]

Starts the selector component as a list Creates dialog(s) from scratch, launches and executes them. In case of error, leaves with error codes.

DoRunSetPageSettingsL ( TUint32, TUint32 & )

void	DoRunSetPageSettingsL	(	TUint32	aHighLight,
			TUint32 &	aSelected
		)	[protected]

Starts the selector component in a setting page Creates dialog(s) from scratch, launches and executes them. In case of error, leaves with error codes.

DoRunSettingsL ( TUint32, TUint32 & )

TInt	DoRunSettingsL	(	TUint32	aHighLight,
			TUint32 &	aSelected
		)	[protected]

Starts the settings component. Creates dialog(s) from scratch, launches and executes them. In case of error, leaves with error codes.

DoRunViewerL ( TUint32 )

TInt

DoRunViewerL

(

TUint32

aUid

)

[protected]

Starts the viewer component. Creates dialog(s) from scratch, launches and executes it. In case of error, leaves with error codes.

EditAfterCreateL ( TUint32, CApAccessPointItem * )

TUint32	EditAfterCreateL	(	TUint32	aUid,
			CApAccessPointItem *	aItem = NULL
		)	[protected]

GetVariantL ( )

TInt

GetVariantL

(

)

[protected]

Gets the local variant value

Returns: A TInt stating the variant

HandleApBlankNewL ( TInt, TInt )

TUint32	HandleApBlankNewL	(	TInt	aBearers,
			TInt	aIsps
		)	[protected]

HandleApDeleteCmdL ( TUint32, TBool )

void	HandleApDeleteCmdL	(	TUint32	aUid,
			TBool	aIsLast
		)	[protected]

HandleApUseOldNewL ( )

TUint32

HandleApUseOldNewL

(

)

[protected]

HandleNetworkDeleteCmdL ( TUint32 )

void

HandleNetworkDeleteCmdL

(

TUint32

aUid

)

[protected]

handles the Delete network group command.

Parameter	Description
aUid	The uid of the network to delete

HandleRunSettingsL ( TUint32, TUint32 & )

void	HandleRunSettingsL	(	TUint32	aHighLight,
			TUint32 &	aSelected
		)	[protected]

Wrapper for the public API

NewLC ( TBool, TSelectionListType, TSelectionMenuType, TInt, TInt, TInt )

IMPORT_C CApSettingsHandler *	NewLC	(	TBool	aStartWithSelection,
			TSelectionListType	aListType,
			TSelectionMenuType	aSelMenuType,
			TInt	aIspFilter,
			TInt	aBearerFilter,
			TInt	aSortType
		)	[static]

Two-phased constructor. Leaves on failure. This function shall be used to create the access point settings/selection handling UI object. It is customizable through the parameters. This object is a small layer above the UI part and it provides a standard interface to select, edit, create access points. It has two main parts, Select and Edit. The first parameter, aStartWithSelection gives whether we would like to select or edit. In case of selection, there is the possibility to use this module in many applications. For this, two layouts are implemented, one is list pane used by General Settings which provides the list in a list-pane. The other layout is for the other applications requiring access point selection, a popup-list style as the decision I know about was that General Settings will use list-pane and all other apps. popup-list style. It is the caller who selects the style so if spec. says otherwise, this module still can be used. It is also possible to start the UI without selection, so if any module has a 'linked/default/etc.' access point and stored it's UID, the module can simply call the editor part of the UI without having to select the AP once more. In case of editing only, (aStartWithSelection is EFalse), all other construction parameters are ignored and after construction caller can simply call RunSettingsL(..). In case of selection, a lot of other parameters can be specified to fulfil all requirements. There are three types of Options menu available: EApSettingsSelMenuNormal, EApSettingsSelMenuSelectOnly, EApSettingsSelMenuSelectNormal. -EApSettingsSelMenuSelectOnly: Only Select is visible, no way to edit, delete, create, etc. -EApSettingsSelMenuNormal: Options menu specified in General Settings, contains Edit, Delete, Create new, etc. menu items. -EApSettingsSelMenuSelectNormal: Same as in EApSettingsSelMenuNormal BUT the first item is Select. This one makes it possible to select an access point and also possible to edit, create, delete, etc. The following three parameters specify the filtering and ordering criteria for the selection list creation. First, it is possible to specify which ISP-type we are looking for. The possible values are: KEApIspTypeInternetOnly: Filter allows only access points that are capable of only internet access. KEApIspTypeWAPOnly: Filter allows only access points that are capable of only WAP access. KEApIspTypeInternetAndWAP: Filter allows only access points that are capable of internet AND WAP access. KEApIspTypeWAPMandatory: Filter allows only access points that are capable of WAP access AND contain mandatory WAP settings. KEApIspTypeAll: No filtering is done for the isp-type, all types of access points are shown. It is possible to combine them by simply adding/or-ing together the values, filtering will be done in such a way that only access points with the listed ISP-types will be shown. Second filtering possibility (aBearerFilter) is the desired bearer type. The possible values are the values of the TApBearerType enum type and their combinations, as in case of the ISP type. The ordering of the list can be specified with the aSortType parameter. It can have the following values: KEApSortUidAscending: The sorting is done according to the ID of the access points in ascending order. KEApSortUidDescending: The sorting is done according to the ID of the access points in descending order. KEApSortNameAscending: The sorting is done according to the name of the access points in ascending order. KEApSortNameDescending: The sorting is done according to the name of the access points in descending order. Caution! The ordering values can not be combined! Deprecated

Parameter	Description
aStartWithSelection	A boolean value indicating whether to select or edit an ap.
aListType	A TSelectionListType enum indicating the desired list type.
aSelMenuType	A TSelectionMenuType enum indicating the desired menu type.
aBearerFilter	Filtering criteria on bearer type
aSortType	Specifies the sort order to use.

Returns: The constructed CApSettingsHandler object.

NewLC ( CActiveApDb &, TBool, TSelectionListType, TSelectionMenuType, TInt, TInt, TInt )

IMPORT_C CApSettingsHandler *	NewLC	(	CActiveApDb &	aDb,
			TBool	aStartWithSelection,
			TSelectionListType	aListType,
			TSelectionMenuType	aSelMenuType,
			TInt	aIspFilter,
			TInt	aBearerFilter,
			TInt	aSortType
		)	[static]

Parameter	Description
aDb	A database to work on
aStartWithSelection	A boolean value indicating whether to select or edit an ap.
aListType	A TSelectionListType enum indicating the desired list type.
aSelMenuType	A TSelectionMenuType enum indicating the desired menu type.
aBearerFilter	Filtering criteria on bearer type
aSortType	Specifies the sort order to use.

Returns: The constructed CApSettingsHandler object.

NewLC ( TBool, TSelectionListType, TSelectionMenuType, TInt, TInt, TInt, TInt )

IMPORT_C CApSettingsHandler *	NewLC	(	TBool	aStartWithSelection,
			TSelectionListType	aListType,
			TSelectionMenuType	aSelMenuType,
			TInt	aIspFilter,
			TInt	aBearerFilter,
			TInt	aSortType,
			TInt	aReqIpvType
		)	[static]

Two-phased constructor. Leaves on failure. This function shall be used to create the access point settings/selection handling UI object.It is customizable through the parameters. This object is a small layer above the UI part and it provides a standard interface to select, edit, create access points. It has two main parts, Select and Edit. The first parameter, aStartWithSelection gives whether we would like to select or edit. In case of selection, there is the possibility to use this module in many applications. For this, two layouts are implemented, one is list pane used by General Settings which provides the list in a list-pane. The other layout is for the other applications requiring access point selection, a popup-list style as the decision was that General Settings will use list-pane and all other apps. popup-list style. It is the caller who selects the style so if spec. says otherwise, this module still can be used. It is also possible to start the UI without selection, so if any module has a 'linked/default/etc.' access point and stored it's UID, the module can simply call the editor part of the UI without having to select the AP once more. In case of editing only, (aStartWithSelection is EFalse), all other construction parameters are ignored and after construction caller can simply call RunSettingsL(..). In case of selection, a lot of other parameters can be specified to fulfil all requirements. There are three types of Options menu available: EApSettingsSelMenuNormal, EApSettingsSelMenuSelectOnly, EApSettingsSelMenuSelectNormal. -EApSettingsSelMenuSelectOnly: Only Select is visible, no way to edit, delete, create, etc. -EApSettingsSelMenuNormal:Options menu specified in General Settings, contains Edit, Delete, Create new, etc. menu items. -EApSettingsSelMenuSelectNormal: Same as in EApSettingsSelMenuNormal BUT the first item is Select. This one makes it possible to select an access point and also possible to edit, create, delete, etc. The following three parameters specify the filtering and ordering criteria for the selection list creation. First, it is possible to specify which ISP-type we are looking for. The possible values are: KEApIspTypeInternetOnly: Filter allows only access points that are capable of only internet access. KEApIspTypeWAPOnly: Filter allows only access points that are capable of only WAP access. KEApIspTypeInternetAndWAP: Filter allows only access points that are capable of internet AND WAP access. KEApIspTypeWAPMandatory: Filter allows only access points that are capable of WAP access AND contain mandatory WAP settings. KEApIspTypeAll: No filtering is done for the isp-type, all types of access points are shown. It is possible to combine them by simply adding/or-ing together the values, filtering will be done in such a way that only access points with the listed ISP-types will be shown. Second filtering possibility (aBearerFilter) is the desired bearer type. The possible values are the values of the TApBearerType enum type and their combinations, as in case of the ISP type. The ordering of the list can be specified with the aSortType parameter. It can have the following values: KEApSortUidAscending: The sorting is done according to the ID of the access points in ascending order. KEApSortUidDescending: The sorting is done according to the ID of the access points in descending order. KEApSortNameAscending: The sorting is done according to the name of the access points in ascending order. KEApSortNameDescending: The sorting is done according to the name of the access points in descending order. Caution! The ordering values can not be combined! Deprecated

Parameter	Description
aStartWithSelection	A boolean value indicating whether to select or edit an ap.
aListType	A TSelectionListType enum indicating the desired list type.
aSelMenuType	A TSelectionMenuType enum indicating the desired menu type.
aBearerFilter	Filtering criteria on bearer type
aSortType	Specifies the sort order to use.
aReqIpvType	Specifies whether the caller would like to have IPv4, IPv6 or both access points. If it is IPv6 or Both, in case of IPv6 support is available as a feature, it will be supported. If IPv6 feature is not supported by the phone, it simply defaults to the normal IPv4 version. If it is IPv4, it uses the default IPv4 version independently from IPv6 feature beeing available or not.

Returns: The constructed CApSettingsHandler object.

NewLC ( CActiveApDb &, TBool, TSelectionListType, TSelectionMenuType, TInt, TInt, TInt, TInt )

IMPORT_C CApSettingsHandler *	NewLC	(	CActiveApDb &	aDb,
			TBool	aStartWithSelection,
			TSelectionListType	aListType,
			TSelectionMenuType	aSelMenuType,
			TInt	aIspFilter,
			TInt	aBearerFilter,
			TInt	aSortType,
			TInt	aReqIpvType
		)	[static]

Two-phased constructor. Leaves on failure. This function shall be used to create the access point settings/selection handling UI object. It is customizable through the parameters. This object is a small layer above the UI part and it provides a standard interface to select, edit, create access points. It has two main parts, Select and Edit. The first parameter, aStartWithSelection gives whether we would like to select or edit. In case of selection, there is the possibility to use this module in many applications. For this, two layouts are implemented, one is list pane used by General Settings which provides the list in a list-pane. The other layout is for the other applications requiring access point selection, a popup-list style as the decision was that General Settings will use list-pane and all other apps. popup-list style. It is the caller who selects the style so if spec. says otherwise, this module still can be used. It is also possible to start the UI without selection, so if any module has a 'linked/default/etc.' access point and stored it's UID, the module can simply call the editor part of the UI without having to select the AP once more. In case of editing only, (aStartWithSelection is EFalse), all other construction parameters are ignored and after construction caller can simply call RunSettingsL(..). In case of selection, a lot of other parameters can be specified to fulfil all requirements. There are three types of Options menu available: EApSettingsSelMenuNormal, EApSettingsSelMenuSelectOnly, EApSettingsSelMenuSelectNormal. -EApSettingsSelMenuSelectOnly: Only Select is visible, no way to edit, delete, create, etc. -EApSettingsSelMenuNormal:Options menu specified in General Settings, contains Edit, Delete, Create new, etc. menu items. -EApSettingsSelMenuSelectNormal: Same as in EApSettingsSelMenuNormal BUT the first item is Select. This one makes it possible to select an access point and also possible to edit, create, delete, etc. The following three parameters specify the filtering and ordering criteria for the selection list creation. First, it is possible to specify which ISP-type we are looking for. The possible values are: KEApIspTypeInternetOnly: Filter allows only access points that are capable of only internet access. KEApIspTypeWAPOnly: Filter allows only access points that are capable of only WAP access. KEApIspTypeInternetAndWAP: Filter allows only access points that are capable of internet AND WAP access. KEApIspTypeWAPMandatory: Filter allows only access points that are capable of WAP access AND contain mandatory WAP settings. KEApIspTypeAll: No filtering is done for the isp-type, all types of access points are shown. It is possible to combine them by simply adding/or-ing together the values, filtering will be done in such a way that only access points with the listed ISP-types will be shown. Second filtering possibility (aBearerFilter) is the desired bearer type. The possible values are the values of the TApBearerType enum type and their combinations, as in case of the ISP type. The ordering of the list can be specified with the aSortType parameter. It can have the following values: KEApSortUidAscending: The sorting is done according to the ID of the access points in ascending order. KEApSortUidDescending: The sorting is done according to the ID of the access points in descending order. KEApSortNameAscending: The sorting is done according to the name of the access points in ascending order. KEApSortNameDescending: The sorting is done according to the name of the access points in descending order. Caution! The ordering values can not be combined! Deprecated

Parameter	Description
aDb	A database to work on
aStartWithSelection	A boolean value indicating whether to select or edit an ap.
aListType	A TSelectionListType enum indicating the desired list type.
aSelMenuType	A TSelectionMenuType enum indicating the desired menu type.
aBearerFilter	Filtering criteria on bearer type
aSortType	Specifies the sort order to use.
aReqIpvType	Specifies whether the caller would like to have IPv4, IPv6 or both access points. If it is IPv6 or Both, in case of IPv6 support is available as a feature, it will be supported. If IPv6 feature is not supported by the phone, it simply defaults to the normal IPv4 version. If it is IPv4, it uses the default IPv4 version independently from IPv6 feature beeing available or not.

Returns: The constructed CApSettingsHandler object.

NewLC ( TBool, TSelectionListType, TSelectionMenuType, TInt, TInt, TInt, TInt, TVpnFilterType )

IMPORT_C CApSettingsHandler *	NewLC	(	TBool	aStartWithSelection,
			TSelectionListType	aListType,
			TSelectionMenuType	aSelMenuType,
			TInt	aIspFilter,
			TInt	aBearerFilter,
			TInt	aSortType,
			TInt	aReqIpvType,
			TVpnFilterType	aVpnFilterType
		)	[static]

Two-phased constructor. Leaves on failure. This function shall be used to create the access point settings/selection handling UI object.It is customizable through the parameters. This object is a small layer above the UI part and it provides a standard interface to select, edit, create access points. It has two main parts, Select and Edit. The first parameter, aStartWithSelection gives whether we would like to select or edit. In case of selection, there is the possibility to use this module in many applications. For this, two layouts are implemented, one is list pane used by General Settings which provides the list in a list-pane. The other layout is for the other applications requiring access point selection, a popup-list style as the decision was that General Settings will use list-pane and all other apps. popup-list style. It is the caller who selects the style so if spec. says otherwise, this module still can be used. It is also possible to start the UI without selection, so if any module has a 'linked/default/etc.' access point and stored it's UID, the module can simply call the editor part of the UI without having to select the AP once more. In case of editing only, (aStartWithSelection is EFalse), all other construction parameters are ignored and after construction caller can simply call RunSettingsL(..). In case of selection, a lot of other parameters can be specified to fulfil all requirements. There are three types of Options menu available: EApSettingsSelMenuNormal, EApSettingsSelMenuSelectOnly, EApSettingsSelMenuSelectNormal. -EApSettingsSelMenuSelectOnly: Only Select is visible, no way to edit, delete, create, etc. -EApSettingsSelMenuNormal:Options menu specified in General Settings, contains Edit, Delete, Create new, etc. menu items. -EApSettingsSelMenuSelectNormal: Same as in EApSettingsSelMenuNormal BUT the first item is Select. This one makes it possible to select an access point and also possible to edit, create, delete, etc. The following three parameters specify the filtering and ordering criteria for the selection list creation. First, it is possible to specify which ISP-type we are looking for. The possible values are: KEApIspTypeInternetOnly: Filter allows only access points that are capable of only internet access. KEApIspTypeWAPOnly: Filter allows only access points that are capable of only WAP access. KEApIspTypeInternetAndWAP: Filter allows only access points that are capable of internet AND WAP access. KEApIspTypeWAPMandatory: Filter allows only access points that are capable of WAP access AND contain mandatory WAP settings. KEApIspTypeAll: No filtering is done for the isp-type, all types of access points are shown. It is possible to combine them by simply adding/or-ing together the values, filtering will be done in such a way that only access points with the listed ISP-types will be shown. Second filtering possibility (aBearerFilter) is the desired bearer type. The possible values are the values of the TApBearerType enum type and their combinations, as in case of the ISP type. The ordering of the list can be specified with the aSortType parameter. It can have the following values: KEApSortUidAscending: The sorting is done according to the ID of the access points in ascending order. KEApSortUidDescending: The sorting is done according to the ID of the access points in descending order. KEApSortNameAscending: The sorting is done according to the name of the access points in ascending order. KEApSortNameDescending: The sorting is done according to the name of the access points in descending order. Caution! The ordering values can not be combined! Deprecated

Parameter	Description
aStartWithSelection	A boolean value indicating whether to select or edit an ap.
aListType	A TSelectionListType enum indicating the desired list type.
aSelMenuType	A TSelectionMenuType enum indicating the desired menu type.
aBearerFilter	Filtering criteria on bearer type
aSortType	Specifies the sort order to use.
aReqIpvType	Specifies whether the caller would like to have IPv4, IPv6 or both access points. If it is IPv6 or Both, in case of IPv6 support is available as a feature, it will be supported. If IPv6 feature is not supported by the phone, it simply defaults to the normal IPv4 version. If it is IPv4, it uses the default IPv4 version independently from IPv6 feature beeing available or not.
aVpnFilterType	a TVpnFilterType representing the possible additional VPN filtering.

Returns: The constructed CApSettingsHandler object.

NewLC ( CActiveApDb &, TBool, TSelectionListType, TSelectionMenuType, TInt, TInt, TInt, TInt, TVpnFilterType )

IMPORT_C CApSettingsHandler *	NewLC	(	CActiveApDb &	aDb,
			TBool	aStartWithSelection,
			TSelectionListType	aListType,
			TSelectionMenuType	aSelMenuType,
			TInt	aIspFilter,
			TInt	aBearerFilter,
			TInt	aSortType,
			TInt	aReqIpvType,
			TVpnFilterType	aVpnFilterType
		)	[static]

Two-phased constructor. Leaves on failure. This function shall be used to create the access point settings/selection handling UI object. It is customizable through the parameters. This object is a small layer above the UI part and it provides a standard interface to select, edit, create access points. It has two main parts, Select and Edit. The first parameter, aStartWithSelection gives whether we would like to select or edit. In case of selection, there is the possibility to use this module in many applications. For this, two layouts are implemented, one is list pane used by General Settings which provides the list in a list-pane. The other layout is for the other applications requiring access point selection, a popup-list style as the decision was that General Settings will use list-pane and all other apps. popup-list style. It is the caller who selects the style so if spec. says otherwise, this module still can be used. It is also possible to start the UI without selection, so if any module has a 'linked/default/etc.' access point and stored it's UID, the module can simply call the editor part of the UI without having to select the AP once more. In case of editing only, (aStartWithSelection is EFalse), all other construction parameters are ignored and after construction caller can simply call RunSettingsL(..). In case of selection, a lot of other parameters can be specified to fulfil all requirements. There are three types of Options menu available: EApSettingsSelMenuNormal, EApSettingsSelMenuSelectOnly, EApSettingsSelMenuSelectNormal. -EApSettingsSelMenuSelectOnly: Only Select is visible, no way to edit, delete, create, etc. -EApSettingsSelMenuNormal:Options menu specified in General Settings, contains Edit, Delete, Create new, etc. menu items. -EApSettingsSelMenuSelectNormal: Same as in EApSettingsSelMenuNormal BUT the first item is Select. This one makes it possible to select an access point and also possible to edit, create, delete, etc. The following three parameters specify the filtering and ordering criteria for the selection list creation. First, it is possible to specify which ISP-type we are looking for. The possible values are: KEApIspTypeInternetOnly: Filter allows only access points that are capable of only internet access. KEApIspTypeWAPOnly: Filter allows only access points that are capable of only WAP access. KEApIspTypeInternetAndWAP: Filter allows only access points that are capable of internet AND WAP access. KEApIspTypeWAPMandatory: Filter allows only access points that are capable of WAP access AND contain mandatory WAP settings. KEApIspTypeAll: No filtering is done for the isp-type, all types of access points are shown. It is possible to combine them by simply adding/or-ing together the values, filtering will be done in such a way that only access points with the listed ISP-types will be shown. Second filtering possibility (aBearerFilter) is the desired bearer type. The possible values are the values of the TApBearerType enum type and their combinations, as in case of the ISP type. The ordering of the list can be specified with the aSortType parameter. It can have the following values: KEApSortUidAscending: The sorting is done according to the ID of the access points in ascending order. KEApSortUidDescending: The sorting is done according to the ID of the access points in descending order. KEApSortNameAscending: The sorting is done according to the name of the access points in ascending order. KEApSortNameDescending: The sorting is done according to the name of the access points in descending order. Caution! The ordering values can not be combined! Deprecated

Parameter	Description
aDb	A database to work on
aStartWithSelection	A boolean value indicating whether to select or edit an ap.
aListType	A TSelectionListType enum indicating the desired list type.
aSelMenuType	A TSelectionMenuType enum indicating the desired menu type.
aBearerFilter	Filtering criteria on bearer type
aSortType	Specifies the sort order to use.
aReqIpvType	Specifies whether the caller would like to have IPv4, IPv6 or both access points. If it is IPv6 or Both, in case of IPv6 support is available as a feature, it will be supported. If IPv6 feature is not supported by the phone, it simply defaults to the normal IPv4 version. If it is IPv4, it uses the default IPv4 version independently from IPv6 feature beeing available or not.
aVpnFilterType	a TVpnFilterType representing the possible additional VPN filtering.

Returns: The constructed CApSettingsHandler object.

NewLC ( CActiveApDb &, TBool, TSelectionListType, TSelectionMenuType, TInt, TInt, TInt, TInt, TVpnFilterType, TBool )

IMPORT_C CApSettingsHandler *	NewLC	(	CActiveApDb &	aDb,
			TBool	aStartWithSelection,
			TSelectionListType	aListType,
			TSelectionMenuType	aSelMenuType,
			TInt	aIspFilter,
			TInt	aBearerFilter,
			TInt	aSortType,
			TInt	aReqIpvType,
			TVpnFilterType	aVpnFilterType,
			TBool	aIncludeEasyWlan
		)	[static]

Two-phased constructor. Leaves on failure. This function shall be used to create the access point settings/selection handling UI object. It is customizable through the parameters. This object is a small layer above the UI part and it provides a standard interface to select, edit, create access points. It has two main parts, Select and Edit. The first parameter, aStartWithSelection gives whether we would like to select or edit. In case of selection, there is the possibility to use this module in many applications. For this, two layouts are implemented, one is list pane used by General Settings which provides the list in a list-pane. The other layout is for the other applications requiring access point selection, a popup-list style as the decision was that General Settings will use list-pane and all other apps. popup-list style. It is the caller who selects the style so if spec. says otherwise, this module still can be used. It is also possible to start the UI without selection, so if any module has a 'linked/default/etc.' access point and stored it's UID, the module can simply call the editor part of the UI without having to select the AP once more. In case of editing only, (aStartWithSelection is EFalse), all other construction parameters are ignored and after construction caller can simply call RunSettingsL(..). In case of selection, a lot of other parameters can be specified to fulfil all requirements. There are three types of Options menu available: EApSettingsSelMenuNormal, EApSettingsSelMenuSelectOnly, EApSettingsSelMenuSelectNormal. -EApSettingsSelMenuSelectOnly: Only Select is visible, no way to edit, delete, create, etc. -EApSettingsSelMenuNormal:Options menu specified in General Settings, contains Edit, Delete, Create new, etc. menu items. -EApSettingsSelMenuSelectNormal: Same as in EApSettingsSelMenuNormal BUT the first item is Select. This one makes it possible to select an access point and also possible to edit, create, delete, etc. The following three parameters specify the filtering and ordering criteria for the selection list creation. First, it is possible to specify which ISP-type we are looking for. The possible values are: KEApIspTypeInternetOnly: Filter allows only access points that are capable of only internet access. KEApIspTypeWAPOnly: Filter allows only access points that are capable of only WAP access. KEApIspTypeInternetAndWAP: Filter allows only access points that are capable of internet AND WAP access. KEApIspTypeWAPMandatory: Filter allows only access points that are capable of WAP access AND contain mandatory WAP settings. KEApIspTypeAll: No filtering is done for the isp-type, all types of access points are shown. It is possible to combine them by simply adding/or-ing together the values, filtering will be done in such a way that only access points with the listed ISP-types will be shown. Second filtering possibility (aBearerFilter) is the desired bearer type. The possible values are the values of the TApBearerType enum type and their combinations, as in case of the ISP type. The ordering of the list can be specified with the aSortType parameter. It can have the following values: KEApSortUidAscending: The sorting is done according to the ID of the access points in ascending order. KEApSortUidDescending: The sorting is done according to the ID of the access points in descending order. KEApSortNameAscending: The sorting is done according to the name of the access points in ascending order. KEApSortNameDescending: The sorting is done according to the name of the access points in descending order. Caution! The ordering values can not be combined! Deprecated

Parameter	Description
aDb	A database to work on
aStartWithSelection	A boolean value indicating whether to select or edit an ap.
aListType	A TSelectionListType enum indicating the desired list type.
aSelMenuType	A TSelectionMenuType enum indicating the desired menu type.
aBearerFilter	Filtering criteria on bearer type
aSortType	Specifies the sort order to use.
aReqIpvType	Specifies whether the caller would like to have IPv4, IPv6 or both access points. If it is IPv6 or Both, in case of IPv6 support is available as a feature, it will be supported. If IPv6 feature is not supported by the phone, it simply defaults to the normal IPv4 version. If it is IPv4, it uses the default IPv4 version independently from IPv6 feature beeing available or not.
aVpnFilterType	a TVpnFilterType representing the possible additional VPN filtering.
aIncludeEasyWlan	a TBool indicating whether it should include the easy wlan AP in the list or not.

Returns: The constructed CApSettingsHandler object.

RunSettingsL ( TUint32, TUint32 & )

IMPORT_C TInt	RunSettingsL	(	TUint32	aHighLight,
			TUint32 &	aSelected
		)

Starts the settings component. Creates dialog(s) from scratch, launches and executes them. Can leave with error codes. Deprecated

Returns: The accomplished task's flag-codes: KApUiEventNone, KApUiEventSelected, KApUiEventCreatedBlank, KApUiEventCreatedUsedOld, KApUiEventEdited, KApUiEventDeleted, KApUiEventExitRequested and their combinations. ( Bitwise OR ) aSelected will be modified only if KApUiEventSelected is included in the flags. In case it returns KApUiEventExitRequested, the user had choosen the Exit option from the Options menu which means that the caller application MUST exit! Returns after completion!

RunViewerL ( TUint32 )

IMPORT_C TInt

RunViewerL

(

TUint32

aUid

)

[protected]

Starts the viewer component. Creates dialog(s) from scratch, launches and executes it. In case of error, leaves with error codes. Deprecated

Returns: Returns the completed task's flags KApUiEventNone, KApUiEventSelected, KApUiEventCreatedBlank, KApUiEventCreatedUsedOld, KApUiEventEdited, KApUiEventDeleted, KApUiEventExitRequested and their combinations. ( Bitwise OR ) In case it returns KApUiEventExitRequested, the user had choosen the Exit option from the Options menu which means that the caller application MUST exit! Returns after completion!

SelectApToCopyL ( )

TUint32

SelectApToCopyL

(

)

[protected]

Selects the Ap to Copy, returns its UID. If not selected, KErrNone is returned

SetFilterL ( TInt, TInt, TInt )

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

Sets the filtering used in the access point selection. Deprecated

Parameter	Description
aBearerFilter	Filtering criteria on bearer type
aSortType	Specifies the sort order to use.

Returns: No return value. Leaves on error.

SetTextOverrideL ( TTextID, const TDesC & )

IMPORT_C void	SetTextOverrideL	(	TTextID	aText2Change,
			const TDesC &	aNewText
		)

Sets possible overrides of some texts. By default, text is read from resources. This provides a way to change some of the text to a caller-supplied one. The text must be read from resource and must be already localized. More than one text can be substituted, they are stored internally in an array. Currently not supported and supporting it is under discussion. Deprecated

Parameter	Description
aText2Change	TTextID to identify the text to be replaced with
aNewText	Reference to the substitute text.

TextOverrideL ( TTextID )

IMPORT_C const TDesC &

TextOverrideL

(

TTextID

aTextId

)

Gets possible overrides of a text. By default, text is read from resources. This provides a way to change some of the text to a caller-supplied one. The text must be read from resource and must be already localized. More than one text can be substituted, they are stored internally in an array. Currently not supported and supporting it is under discussion Deprecated

Returns: Reference to the substitute text.