CSatelliteInfoUI Class Reference

API published in: S60 3rd Ed

Link against: satinfo.lib

Capability Information

Required Capabilities

Location


#include <csatelliteinfoui.h>

Detailed Description

Implements entry point class to Satellite Info UI.

Public Types

enum   TSatelliteView { ESatelliteFirmamentView = 0x0001, ESatelliteSignalStrengthView = 0x0002 }
  Enumeration to specify the default launch view of the dialog. More...

Public Member Functions

virtual IMPORT_C  ~CSatelliteInfoUI ()
  Destructor.
IMPORT_C TInt  ExecuteLD (const TDesC &aNameOfRule)
  Display satellite's information dialog.
IMPORT_C void  HandleForegroundEventL (TBool aForeground)
  Dialog switched to foreground or background.
IMPORT_C void  SetLaunchView (TSatelliteView aLaunchView)
  Used to set the dialog's launch view.

Static Public Member Functions

static IMPORT_C CSatelliteInfoUI NewL ()
  Two-phased constructor.

Member Enumeration Documentation

enum CSatelliteInfoUI::TSatelliteView
 

Enumeration to specify the default launch view of the dialog.

Enumerator:
ESatelliteFirmamentView  Launch option for firmament view.

Firmament view displays all the satellites in view with the satellite's number on a firmament.

ESatelliteSignalStrengthView  Launch option for signal strength view.

Signal strength view displays all the satellite with their correspoinding signal strength represented by bars.


Constructor & Destructor Documentation

virtual IMPORT_C CSatelliteInfoUI::~CSatelliteInfoUI  )  [virtual]
 

Destructor.


Member Function Documentation

IMPORT_C TInt CSatelliteInfoUI::ExecuteLD const TDesC &  aNameOfRule  ) 
 

Display satellite's information dialog.

This library uses the services provided by Location Framework. Once the dialog is launched satellite information is continuously requested via Location Acquisition API. The Location Acquisition API is offered by Location Framework. The user can switch between the two views once the dialog is launched.

Parameters:
aNameOfRule  is requestor data for Location FW which will be used for privacy verification in the future. Application name should be used to specify the requestor. The string should not be empty.
Returns:
TInt value of the selected softkey, which is EEikCommandTypeExitOrBack, because it is the only softkey of the dialog.
Leave:
KErrArgument if requestor data (aNameOfRule argument) length exceeds 255 characters or if it is empty. This function may also leave with any one of the standard error codes such as out of memory (e.g. KErrNoMemory)
IMPORT_C void CSatelliteInfoUI::HandleForegroundEventL TBool  aForeground  ) 
 

Dialog switched to foreground or background.

Parameters:
aForeground  ETrue to switch to the foreground. EFalse to switch to background.
static IMPORT_C CSatelliteInfoUI* CSatelliteInfoUI::NewL  )  [static]
 

Two-phased constructor.

Returns:
CSatelliteInfoUI object.
IMPORT_C void CSatelliteInfoUI::SetLaunchView TSatelliteView  aLaunchView  ) 
 

Used to set the dialog's launch view.

This method is used to set the view in which the dialog should be launched. The two available views are signal strength and firmament view. Constants for settings default view specified in enum TSatelliteView. This method should be called before the method ExecuteLD is invoked.

Parameters:
aLaunchView  ESatelliteFirmamentView for firmament view and ESatelliteSignalStrengthView for signal strength view.
Panic:
EAknPanicOutOfRange if the method is invoked with an invalid parameter. Values provided apart from those specified in TSatelliteView are invalid and will cause the method to panic.

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

Copyright © Nokia Corporation 2001-2008
Back to top