66
|
1 |
/*
|
|
2 |
* Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies).
|
|
3 |
* All rights reserved.
|
|
4 |
* This component and the accompanying materials are made available
|
|
5 |
* under the terms of "Eclipse Public License v1.0"
|
|
6 |
* which accompanies this distribution, and is available
|
|
7 |
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
8 |
*
|
|
9 |
* Initial Contributors:
|
|
10 |
* Nokia Corporation - initial contribution.
|
|
11 |
*
|
|
12 |
* Contributors:
|
|
13 |
*
|
|
14 |
* Description: The header file for CClkUiAlarmModel class.
|
|
15 |
*
|
|
16 |
*/
|
|
17 |
|
|
18 |
#ifndef __CLKUI_ALARM_MODEL_H__
|
|
19 |
#define __CLKUI_ALARM_MODEL_H__
|
|
20 |
|
|
21 |
// System includes
|
|
22 |
|
|
23 |
// User includes
|
|
24 |
#include "clkuimdlbase.h"
|
|
25 |
#include "clkcommon.h"
|
|
26 |
|
|
27 |
// Forward declarations
|
|
28 |
|
|
29 |
// Class declaration
|
|
30 |
/**
|
|
31 |
* @class CClkUiAlarmModel
|
|
32 |
* @brief The model class for alarm server interface.
|
|
33 |
* @dll clkuimodel.dll
|
|
34 |
*/
|
|
35 |
class CClkUiAlarmModel : public CClkUiModelBase
|
|
36 |
{
|
|
37 |
public: // Constructor and destructor
|
|
38 |
|
|
39 |
/**
|
|
40 |
* @brief 2-phased constructor.
|
|
41 |
* @param aObserver MClkUiMdlObserver*
|
|
42 |
* @param aListenerPriority The priority of this object.
|
|
43 |
* @return CClkAlmModel* Pointer to the constructed alarm model.
|
|
44 |
*/
|
|
45 |
IMPORT_C static CClkUiAlarmModel* NewL( MClkModelObserver* aObserver, TInt aListenerPriority );
|
|
46 |
|
|
47 |
/**
|
|
48 |
* @brief Destructor.
|
|
49 |
*/
|
|
50 |
IMPORT_C ~CClkUiAlarmModel();
|
|
51 |
|
|
52 |
public: // New functions
|
|
53 |
|
|
54 |
/**
|
|
55 |
* @brief Interpret the listener status.
|
|
56 |
* @param aStatus The status.
|
|
57 |
*/
|
|
58 |
void ProcessListenerL( TInt aStatus );
|
|
59 |
|
|
60 |
/**
|
|
61 |
* @brief Get the list of the alarms which belong to clock category
|
|
62 |
* @param aAlarmIds A reference to the list of alarm ids. Filled by alarm server.
|
|
63 |
*/
|
|
64 |
IMPORT_C void GetClkAlarmIds( RArray< TAlarmId >& aAlarmIds );
|
|
65 |
|
|
66 |
/**
|
|
67 |
* @brief Deletes a clock alarm with
|
|
68 |
* @param aAlarmId The id of the alarm to be deleted.
|
|
69 |
* @return TInt Symbian OS error code.
|
|
70 |
*/
|
|
71 |
IMPORT_C TInt DeleteClockAlarm( TAlarmId aAlarmId );
|
|
72 |
|
|
73 |
/**
|
|
74 |
* @brief Deletes a clock alarm with
|
|
75 |
* @param aAlarmId The id of the alarm to be deleted.
|
|
76 |
* @return TInt Symbian OS error code.
|
|
77 |
*/
|
|
78 |
IMPORT_C TInt AlarmRemoveSnooze ( TAlarmId aAlarmId );
|
|
79 |
|
|
80 |
/**
|
|
81 |
* @brief Enable or disable a clock alarm.
|
|
82 |
* @param aAlarmId The id of the clock alarm.
|
|
83 |
* @param aState The status to which the alarm has to be changed.
|
|
84 |
* @return TInt Symbian OS error code.
|
|
85 |
*/
|
|
86 |
IMPORT_C TInt ClockAlarmEnable( TAlarmId aAlarmId,
|
|
87 |
TAlarmStatus aState );
|
|
88 |
|
|
89 |
/**
|
|
90 |
* @brief Get alarm status
|
|
91 |
* @param aAlarmId The id of the clock alarm whose status is needed.
|
|
92 |
* @return TAlarmStatus The current status.
|
|
93 |
*/
|
|
94 |
IMPORT_C TAlarmStatus ClockAlarmStatus( TAlarmId aAlarmId ) const;
|
|
95 |
|
|
96 |
/**
|
|
97 |
* @brief Get the category of the clock alarm.
|
|
98 |
* @param aCategory The category of the alarm with id aAlarmId.
|
|
99 |
* @param aAlarmId The id of the alarm.
|
|
100 |
* @return TInt Symbian OS error code.
|
|
101 |
*/
|
|
102 |
IMPORT_C TInt ClockAlarmType( TAlarmCategory& aCategory,
|
|
103 |
TAlarmId aAlarmId ) const;
|
|
104 |
|
|
105 |
/**
|
|
106 |
* @brief Set a new clock alarm.
|
|
107 |
* @param aAlarmInfo The new information.
|
|
108 |
* @return TInt Symbian OS error code.
|
|
109 |
*/
|
|
110 |
IMPORT_C TInt ClockAlarmSet( const SClkAlarmInfo& aAlarmInfo );
|
|
111 |
|
|
112 |
/**
|
|
113 |
* @brief Gets the information about an alarm.
|
|
114 |
* @param aAlarmId The id of the clock alarm.
|
|
115 |
* @param aAlarmInfo The information of the alarm, filled by the alarm server.
|
|
116 |
* @return TInt Symbian OS error code.
|
|
117 |
*/
|
|
118 |
IMPORT_C TInt ClockAlarmInfo( TAlarmId aAlarmId,
|
|
119 |
SClkAlarmInfo& aAlarmInfo ) const;
|
|
120 |
|
|
121 |
/**
|
|
122 |
* @brief Get the alarm Id.
|
|
123 |
* @return const TAlarmId
|
|
124 |
*/
|
|
125 |
IMPORT_C const TAlarmId& AlarmId();
|
|
126 |
|
|
127 |
/**
|
|
128 |
* @brief Saves the latest alarm id.
|
|
129 |
* @param aAlarmId The new alarm id.
|
|
130 |
*/
|
|
131 |
IMPORT_C void SaveLatestAlarmId( TAlarmId aAlarmId );
|
|
132 |
|
|
133 |
/**
|
|
134 |
* @brief Gets the queued or snoozed alarm Id.
|
|
135 |
* @param aAlarmId Queued or snoozed alarm Id.
|
|
136 |
* @param aUpdatedId ETrue Update alarm Id.
|
|
137 |
* @return ETrue queued or snoozed alarm is existed.
|
|
138 |
*/
|
|
139 |
IMPORT_C TBool GetAlarmQueuedOrSnoozedId( TAlarmId& aAlarmId,
|
|
140 |
TBool aUpdatedId = EFalse );
|
|
141 |
|
|
142 |
private: // New functions
|
|
143 |
|
|
144 |
/**
|
|
145 |
* @brief Performs the second phase of the 2-phase construction.
|
|
146 |
* @param aObserver MClkUiMdlObserver*
|
|
147 |
* @param aListenerPriority The priority of this object.
|
|
148 |
*/
|
|
149 |
void ConstructL( MClkModelObserver* aObserver,
|
|
150 |
TInt aListenerPriority );
|
|
151 |
|
|
152 |
private: // Data
|
|
153 |
|
|
154 |
/**
|
|
155 |
* @var iAlarmSrvSes
|
|
156 |
* @brief Object of alarm server session.
|
|
157 |
*/
|
|
158 |
RASCliSession iAlarmSrvSes;
|
|
159 |
|
|
160 |
/**
|
|
161 |
* @var iAlarmObject
|
|
162 |
* @brief To get the information related to set an alarm.
|
|
163 |
*/
|
|
164 |
TASShdAlarm iAlarmObject;
|
|
165 |
|
|
166 |
/**
|
|
167 |
* @var iAlarmId
|
|
168 |
* @brief The id of an alarm.
|
|
169 |
*/
|
|
170 |
TAlarmId iAlarmId;
|
|
171 |
};
|
|
172 |
|
|
173 |
#endif // __CLKUI_ALARM_MODEL_H__
|
|
174 |
|
|
175 |
// End of file
|