commonappservices/alarmserver/Server/Include/ASSrvAlarmQueueObserver.h
changeset 0 2e3d3ce01487
equal deleted inserted replaced
-1:000000000000 0:2e3d3ce01487
       
     1 // Copyright (c) 1999-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 "Eclipse Public License v1.0"
       
     5 // which accompanies this distribution, and is available
       
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     7 //
       
     8 // Initial Contributors:
       
     9 // Nokia Corporation - initial contribution.
       
    10 //
       
    11 // Contributors:
       
    12 //
       
    13 // Description:
       
    14 //
       
    15 
       
    16 #ifndef __ASSRVALARMQUEUEOBSERVER_H__
       
    17 #define __ASSRVALARMQUEUEOBSERVER_H__
       
    18 
       
    19 // System includes
       
    20 #include <e32base.h>
       
    21 
       
    22 // User includes
       
    23 #include <asshddefs.h>
       
    24 
       
    25 // Type definitions
       
    26 
       
    27 // Constants
       
    28 
       
    29 // Enumerations
       
    30 
       
    31 // Classes referenced
       
    32 
       
    33 
       
    34 //
       
    35 // ----> MASSrvAlarmQueueObserver (header)
       
    36 //
       
    37 /**
       
    38  * A mixin class to be implemented by any object wishing to be informed
       
    39  * when the status of the alarm queue changes
       
    40  */
       
    41 class MASSrvAlarmQueueObserver
       
    42 	{
       
    43 //
       
    44 public:										// FROM MASSrvAlarmQueueObserver
       
    45 //
       
    46 
       
    47 	/**
       
    48 	 * The type of event that took place
       
    49 	 */
       
    50 	enum TASSrvAlarmQueueEvent
       
    51 		{
       
    52 		/**
       
    53 		 * The head item in the alarm queue changed
       
    54 		 */
       
    55 		EASSrvAlarmQueueEventHeadItemChanged = 0,
       
    56 
       
    57 		/**
       
    58 		 * An alarm was added to the queue
       
    59 		 */
       
    60 		EASSrvAlarmQueueEventAlarmAdded,
       
    61 
       
    62 		/**
       
    63 		 * The properties of an alarm changed
       
    64 		 */
       
    65 		EASSrvAlarmQueueEventAlarmChanged,
       
    66 
       
    67 		/**
       
    68 		 * An alarm was removed from the queue
       
    69 		 */
       
    70 		EASSrvAlarmQueueEventAlarmDeleted,
       
    71 
       
    72 		/**
       
    73 		 * Alarm server is starting to Internalize
       
    74 		 * (e.g. on startup, after backup restore) 
       
    75 		 */
       
    76 		EASSrvAlarmQueueEventAlarmStartInternalize
       
    77 		};
       
    78 
       
    79 //
       
    80 public:										// FROM MASSrvAlarmQueueObserver
       
    81 //
       
    82 
       
    83 	/**
       
    84 	 * Abstract event handler method
       
    85 	 */
       
    86 	virtual void							MAlarmQueueObserverHandleEvent(TASSrvAlarmQueueEvent aEvent, TAlarmId aAlarmId) = 0;
       
    87 	};
       
    88 
       
    89 
       
    90 #endif