Class CCalAlarm

class CCalAlarm : public CBase;

Description

Class representing an alarm. contains associated data extensions

This can be assigned to a calendar entry.

Derivation

• CBase - Base class for all classes to be instantiated on the heap.

• CCalAlarm - Class representing an alarm. contains associated data extensions

Members

Defined in CCalAlarm:

• AlarmAction()constReturns the action associated with the alarm. For example, the action could be a...
• AlarmAction()const
• AlarmSoundNameL()constGets a descripter of the alarm sound name.
• AlarmSoundNameL()const
• NewL()Creates a new calendar alarm with no alarm sound name and an alarm time offset o...
• NewL()
• SetAlarmAction(CCalContent *)Associates an action with the alarm. The action could be a link to an Internet r...
• SetAlarmAction(CCalContent *)
• SetAlarmSoundNameL(const TDesC &)Sets the name of the alarm sound.
• SetAlarmSoundNameL(const TDesC &)
• SetTimeOffset(TTimeIntervalMinutes)Sets a time offset for an alarm to occur prior to a scheduled event.
• SetTimeOffset(TTimeIntervalMinutes)
• TimeOffset()constGets the time offset for the alarm to occur prior to an event.
• TimeOffset()const
• ~CCalAlarm()A calendar alarm destructor.
• ~CCalAlarm()

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

IMPORT_C static 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

IMPORT_C ~CCalAlarm();

Description

A calendar alarm destructor.

IMPORT_C static CCalAlarm* NewL();

Description

Return value

IMPORT_C ~CCalAlarm();

Description

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.

• For todo entries, the instance time is the end date (the due date).

• For non-todo entries, the instance time is the start date.

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

IMPORT_C TTimeIntervalMinutes TimeOffset() const;

Description

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

Return value

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

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

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

See also:

• CCalContentThis class holds in memory 8-bit data of any type, or a link to 8-bit data such ...

IMPORT_C void SetTimeOffset(TTimeIntervalMinutes aOffset);

Description

Parameters

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

See also:

• CCalContentThis class holds in memory 8-bit data of any type, or a link to 8-bit data such ...

IMPORT_C TTimeIntervalMinutes TimeOffset() const;

Description

Return value

IMPORT_C void SetAlarmSoundNameL(const TDesC &aAlarmSoundName);

Description

Parameters

IMPORT_C const TDesC& AlarmSoundNameL() const;

Description

Return value

IMPORT_C void SetAlarmAction(CCalContent *aAlarmAction);

Description

Parameters

IMPORT_C CCalContent* AlarmAction() const;

Description

Return value