![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
Section Contents
MBasicGsmPhoneClockAndAlarm |
Mixin: interface for controlling phone clock and alarm functionality. |
etelbgsm.h
gsmbas.lib
This class defines the protocol for implementing phone clock and alarm functionality.
protected: MBasicGsmPhoneClockAndAlarm()
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.
virtual TInt GetClockCaps(TClockAndAlarmCapsFlags& aCaps) const=0;
This function retrieves the clock and alarm capabilities.
TClockAndAlarmCapsFlags& aCaps |
On return, contains the phones clock and alarm capabilities. |
TInt |
An error code: see System error codes. |
virtual void NotifyClockCaps(TRequestStatus& aStatus, TClockAndAlarmCapsFlags& aCaps)=0;
This function requests notification of a change of the clock and alarm capabilities.
TRequestStatus& aStatus |
A variable that indicates the completion status of the request. |
TClockAndAlarmCapsFlags& aCaps |
On request completion, contains the current clock and alarm capabilities. |
virtual void NotifyClockCapsCancel() const=0;
This function cancels an outstanding clock and alarm capabilities change notification request, placed using the NotifyClockCaps() function.
virtual TInt ReadClock(TGsmDateTime& aGsmDateTime) const=0;
This function synchronously retrieves the phones current date and time.
TGsmDateTime& aGsmDateTime |
On return, contains the current date and time. |
TInt |
An error code: see System error codes. |
virtual void ReadClock(TRequestStatus& aStatus, TGsmDateTime& aGsmDateTime) const=0;
This function asynchronously retrieves the phones current date and time.
TRequestStatus& aStatus |
A variable that indicates the completion status of the request. |
TGsmDateTime& aGsmDateTime |
On request completion, contains the current date and time. |
virtual void ReadClockCancel() const=0;
This function cancels an outstanding request to read the clock, placed using the asynchronous variant of the ReadClock() function.
virtual TInt SetClock(const TGsmDateTime& aGsmDateTime) const=0;
This function synchronously sets the phones date and time to a given value.
const TGsmDateTime& aGsmDateTime |
The value to which the phones date and time is to be set. |
TInt |
An error code: see System error codes. |
virtual void SetClock(TRequestStatus& aStatus, const TGsmDateTime& aGsmDateTime) const=0;
This function asynchronously sets the phones date and time to a given value.
TRequestStatus& aStatus |
A variable that indicates the completion status of the request. |
const TGsmDateTime& aGsmDateTime |
The value to which the phones date and time is to be set. |
virtual void SetClockCancel() const=0;
This function cancels an outstanding request to set the phone clock, placed using the asynchronous variant of the SetClock() function.
virtual TInt EnumerateAlarm(TInt& aCount) const=0;
This synchronous function retrieves the number of alarms which are currently set.
TInt& aCount |
On return, contains the number of active alarms. |
TInt |
An error code: see System error codes. |
virtual void EnumerateAlarm(TRequestStatus& aStatus, TInt& aCount) const=0;
This asynchronous function retrieves the number of alarms which are currently set.
TRequestStatus& aStatus |
A variable that indicates the completion status of the request. |
TInt& aCount |
On request completion, contains the number of active alarms. |
virtual void EnumerateAlarmCancel() const=0;
This function cancels an outstanding request to enumerate the phones alarms, placed using the asynchronous variant of the EnumerateAlarm() function.
virtual TInt GetAlarm(const TInt aIndex,TAlarm& aAlarm) const=0;
This function synchronously retrieves the alarm information from a particular entry.
const TInt aIndex |
The index of the alarm to be read. The index may range from 0 to (n-1), where n is returned by the EnumerateAlarm() function. |
TAlarm& aAlarm |
On return, contains information for the specified alarm. |
TInt |
An error code: see System error codes. |
virtual void GetAlarm(TRequestStatus& aStatus, const TInt aIndex, TAlarm& aAlarm) const=0;
This function asynchronously retrieves alarm information.
TRequestStatus& aStatus |
A variable that indicates the completion status of the request. |
const TInt aIndex |
The index of the alarm to be read. The index may range from 0 to (n-1), where n is returned by the EnumerateAlarm() function. |
TAlarm& aAlarm |
On request completion, contains information for the specified alarm. |
virtual void GetAlarmCancel() const=0;
This function cancels an outstanding request to retrieve alarm information, placed using the asynchronous variant of the GetAlarm() function.
virtual TInt SetAlarm(const TInt aIndex,const TAlarm& aAlarm) const=0;
This function synchronously sets a phone alarm.
const TInt aIndex |
The index within the array at which the alarm should be stored. |
const TAlarm& aAlarm |
The alarm information to be stored. |
TInt |
An error code: see System error codes. |
virtual void SetAlarm(TRequestStatus& aStatus, const TInt aIndex,const TAlarm& aAlarm) const=0;
This function asynchronously sets a phone alarm.
TRequestStatus& aStatus |
A variable that indicates the completion status of the request. |
const TInt aIndex |
The index at which the alarm should be stored. |
const TAlarm& aAlarm |
The alarm information to be stored. |
virtual void SetAlarmCancel() const=0;
This function cancels an outstanding request to set an alarm, placed using the asynchronous variant of the SetAlarm() function.
Indicates that the phone clock may be read and changed. |
|
Indicates that the phone alarms may be read and changed. |
The maximum size of alarm text messages 256 characters. |
TUint iClockAndAlarmCaps |
Contains phone clock and alarm information as a bitmask of TClockCaps capability flags. |
TGsmDateTime iDateTime |
The date and time of the alarm. |
TBuf8<KAlarmTextSize> iText |
The text to be displayed by the phone when the alarm goes off. |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |