EPOC   SDK Home Glossary Indexes Previous Next Up

MBasicGsmPhoneIndicator class


Contents


MBasicGsmPhoneIndicator class — Protocol for accessing phone indicator information

Section Contents


Overview

Derivation

MBasicGsmPhoneIndicator

Mixin: interface for accessing phone indicator information.

Defined in

etelbgsm.h

Link against

gsmbas.lib

Description

This class defines the protocol for accessing phone indicator information.


Construction and destruction


MBasicGsmPhoneIndicator() — Protected default C++ constructor

protected: MBasicGsmPhoneIndicator()

Description

The default C++ constructor is protected, which prevents objects of this class from being constructed. This class is intended only as an abstract base for other classes.


Indicator capabilities functions


GetIndicatorCaptureCaps() — Get phone indicator information retrieval capabilities

virtual TInt GetIndicatorCaptureCaps(TIndicatorCapsFlags& aCaps) const=0;

Description

This function allows clients to determine whether a phone has the ability to retrieve indicator status information.

Arguments

TIndicatorCapsFlags& aCaps

On return, contains the phone’s indicator information retrieval capabilities

Return value

TInt

An error code: see System error codes.


Indicator access functions


GetIndicator() — Get indicator state

virtual TInt GetIndicator(const TIndicatorType aIndicator,TUint& aValue) const=0;

Description

This function retrieves the state of an indicator.

Arguments

const TIndicatorType aIndicator

The indicator for which the state is required.

TUint& aValue

On return, contains the indicator state.

Return value

TInt

An error code: see System error codes.


IndicatorNotification() — Notification of changes to the indicator state

virtual void IndicatorNotification(TRequestStatus& aStatus,TIndicatorInfo& aIndicator)=0;

Description

This function provides notification when an indicator changes state.

Arguments

TRequestStatus& aStatus

A variable that indicates the completion status of the request.

TIndicatorInfo& aIndicator

On request completion, contains the name of the indicator which has changed state and its current value.


IndicatorNotificationCancel() — Cancel notification of changes to the indicator state

virtual void IndicatorNotificationCancel() const=0;

Description

This function cancels an outstanding request to notify the client about indicator changes, placed using the NotifyIndicatorChange() function.


Enumerations


TPhoneEquipmentIndicatorCaps enum — Indicator capability flags

KCapsEquipmentIndicatorCapture

Indicates that the status of the phone indicators may be read.


TIndicatorType enum — Indicator types

EIndBatteryCharge

Battery charge indicator.

EIndSignalQuality

Signal strength indicator.

EIndServiceAvail

Network service available indicator.

EIndSounderActivity

Sounder activity indicator.

EIndMessageReceived

Message received indicator.

EIndCallInProgress

Call in progress indicator.

EIndTxActivatedByVoiceActivity

Voice activated indicator.

EIndRoamingIndicator

Roaming indicator.

EIndSmsStorageFull

SMS storage full indicator.


Struct


TIndicatorCapsFlags struct — Indicator capability information

TUint iIndicatorCapture

A bitmask of TPhoneEquipmentIndicatorCaps constants.


TIndicatorInfo struct — Indicator notification information

TIndicatorType iIndicator

The indicator that has changed.

TUint iValue

The new value of the indicator. Note that in the case of binary indicators ‘0’ means off and ‘1’ means on.

EPOC       SDK Home Glossary Indexes Previous Next Up