CApSettingsHandler Class Reference

#include <mw/ApSettingsHandlerUI.h>

Link against: ApSettingsHandlerUI.lib

class CApSettingsHandler : public CBase

Inherits from

  • CApSettingsHandler
    Public Member Functions
    ~CApSettingsHandler()
    IMPORT_C TIntCvt()
    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 TIntRunSettingsL(TUint32, TUint32 &)
    IMPORT_C voidSetFilterL(TInt, TInt, TInt)
    IMPORT_C voidSetTextOverrideL(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 voidConstructL(TInt, TInt, TInt)
    IMPORT_C voidConstructL(CActiveApDb &, TInt, TInt, TInt)
    IMPORT_C voidConstructL(TInt, TInt, TInt, TVpnFilterType)
    IMPORT_C voidConstructL(CActiveApDb &, TInt, TInt, TInt, TVpnFilterType)
    IMPORT_C voidConstructL(CActiveApDb &, TInt, TInt, TInt, TVpnFilterType, TBool)
    voidDoConstructL(CActiveApDb *, TInt, TInt, TInt, TVpnFilterType, TBool)
    TUint32 DoHandleApBlankNewL(TInt, TInt)
    TUint32 DoHandleApUseOldNewL(TUint32)
    voidDoRunListSettingsL(TUint32, TUint32 &)
    voidDoRunSetPageSettingsL(TUint32, TUint32 &)
    TInt DoRunSettingsL(TUint32, TUint32 &)
    TInt DoRunViewerL(TUint32)
    TUint32 EditAfterCreateL(TUint32, CApAccessPointItem *)
    TInt GetVariantL()
    TUint32 HandleApBlankNewL(TInt, TInt)
    voidHandleApDeleteCmdL(TUint32, TBool)
    TUint32 HandleApUseOldNewL()
    voidHandleNetworkDeleteCmdL(TUint32)
    voidHandleRunSettingsL(TUint32, TUint32 &)
    IMPORT_C TIntRunViewerL(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_CCApSettingsHandler(TBoolaStartWithSelection,
    TSelectionListTypeaListType,
    TSelectionMenuTypeaSelMenuType
    )[protected]

    Constructor. Deprecated

    ParameterDescription
    aStartWithSelectionA boolean value indicating whether to select or edit an ap.
    aListTypeA TSelectionListType enum indicating the desired list type.
    aSelMenuTypeA TSelectionMenuType enum indicating the desired menu type.

    CApSettingsHandler ( TBool, TSelectionListType, TSelectionMenuType, TUid )

    IMPORT_CCApSettingsHandler(TBoolaStartWithSelection,
    TSelectionListTypeaListType,
    TSelectionMenuTypeaSelMenuType,
    TUidaHelpMajor
    )[protected]

    Constructor. Deprecated

    ParameterDescription
    aStartWithSelectionA boolean value indicating whether to select or edit an ap.
    aListTypeA TSelectionListType enum indicating the desired list type.
    aSelMenuTypeA TSelectionMenuType enum indicating the desired menu type.
    aHelpMajorMajor help ID

    CApSettingsHandler ( TBool, TSelectionListType, TSelectionMenuType, TBool )

    CApSettingsHandler(TBoolaStartWithSelection,
    TSelectionListTypeaListType,
    TSelectionMenuTypeaSelMenuType,
    TBoolaNeedIpv6Support
    )[protected]

    Constructor.

    ParameterDescription
    aStartWithSelectionA boolean value indicating whether to select or edit an ap.
    aListTypeA TSelectionListType enum indicating the desired list type.
    aSelMenuTypeA TSelectionMenuType enum indicating the desired menu type.
    aNeedIpv6SupportWhether IPv6 is supported or not

    ~CApSettingsHandler ( )

    IMPORT_C~CApSettingsHandler()

    Destructor.

    Deprecated

    Member Function Documentation

    ConfirmDeleteL ( TUint32, TBool )

    TInt ConfirmDeleteL(TUint32aUid,
    TBoolaIsLast
    )[protected]

    Gets confirmation about deleting an access point

    ParameterDescription
    aUidA TUint32 holding the WAP access point ID of the access point to be deleted.
    aIsLastA 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 voidConstructL(TIntaIspFilter,
    TIntaBearerFilter,
    TIntaSortType
    )[protected]

    Second-phase constructor. Deprecated

    ParameterDescription
    aBearerFilterFiltering criteria on bearer type
    aSortTypeSpecifies the sort order to use.

    ConstructL ( CActiveApDb &, TInt, TInt, TInt )

    IMPORT_C voidConstructL(CActiveApDb &aDb,
    TIntaIspFilter,
    TIntaBearerFilter,
    TIntaSortType
    )[protected]

    Second-phase constructor. Deprecated

    ParameterDescription
    aDbA database to work on
    aBearerFilterFiltering criteria on bearer type
    aSortTypeSpecifies the sort order to use.

    ConstructL ( TInt, TInt, TInt, TVpnFilterType )

    IMPORT_C voidConstructL(TIntaIspFilter,
    TIntaBearerFilter,
    TIntaSortType,
    TVpnFilterTypeaVpnFilterType
    )[protected]

    Second-phase constructor. Deprecated

    ParameterDescription
    aBearerFilterFiltering criteria on bearer type
    aSortTypeSpecifies the sort order to use.
    aVpnFilterTypea TVpnFilterType representing the possible additional VPN filtering.

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

    IMPORT_C voidConstructL(CActiveApDb &aDb,
    TIntaIspFilter,
    TIntaBearerFilter,
    TIntaSortType,
    TVpnFilterTypeaVpnFilterType
    )[protected]

    Second-phase constructor. Deprecated

    ParameterDescription
    aDbA database to work on
    aBearerFilterFiltering criteria on bearer type
    aSortTypeSpecifies the sort order to use.
    aVpnFilterTypea TVpnFilterType representing the possible additional VPN filtering.

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

    IMPORT_C voidConstructL(CActiveApDb &aDb,
    TIntaIspFilter,
    TIntaBearerFilter,
    TIntaSortType,
    TVpnFilterTypeaVpnFilterType,
    TBoolaIncludeEasyWlan
    )[protected]

    Second-phase constructor. Deprecated

    ParameterDescription
    aDbA database to work on
    aBearerFilterFiltering criteria on bearer type
    aSortTypeSpecifies the sort order to use.
    aVpnFilterTypea TVpnFilterType representing the possible additional VPN filtering.
    aIncludeEasyWlana TBool indicating whether it should include the easy wlan AP in the list or not.

    Cvt ( )

    IMPORT_C TIntCvt()[static]

    Component Validation Test. Deprecated

    Returns: KErrNone.

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

    voidDoConstructL(CActiveApDb *aDb,
    TIntaIspFilter,
    TIntaBearerFilter,
    TIntaSortType,
    TVpnFilterTypeaVpnFilterType,
    TBoolaIncludeEasyWlan
    )[protected]

    Second-phase internal constructor.

    ParameterDescription
    aDbA database to work on
    aBearerFilterFiltering criteria on bearer type
    aSortTypeSpecifies the sort order to use.
    aVpnFilterTypea TVpnFilterType representing the possible additional VPN filtering.
    aIncludeEasyWlana TBool indicating whether it should include the easy wlan AP in the list or not.

    DoHandleApBlankNewL ( TInt, TInt )

    TUint32 DoHandleApBlankNewL(TIntaBearers,
    TIntaIsps
    )[protected]

    handles the Create blank new access Point command.

    DoHandleApUseOldNewL ( TUint32 )

    TUint32 DoHandleApUseOldNewL(TUint32aSelected)[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.

    ParameterDescription
    aSelectedThe UID of the AP to copy. Shall not be KErrNone.

    Returns: The UID of the newly created Ap

    DoRunListSettingsL ( TUint32, TUint32 & )

    voidDoRunListSettingsL(TUint32aHighLight,
    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.

    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!

    DoRunSetPageSettingsL ( TUint32, TUint32 & )

    voidDoRunSetPageSettingsL(TUint32aHighLight,
    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.

    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!

    DoRunSettingsL ( TUint32, TUint32 & )

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

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

    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!

    DoRunViewerL ( TUint32 )

    TInt DoRunViewerL(TUint32aUid)[protected]

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

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

    EditAfterCreateL ( TUint32, CApAccessPointItem * )

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

    GetVariantL ( )

    TInt GetVariantL()[protected]

    Gets the local variant value

    Returns: A TInt stating the variant

    HandleApBlankNewL ( TInt, TInt )

    TUint32 HandleApBlankNewL(TIntaBearers,
    TIntaIsps
    )[protected]

    HandleApDeleteCmdL ( TUint32, TBool )

    voidHandleApDeleteCmdL(TUint32aUid,
    TBoolaIsLast
    )[protected]

    HandleApUseOldNewL ( )

    TUint32 HandleApUseOldNewL()[protected]

    HandleNetworkDeleteCmdL ( TUint32 )

    voidHandleNetworkDeleteCmdL(TUint32aUid)[protected]

    handles the Delete network group command.

    ParameterDescription
    aUidThe uid of the network to delete

    HandleRunSettingsL ( TUint32, TUint32 & )

    voidHandleRunSettingsL(TUint32aHighLight,
    TUint32 &aSelected
    )[protected]

    Wrapper for the public API

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

    IMPORT_C CApSettingsHandler *NewLC(TBoolaStartWithSelection,
    TSelectionListTypeaListType,
    TSelectionMenuTypeaSelMenuType,
    TIntaIspFilter,
    TIntaBearerFilter,
    TIntaSortType
    )[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

    ParameterDescription
    aStartWithSelectionA boolean value indicating whether to select or edit an ap.
    aListTypeA TSelectionListType enum indicating the desired list type.
    aSelMenuTypeA TSelectionMenuType enum indicating the desired menu type.
    aBearerFilterFiltering criteria on bearer type
    aSortTypeSpecifies the sort order to use.

    Returns: The constructed CApSettingsHandler object.

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

    IMPORT_C CApSettingsHandler *NewLC(CActiveApDb &aDb,
    TBoolaStartWithSelection,
    TSelectionListTypeaListType,
    TSelectionMenuTypeaSelMenuType,
    TIntaIspFilter,
    TIntaBearerFilter,
    TIntaSortType
    )[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

    ParameterDescription
    aDbA database to work on
    aStartWithSelectionA boolean value indicating whether to select or edit an ap.
    aListTypeA TSelectionListType enum indicating the desired list type.
    aSelMenuTypeA TSelectionMenuType enum indicating the desired menu type.
    aBearerFilterFiltering criteria on bearer type
    aSortTypeSpecifies the sort order to use.

    Returns: The constructed CApSettingsHandler object.

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

    IMPORT_C CApSettingsHandler *NewLC(TBoolaStartWithSelection,
    TSelectionListTypeaListType,
    TSelectionMenuTypeaSelMenuType,
    TIntaIspFilter,
    TIntaBearerFilter,
    TIntaSortType,
    TIntaReqIpvType
    )[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

    ParameterDescription
    aStartWithSelectionA boolean value indicating whether to select or edit an ap.
    aListTypeA TSelectionListType enum indicating the desired list type.
    aSelMenuTypeA TSelectionMenuType enum indicating the desired menu type.
    aBearerFilterFiltering criteria on bearer type
    aSortTypeSpecifies the sort order to use.
    aReqIpvTypeSpecifies 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,
    TBoolaStartWithSelection,
    TSelectionListTypeaListType,
    TSelectionMenuTypeaSelMenuType,
    TIntaIspFilter,
    TIntaBearerFilter,
    TIntaSortType,
    TIntaReqIpvType
    )[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

    ParameterDescription
    aDbA database to work on
    aStartWithSelectionA boolean value indicating whether to select or edit an ap.
    aListTypeA TSelectionListType enum indicating the desired list type.
    aSelMenuTypeA TSelectionMenuType enum indicating the desired menu type.
    aBearerFilterFiltering criteria on bearer type
    aSortTypeSpecifies the sort order to use.
    aReqIpvTypeSpecifies 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(TBoolaStartWithSelection,
    TSelectionListTypeaListType,
    TSelectionMenuTypeaSelMenuType,
    TIntaIspFilter,
    TIntaBearerFilter,
    TIntaSortType,
    TIntaReqIpvType,
    TVpnFilterTypeaVpnFilterType
    )[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

    ParameterDescription
    aStartWithSelectionA boolean value indicating whether to select or edit an ap.
    aListTypeA TSelectionListType enum indicating the desired list type.
    aSelMenuTypeA TSelectionMenuType enum indicating the desired menu type.
    aBearerFilterFiltering criteria on bearer type
    aSortTypeSpecifies the sort order to use.
    aReqIpvTypeSpecifies 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.
    aVpnFilterTypea 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,
    TBoolaStartWithSelection,
    TSelectionListTypeaListType,
    TSelectionMenuTypeaSelMenuType,
    TIntaIspFilter,
    TIntaBearerFilter,
    TIntaSortType,
    TIntaReqIpvType,
    TVpnFilterTypeaVpnFilterType
    )[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

    ParameterDescription
    aDbA database to work on
    aStartWithSelectionA boolean value indicating whether to select or edit an ap.
    aListTypeA TSelectionListType enum indicating the desired list type.
    aSelMenuTypeA TSelectionMenuType enum indicating the desired menu type.
    aBearerFilterFiltering criteria on bearer type
    aSortTypeSpecifies the sort order to use.
    aReqIpvTypeSpecifies 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.
    aVpnFilterTypea 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,
    TBoolaStartWithSelection,
    TSelectionListTypeaListType,
    TSelectionMenuTypeaSelMenuType,
    TIntaIspFilter,
    TIntaBearerFilter,
    TIntaSortType,
    TIntaReqIpvType,
    TVpnFilterTypeaVpnFilterType,
    TBoolaIncludeEasyWlan
    )[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

    ParameterDescription
    aDbA database to work on
    aStartWithSelectionA boolean value indicating whether to select or edit an ap.
    aListTypeA TSelectionListType enum indicating the desired list type.
    aSelMenuTypeA TSelectionMenuType enum indicating the desired menu type.
    aBearerFilterFiltering criteria on bearer type
    aSortTypeSpecifies the sort order to use.
    aReqIpvTypeSpecifies 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.
    aVpnFilterTypea TVpnFilterType representing the possible additional VPN filtering.
    aIncludeEasyWlana 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 TIntRunSettingsL(TUint32aHighLight,
    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 TIntRunViewerL(TUint32aUid)[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 voidSetFilterL(TIntaIspFilter,
    TIntaBearerFilter,
    TIntaSortType
    )

    Sets the filtering used in the access point selection. Deprecated

    ParameterDescription
    aBearerFilterFiltering criteria on bearer type
    aSortTypeSpecifies the sort order to use.

    Returns: No return value. Leaves on error.

    SetTextOverrideL ( TTextID, const TDesC & )

    IMPORT_C voidSetTextOverrideL(TTextIDaText2Change,
    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

    ParameterDescription
    aText2ChangeTTextID to identify the text to be replaced with
    aNewTextReference to the substitute text.

    TextOverrideL ( TTextID )

    IMPORT_C const TDesC &TextOverrideL(TTextIDaTextId)

    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.