1 calalarm.h

     1 // Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).

     2 // All rights reserved.

     3 // This component and the accompanying materials are made available

     4 // under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members

     5 // which accompanies this distribution, and is available

     6 // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".

     7 //

     8 // Initial Contributors:

     9 // Nokia Corporation - initial contribution.

    10 //

    11 // Contributors:

    12 //

    13 // Description:

    14 //

    15 

    16 #ifndef __CALALARM_H__

    17 #define __CALALARM_H__

    18 

    19 #include <calcontent.h>

    20 

    21 /** Alarm category Id for Calendar alarms

    22 @publishedAll

    23 @released

    24 */

    25 const TUid KUidAgendaModelAlarmCategory = { 0x101F4A70 };

    26 

    27 NONSHARABLE_CLASS(CCalAlarm) : public CBase

    28 /** Class representing an alarm. contains associated data extensions

    29 

    30 This can be assigned to a calendar entry.

    31 

    32 @publishedAll

    33 @released

    34 */

    35 	{

    36 public:

    37 	IMPORT_C static CCalAlarm* NewL();

    38 	IMPORT_C ~CCalAlarm();

    39 	IMPORT_C void SetTimeOffset(TTimeIntervalMinutes aOffset);

    40 	IMPORT_C TTimeIntervalMinutes TimeOffset() const;

    41 	IMPORT_C void SetAlarmSoundNameL(const TDesC& aAlarmSoundName);

    42 	IMPORT_C const TDesC& AlarmSoundNameL() const;

    43 	IMPORT_C void SetAlarmAction(CCalContent* aAlarmAction);

    44 	IMPORT_C CCalContent* AlarmAction() const;

    45 

    46 private:

    47 	CCalAlarm();

    48 

    49 private:

    50 	TTimeIntervalMinutes iOffset;

    51 	HBufC* iAlarmName;

    52 	// the associated data for rich alarm action

    53 	CCalContent* iAlarmAction;

    54 	};

    55 

    56 

    57 #endif // __CALALARM_H__

    58