CSatelliteInfoUI Class Reference

#include <mw/CSatelliteInfoUI.h>

Link against: SatInfoStub.lib

class CSatelliteInfoUI : public CBase

Inherits from

CSatelliteInfoUI

Public Member Enumerations
enum	TSatelliteView { ESatelliteFirmamentView, ESatelliteSignalStrengthView, ESatelliteCompassView }

Public Member Functions
virtual	~CSatelliteInfoUI()
IMPORT_C TInt	ExecuteLD(const TDesC &)
IMPORT_C void	HandleForegroundEventL(TBool)
IMPORT_C CSatelliteInfoUI *	NewL()
IMPORT_C void	SetLaunchView(TSatelliteView)

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

Implements entry point class to Satellite Info UI

Member Enumeration Documentation

Enum TSatelliteView

Enumeration to specify the default launch view of the dialog.

Enumerator	Value	Description
ESatelliteFirmamentView	0x0001	Launch option for firmament view. Firmament view displays all the satellites in view with the satellite's number on a firmament.
ESatelliteSignalStrengthView	0x0002	Launch option for signal strength view. Signal strength view displays all the satellite with their correspoinding signal strength represented by bars.
ESatelliteCompassView	0x0003	Launch option for compass view. Compass view displays latitude, longitude, speed and direction along with 2D/3D type of Fix.

Constructor & Destructor Documentation

~CSatelliteInfoUI ( )

IMPORT_C

~CSatelliteInfoUI

(

)

[virtual]

Destructor.

Member Function Documentation

ExecuteLD ( const TDesC & )

IMPORT_C TInt

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.

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)

Parameter	Description
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.

HandleForegroundEventL ( TBool )

IMPORT_C void

HandleForegroundEventL

(

TBool

aForeground

)

Dialog switched to foreground or background

Parameter	Description
aForeground	ETrue to switch to the foreground. EFalse to switch to background.

NewL ( )

IMPORT_C CSatelliteInfoUI *

NewL

(

)

[static]

Two-phased constructor.

Returns: CSatelliteInfoUI object.

SetLaunchView ( TSatelliteView )

IMPORT_C void

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.

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.

Parameter	Description
aLaunchView	ESatelliteFirmamentView for firmament view and ESatelliteSignalStrengthView for signal strength view. ESatelliteCompassView for compass ciew ESatelliteCompassView Visibility will be variated depending on the product configuration/regional variation. if it is disabled to show compass view then function will ignore the ESatelliteCompassView and show firmament view instead.