CCmApplicationSettingsUi Class Reference

API published in: S60 3rd Ed FP 2

Link against: cmmanager.lib

Capability Information

Required Capabilities

None


#include <cmapplicationsettingsui.h>

Detailed Description

For launching the Application Settings UI.

Displays a radio button page for an application used to select a destination or connection method


Public Member Functions

virtual  ~CCmApplicationSettingsUi ()
  Destructor.
IMPORT_C TBool  RunApplicationSettingsL (TCmSettingSelection &aSelection)
  Launches the 'easy to use' Settings UI provided for applications for handling Destinations and Connection Methods.
IMPORT_C TBool  RunApplicationSettingsL (TCmSettingSelection &aSelection, TUint aListItems, TBearerFilterArray &aFilterArray)
  Launches the 'easy to use' Settings UI provided for applications for handling Destinations and Connection Methods.

Static Public Member Functions

static IMPORT_C CCmApplicationSettingsUi NewL ()
  Epoc constructor.
static IMPORT_C CCmApplicationSettingsUi NewLC ()
  Epoc constructor Pushes the object on the cleanup stack.

Constructor & Destructor Documentation

virtual CCmApplicationSettingsUi::~CCmApplicationSettingsUi  )  [virtual]
 

Destructor.


Member Function Documentation

static IMPORT_C CCmApplicationSettingsUi* CCmApplicationSettingsUi::NewL  )  [static]
 

Epoc constructor.

static IMPORT_C CCmApplicationSettingsUi* CCmApplicationSettingsUi::NewLC  )  [static]
 

Epoc constructor Pushes the object on the cleanup stack.

IMPORT_C TBool CCmApplicationSettingsUi::RunApplicationSettingsL TCmSettingSelection aSelection,
TUint  aListItems,
TBearerFilterArray aFilterArray
 

Launches the 'easy to use' Settings UI provided for applications for handling Destinations and Connection Methods.

Parameters:
aSelection  If initialised to a valid value, sets the higlight to the corresponding list item at startup. If a list of Destinations is displayed, and the initial highlight is set to a Connection Method, the parent Destination gets highlighted. On return, holds user selection.
aListItems  A bit field which indicates which items shoud be shown in the selection dialog. The bitmasks are defined in the TCmSelectionDialogItems enum.
The function leaves with KErrNotSupported if all the items which were set to be shown are not supported/enabled. E.g. Default Connection availability/support is controlled by the Feature Manager so if only EShowDefaultConnection is set and the Default Connection feature is not enabled than the function leaves with KErrNotSupported.

In other cases (when an item or items are not supported/enabled but not all) the selected but not supported/enabled items are not added to the list. The request to show such an item is silently ignored.

Special note about the EShowDestinations and EShowConnectionMethods bitmasks: The following enumerations controls how how destinations and Connection Methods are presented in the selection UI. General rule about the EShowDestinations: Destinations which does not contain any Connection Methods are not shown in the selection dialog. The same rule is applied if the Destination containes Connection Methods but all of them are filtered out by the filtering criteria. EShowDestinations is set and EShowConnectionMethods is set: Destination list is added to the selection UI and a Connection Method can be selected inside a Destination. EShowDestinations is set and EShowConnectionMethods is not set: Destination list is added to the selection UI and no Connection Method can be selected inside a Destination. EShowDestinations is not set and EShowConnectionMethods is set: Connection Method list is added to the selection UI. Connection Methods are ordered according to the global bearer type priorities. Destination cannot be selected. EShowDestinations is not set and EShowConnectionMethods is not set: The selection UI will not contain any Destination or Connection Method. E.g. If EShowAlwaysAsk and EShowDefaultConnection was set then the selection UI will contain two entries (AlwaysAsk and DefaultConnection).

Parameters:
aFilterArray  Only Connection Methods with bearer types from the aFilterArray will be shown. All Connection Methods will be listed if the array has no element.
Returns:
TBool seleceted or not.
Leave:
KErrArgument If the selection dialog would have zero elements based on the aListItems bitmask (aListItems is equal to zero).
Leave:
KErrNotSupported If the selection dialog would have zero elements based on the aListItems bitmask (all the selected elements in aListItems are not supported/disabled). E.g. aListItems = EShowDefaultConnection but Default Connection feature is not enabled.
Leave:
KErrConnectionNotFound If the selection dialog would have zero elements caused by filtering out all the Connection Methods with the aFilterArray and not requesting other list elements by the aListItems bitfield than the function call leaves with KErrConnectionNotFound error code. A corresponding error note can be shown using the error resolver. E.g.
  • aListItems = EShowConnectionMethods but all Connection Methods are filtered out by the aFilterArray.
IMPORT_C TBool CCmApplicationSettingsUi::RunApplicationSettingsL TCmSettingSelection aSelection  ) 
 

Launches the 'easy to use' Settings UI provided for applications for handling Destinations and Connection Methods.

This function call launches the same selection dialog as the the extended RunApplicationSettingsL do (see below) with the list items Default Connection, Destinations and Connection Methods without any filtering.

Parameters:
aSelection  If initialised to a valid value, sets the higlight to the corresponding list item at startup. If a list of Destinations is displayed, and the initial highlight is set to a Connection Method, the parent Destination gets highlighted. On return, holds user selection.
Returns:
TBool seleceted or not.

The documentation for this class was generated from the following file:

Copyright © Nokia Corporation 2001-2008
Back to top