S60 3rd Edition API Reference: CSatelliteInfoUI Class Reference

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

Static Public Member Functions

static IMPORT_C CSatelliteInfoUINewL ()
 Two-phased constructor.

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. 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 soft key 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.

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

Copyright © Nokia Corporation 2001-2007
Back to top