epoc32/include/calalarm.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
permissions -rw-r--r--
Final list of Symbian^2 public API header files

// Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
// All rights reserved.
// This component and the accompanying materials are made available
// 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
// which accompanies this distribution, and is available
// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
//
// Initial Contributors:
// Nokia Corporation - initial contribution.
//
// Contributors:
//
// Description:
//

#ifndef __CALALARM_H__
#define __CALALARM_H__

#include <calcontent.h>

/** Alarm category Id for Calendar alarms
@publishedAll
@released
*/
const TUid KUidAgendaModelAlarmCategory = { 0x101F4A70 };

NONSHARABLE_CLASS(CCalAlarm) : public CBase
/** Class representing an alarm. contains associated data extensions

This can be assigned to a calendar entry.

@publishedAll
@released
*/
	{
public:
	IMPORT_C static CCalAlarm* NewL();
	IMPORT_C ~CCalAlarm();
	IMPORT_C void SetTimeOffset(TTimeIntervalMinutes aOffset);
	IMPORT_C TTimeIntervalMinutes TimeOffset() const;
	IMPORT_C void SetAlarmSoundNameL(const TDesC& aAlarmSoundName);
	IMPORT_C const TDesC& AlarmSoundNameL() const;
	IMPORT_C void SetAlarmAction(CCalContent* aAlarmAction);
	IMPORT_C CCalContent* AlarmAction() const;

private:
	CCalAlarm();

private:
	TTimeIntervalMinutes iOffset;
	HBufC* iAlarmName;
	// the associated data for rich alarm action
	CCalContent* iAlarmAction;
	};


#endif // __CALALARM_H__