CApSettingsHandler Class Reference

API published in: S60 1st Ed

Link against: apsettingshandlerui.lib

Capability Information

Required Capabilities

ReadDeviceData ReadUserData WriteDeviceData WriteUserData

Exceptions

none

#include <apsettingshandlerui.h>

Detailed Description

CApSettingsHandler class: It is the main handler for the Access Point settings.

It contains the only public API for other (sub)systems.


Public Member Functions
IMPORT_C�	~CApSettingsHandler ()
�	Destructor.
IMPORT_C void�	SetFilterL (TInt aIspFilter, TInt aBearerFilter, TInt aSortType)
�	Sets the filtering used in the access point selection.
IMPORT_C void�	SetTextOverrideL (TTextID aText2Change, const TDesC &aNewText)
�	Sets possible overrides of some texts.
IMPORT_C const TDesC &�	TextOverrideL (TTextID aTextId)
�	Gets possible overrides of a text.
IMPORT_C TInt�	RunSettingsL (TUint32 aHighLight, TUint32 &aSelected)
�	Starts the settings component.
Static Public Member Functions
static IMPORT_C CApSettingsHandler *�	NewLC (TBool aStartWithSelection, TSelectionListType aListType, TSelectionMenuType aSelMenuType, TInt aIspFilter, TInt aBearerFilter, TInt aSortType)
�	Two-phased constructor.
static IMPORT_C CApSettingsHandler *�	NewLC (CActiveApDb &aDb, TBool aStartWithSelection, TSelectionListType aListType, TSelectionMenuType aSelMenuType, TInt aIspFilter, TInt aBearerFilter, TInt aSortType)
�	Two-phased constructor.
static IMPORT_C CApSettingsHandler *�	NewLC (TBool aStartWithSelection, TSelectionListType aListType, TSelectionMenuType aSelMenuType, TInt aIspFilter, TInt aBearerFilter, TInt aSortType, TInt aReqIpvType)
�	Two-phased constructor.
static IMPORT_C CApSettingsHandler *�	NewLC (CActiveApDb &aDb, TBool aStartWithSelection, TSelectionListType aListType, TSelectionMenuType aSelMenuType, TInt aIspFilter, TInt aBearerFilter, TInt aSortType, TInt aReqIpvType)
�	Two-phased constructor.
static IMPORT_C CApSettingsHandler *�	NewLC (TBool aStartWithSelection, TSelectionListType aListType, TSelectionMenuType aSelMenuType, TInt aIspFilter, TInt aBearerFilter, TInt aSortType, TInt aReqIpvType, TVpnFilterType aVpnFilterType)
�	Two-phased constructor.
static IMPORT_C CApSettingsHandler *�	NewLC (CActiveApDb &aDb, TBool aStartWithSelection, TSelectionListType aListType, TSelectionMenuType aSelMenuType, TInt aIspFilter, TInt aBearerFilter, TInt aSortType, TInt aReqIpvType, TVpnFilterType aVpnFilterType)
�	Two-phased constructor.
static IMPORT_C CApSettingsHandler *�	NewLC (CActiveApDb &aDb, TBool aStartWithSelection, TSelectionListType aListType, TSelectionMenuType aSelMenuType, TInt aIspFilter, TInt aBearerFilter, TInt aSortType, TInt aReqIpvType, TVpnFilterType aVpnFilterType, TBool aIncludeEasyWlan)
�	Two-phased constructor.
static IMPORT_C TInt�	Cvt ()
�	Component Validation Test.
Protected Member Functions
IMPORT_C�	CApSettingsHandler (TBool aStartWithSelection, TSelectionListType aListType, TSelectionMenuType aSelMenuType)
�	Constructor.
IMPORT_C�	CApSettingsHandler (TBool aStartWithSelection, TSelectionListType aListType, TSelectionMenuType aSelMenuType, TUid aHelpMajor)
�	Constructor.
�	CApSettingsHandler (TBool aStartWithSelection, TSelectionListType aListType, TSelectionMenuType aSelMenuType, TBool aNeedIpv6Support)
�	Constructor.
IMPORT_C void�	ConstructL (TInt aIspFilter, TInt aBearerFilter, TInt aSortType)
�	Second-phase constructor.
IMPORT_C void�	ConstructL (CActiveApDb &aDb, TInt aIspFilter, TInt aBearerFilter, TInt aSortType)
�	Second-phase constructor.
IMPORT_C void�	ConstructL (TInt aIspFilter, TInt aBearerFilter, TInt aSortType, TVpnFilterType aVpnFilterType)
�	Second-phase constructor.
IMPORT_C void�	ConstructL (CActiveApDb &aDb, TInt aIspFilter, TInt aBearerFilter, TInt aSortType, TVpnFilterType aVpnFilterType)
�	Second-phase constructor.
IMPORT_C void�	ConstructL (CActiveApDb &aDb, TInt aIspFilter, TInt aBearerFilter, TInt aSortType, TVpnFilterType aVpnFilterType, TBool aIncludeEasyWlan)
�	Second-phase constructor.
TInt�	DoRunSettingsL (TUint32 aHighLight, TUint32 &aSelected)
�	Since 3rd Ed FP1 Starts the settings component.
IMPORT_C TInt�	RunViewerL (TUint32 aUid)
�	Starts the viewer component.
TInt�	DoRunViewerL (TUint32 aUid)
�	Since 3rd Ed FP1 Starts the viewer component.
void�	HandleApDeleteCmdL (TUint32 aUid, TBool aIsLast)
TUint32�	HandleApBlankNewL (TInt aBearers, TInt aIsps)
TUint32�	HandleApUseOldNewL ()
TUint32�	EditAfterCreateL (TUint32 aUid, CApAccessPointItem *aItem=NULL)
void�	DoConstructL (CActiveApDb *aDb, TInt aIspFilter, TInt aBearerFilter, TInt aSortType, TVpnFilterType aVpnFilterType, TBool aIncludeEasyWlan)
�	Second-phase internal constructor.
void�	DoRunListSettingsL (TUint32 aHighLight, TUint32 &aSelected)
�	Since 3rd Ed FP1 Starts the selector component as a list Creates dialog(s) from scratch, launches and executes them.
void�	DoRunSetPageSettingsL (TUint32 aHighLight, TUint32 &aSelected)
�	Since 3rd Ed FP1 Starts the selector component in a setting page Creates dialog(s) from scratch, launches and executes them.
TUint32�	DoHandleApUseOldNewL (TUint32 aSelected)
�	Since 3rd Ed FP1 handles the Create new access Point by using existing one command.
TUint32�	SelectApToCopyL ()
�	Since 3rd Ed FP1 Selects the Ap to Copy, returns its UID.
TUint32�	DoHandleApBlankNewL (TInt aBearers, TInt aIsps)
�	Since 3rd Ed FP1 handles the Create blank new access Point command.
void�	HandleNetworkDeleteCmdL (TUint32 aUid)
�	Since 3rd Ed FP1 handles the Delete network group command.
TInt�	GetVariantL ()
�	Since 3rd Ed FP1 Gets the local variant value
TInt�	ConfirmDeleteL (TUint32 aUid, TBool aIsLast)
�	Since 3rd Ed FP1 Gets confirmation about deleting an access point
void�	HandleRunSettingsL (TUint32 aHighLight, TUint32 &aSelected)
�	Since 3rd Ed FP1 Wrapper for the public API
Friends
class�	CApSettingsDlg
class�	CApSelectorDialog
class�	CApSelPopupList
class�	CApNetSelPopupList

Constructor & Destructor Documentation

IMPORT_C CApSettingsHandler::~CApSettingsHandler

(�

�)�

�	Destructor.

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

�

Constructor.

Parameters:

	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.

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

�

Constructor.

Parameters:

	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::CApSettingsHandler	(�	TBool�	aStartWithSelection,
		TSelectionListType�	aListType,
		TSelectionMenuType�	aSelMenuType,
		TBool�	aNeedIpv6Support
	)�	`[protected]`

�

Constructor.

Parameters:

	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

Member Function Documentation

TInt CApSettingsHandler::ConfirmDeleteL	(�	TUint32�	aUid,
		TBool�	aIsLast
	)�	`[protected]`

�

Since 3rd Ed FP1 Gets confirmation about deleting an access point

Parameters:

	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

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

�

Second-phase constructor.

Parameters:

	aDb�	A database to work on
	aIspTypeFilter�	Filtering criteria on ISP type
	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.

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

�

Second-phase constructor.

Parameters:

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

IMPORT_C void CApSettingsHandler::ConstructL	(�	TInt�	aIspFilter,
		TInt�	aBearerFilter,
		TInt�	aSortType,
		TVpnFilterType�	aVpnFilterType
	)�	`[protected]`

�

Second-phase constructor.

Parameters:

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

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

�

Second-phase constructor.

Parameters:

	aDb�	A database to work on
	aIspTypeFilter�	Filtering criteria on ISP type
	aBearerFilter�	Filtering criteria on bearer type
	aSortType�	Specifies the sort order to use.

IMPORT_C void CApSettingsHandler::ConstructL	(�	TInt�	aIspFilter,
		TInt�	aBearerFilter,
		TInt�	aSortType
	)�	`[protected]`

�

Second-phase constructor.

Parameters:

	aIspTypeFilter�	Filtering criteria on ISP type
	aBearerFilter�	Filtering criteria on bearer type
	aSortType�	Specifies the sort order to use.

static IMPORT_C TInt CApSettingsHandler::Cvt (� �)� [static]

�	Component Validation Test. Returns: KErrNone.

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

�

Second-phase internal constructor.

Parameters:

	aDb�	A database to work on
	aIspTypeFilter�	Filtering criteria on ISP type
	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.

TUint32 CApSettingsHandler::DoHandleApBlankNewL	(�	TInt�	aBearers,
		TInt�	aIsps
	)�	`[protected]`

�	Since 3rd Ed FP1 handles the Create blank new access Point command.

TUint32 CApSettingsHandler::DoHandleApUseOldNewL (� TUint32� aSelected �)� [protected]

�

Since 3rd Ed FP1 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.

Parameters:

aSelected�

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

Returns:: The UID of the newly created Ap

void CApSettingsHandler::DoRunListSettingsL	(�	TUint32�	aHighLight,
		TUint32 &�	aSelected
	)�	`[protected]`

�

Since 3rd Ed FP1 Starts the selector component as a list Creates dialog(s) from scratch, launches and executes them.

In case of error, leaves with error codes.

Parameters:

	TUint32�	aHighlight The UID of the AP to highlight by default
	TUint32�	aSelected The UID of the AP selected by the user

Returns:: The accomplished task's flag-codes:
KApUiEventNone,
KApUiEventSelected,
KApUiEventCreatedBlank,
KApUiEventCreatedUsedOld,
KApUiEventEdited,
KApUiEventDeleted
and their combinations. ( Bitwise OR )
aSelected will be modified only if KApUiEventSelected is included in the flags.
Returns after completion!

void CApSettingsHandler::DoRunSetPageSettingsL	(�	TUint32�	aHighLight,
		TUint32 &�	aSelected
	)�	`[protected]`

�

Since 3rd Ed FP1 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.

Parameters:

	TUint32�	aHighlight The UID of the AP to highlight by default
	TUint32�	aSelected The UID of the AP selected by the user

Returns:: The accomplished task's flag-codes:
KApUiEventNone,
KApUiEventSelected,
KApUiEventCreatedBlank,
KApUiEventCreatedUsedOld,
KApUiEventEdited,
KApUiEventDeleted
and their combinations. ( Bitwise OR )
aSelected will be modified only if KApUiEventSelected is included in the flags.
Returns after completion!

TInt CApSettingsHandler::DoRunSettingsL	(�	TUint32�	aHighLight,
		TUint32 &�	aSelected
	)�	`[protected]`

�

Since 3rd Ed FP1 Starts the settings component.

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

Parameters:

	TUint32�	aHighlight The UID of the AP to highlight by default
	TUint32�	aSelected The UID of the AP selected by the user

Returns:: The accomplished task's flag-codes:
KApUiEventNone,
KApUiEventSelected,
KApUiEventCreatedBlank,
KApUiEventCreatedUsedOld,
KApUiEventEdited,
KApUiEventDeleted
and their combinations. ( Bitwise OR )
aSelected will be modified only if KApUiEventSelected is included in the flags.
Returns after completion!

TInt CApSettingsHandler::DoRunViewerL (� TUint32� aUid �)� [protected]

�

Since 3rd Ed FP1 Starts the viewer component.

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

Parameters:

TUint32�

aUid The UID of the AP to view/edit

Returns:: Returns the completed task's flags KApUiEventNone, KApUiEventSelected, KApUiEventCreatedBlank, KApUiEventCreatedUsedOld, KApUiEventEdited, KApUiEventDeleted, KApUiEventExitRequested and their combinations. ( Bitwise OR ) Returns after completion!

TUint32 CApSettingsHandler::EditAfterCreateL	(�	TUint32�	aUid,
		CApAccessPointItem *�	aItem = `NULL`
	)�	`[protected]`

�

TInt CApSettingsHandler::GetVariantL (� �)� [protected]

�	Since 3rd Ed FP1 Gets the local variant value Returns: A TInt stating the variant

TUint32 CApSettingsHandler::HandleApBlankNewL	(�	TInt�	aBearers,
		TInt�	aIsps
	)�	`[protected]`

�

void CApSettingsHandler::HandleApDeleteCmdL	(�	TUint32�	aUid,
		TBool�	aIsLast
	)�	`[protected]`

�

TUint32 CApSettingsHandler::HandleApUseOldNewL (� �)� [protected]

�

void CApSettingsHandler::HandleNetworkDeleteCmdL (� TUint32� aUid �)� [protected]

�

Since 3rd Ed FP1 handles the Delete network group command.

Parameters:

aUid�

The uid of the network to delete

void CApSettingsHandler::HandleRunSettingsL	(�	TUint32�	aHighLight,
		TUint32 &�	aSelected
	)�	`[protected]`

�	Since 3rd Ed FP1 Wrapper for the public API

static IMPORT_C CApSettingsHandler* 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!

Parameters:

	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.
	aIspTypeFilter�	Filtering criteria on ISP 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.

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

�

Two-phased constructor.

Parameters:

	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.
	aIspTypeFilter�	Filtering criteria on ISP 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.

static IMPORT_C CApSettingsHandler* 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!

Parameters:

	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.
	aIspTypeFilter�	Filtering criteria on ISP 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.

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

�

Two-phased constructor.

Parameters:

	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.
	aIspTypeFilter�	Filtering criteria on ISP 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.

static IMPORT_C CApSettingsHandler* 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!

Parameters:

	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.
	aIspTypeFilter�	Filtering criteria on ISP 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.

static IMPORT_C CApSettingsHandler* CApSettingsHandler::NewLC	(�	CActiveApDb &�	aDb,
		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!

Parameters:

	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.
	aIspTypeFilter�	Filtering criteria on ISP type
	aBearerFilter�	Filtering criteria on bearer type
	aSortType�	Specifies the sort order to use.

Returns:: The constructed CApSettingsHandler object.

static IMPORT_C CApSettingsHandler* 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!

Parameters:

	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.
	aIspTypeFilter�	Filtering criteria on ISP type
	aBearerFilter�	Filtering criteria on bearer type
	aSortType�	Specifies the sort order to use.

Returns:: The constructed CApSettingsHandler object.

IMPORT_C TInt CApSettingsHandler::RunSettingsL	(�	TUint32�	aHighLight,
		TUint32 &�	aSelected
	)�

�

Starts the settings component.

Creates dialog(s) from scratch, launches and executes them. Can leave with error codes.

Parameters:

	TUint32�	aHighlight The UID of the AP to highlight by default
	TUint32�	aSelected The UID of the access point selected by the user.

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!

IMPORT_C TInt CApSettingsHandler::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.

Parameters:

TUint32�

aUid The UID of the AP to view/edit

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!

TUint32 CApSettingsHandler::SelectApToCopyL (� �)� [protected]

�	Since 3rd Ed FP1 Selects the Ap to Copy, returns its UID. If not selected, KErrNone is returned

IMPORT_C void CApSettingsHandler::SetFilterL	(�	TInt�	aIspFilter,
		TInt�	aBearerFilter,
		TInt�	aSortType
	)�

�

Sets the filtering used in the access point selection.

Parameters:

	aIspTypeFilter�	Filtering criteria on ISP type
	aBearerFilter�	Filtering criteria on bearer type
	aSortType�	Specifies the sort order to use.

Returns:: No return value. Leaves on error.

IMPORT_C void CApSettingsHandler::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.

Parameters: