Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: calalarm.h
Link against: calinterimapi.lib

Class CCalAlarm

class CCalAlarm : public CBase;

Description

Class representing an alarm. contains associated data extensions

This can be assigned to a calendar entry.

Derivation

Members

Defined in CCalAlarm:
AlarmAction(), AlarmSoundNameL(), NewL(), SetAlarmAction(), SetAlarmSoundNameL(), SetTimeOffset(), TimeOffset(), ~CCalAlarm()

Inherited from CBase:
Delete(), Extension_(), operator new()


Construction and destruction


NewL()

Capability: Illegal

static IMPORT_C CCalAlarm *NewL();

Description

Creates a new calendar alarm with no alarm sound name and an alarm time offset of 0 minutes, and no extended alarm action

Return value

CCalAlarm *

CCalAlarm pointer


~CCalAlarm()

Capability: Illegal

IMPORT_C ~CCalAlarm();

Description

A calendar alarm destructor.

[Top]


Member functions


SetTimeOffset()

Capability: Illegal

IMPORT_C void SetTimeOffset(TTimeIntervalMinutes aOffset);

Description

Sets a time offset for an alarm to occur prior to a scheduled event.

The time offset is calculated as the number of minutes before the instance time of the event.

It is possible to have a negative offset provided that the alarm is on the same day (in local time) as the instance time; this means the alarm occurs after the event. Fixed entries cannot have negative alarm offsets, since then the current day will change depending on the time zone.

Parameters

TTimeIntervalMinutes aOffset

The time offset in minutes for an alarm prior to an event.


TimeOffset()

Capability: Illegal

IMPORT_C TTimeIntervalMinutes TimeOffset() const;

Description

Gets the time offset for the alarm to occur prior to an event.

Return value

TTimeIntervalMinutes

The alarm offset (in minutes) prior to an event.


SetAlarmSoundNameL()

Capability: Illegal

IMPORT_C void SetAlarmSoundNameL(const TDesC &aAlarmSoundName);

Description

Sets the name of the alarm sound.

Note: if the length of the new alarm sound name is greater than KMaxAlarmSoundName characters, it will be ignored.

Parameters

const TDesC &aAlarmSoundName

The name of the alarm sound.


AlarmSoundNameL()

Capability: Illegal

IMPORT_C const TDesC &AlarmSoundNameL() const;

Description

Gets a descripter of the alarm sound name.

If there is no name set, KNullDesC will be returned.

Return value

const TDesC &

CCalAlarm descriptor reference


SetAlarmAction()

IMPORT_C void SetAlarmAction(CCalContent *aAlarmAction);

Description

Associates an action with the alarm. The action could be a link to an Internet radio station, or it could be a small animated icon. This class takes ownership of the alarm action. Any existing alarm action is deleted.

Parameters

CCalContent *aAlarmAction

The data or link (url).

See also:


AlarmAction()

IMPORT_C CCalContent *AlarmAction() const;

Description

Returns the action associated with the alarm. For example, the action could be a link to an Internet radio station, or it could be a small animated icon.

Return value

CCalContent *

The alarm action or a NULL pointer if there is no alarm action.

See also: