|
1 /* |
|
2 * Copyright (c) 2004 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: Tracked Presence ID. |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 #ifndef __CPENGTRACKEDPRESENCEID2_H |
|
20 #define __CPENGTRACKEDPRESENCEID2_H |
|
21 |
|
22 // INCLUDES |
|
23 #include <E32Base.h> |
|
24 |
|
25 //FORWARD DECLARATIONS |
|
26 class CPEngTrackedPresenceIDEntry; |
|
27 |
|
28 |
|
29 |
|
30 |
|
31 /** |
|
32 * Tracked Presence ID. |
|
33 * |
|
34 * Presents one tracked Presence ID and list of |
|
35 * presence attributes tracked for the Presence ID. |
|
36 * |
|
37 * In case of notification, holds also information |
|
38 * of presence attributes that have changed for the Presence ID. |
|
39 * |
|
40 * @lib PEngManager2.lib |
|
41 * @since 3.0 |
|
42 */ |
|
43 class CPEngTrackedPresenceID2 : public CBase |
|
44 { |
|
45 |
|
46 //----------------------------------------------------------------------- |
|
47 protected: /* Construction */ |
|
48 |
|
49 /** |
|
50 * C++ constructor. |
|
51 */ |
|
52 CPEngTrackedPresenceID2( CPEngTrackedPresenceIDEntry& aImp ); |
|
53 |
|
54 |
|
55 /** |
|
56 * Destructor. |
|
57 */ |
|
58 ~CPEngTrackedPresenceID2(); |
|
59 |
|
60 |
|
61 |
|
62 |
|
63 //----------------------------------------------------------------------- |
|
64 public: /* Tracked presence data */ |
|
65 |
|
66 |
|
67 /** |
|
68 * Tracked presence ID. |
|
69 * |
|
70 * @since 3.0 |
|
71 * @return Tracked presence ID. |
|
72 */ |
|
73 IMPORT_C TPtrC PresenceID() const; |
|
74 |
|
75 |
|
76 |
|
77 |
|
78 //----------------------------------------------------------------------- |
|
79 public: /* Iterators for tracked attributes */ |
|
80 |
|
81 /** |
|
82 * Gets first tracked presence attribute |
|
83 * for the Presence ID. Tracked attributes are |
|
84 * kept in unsigned key order. |
|
85 * |
|
86 * @since 3.0 |
|
87 * @return First tracked presence attribute. |
|
88 * If there isn't any tracked attributes, returns |
|
89 * KPEngNullAttributeType. |
|
90 */ |
|
91 IMPORT_C TUint32 FirstTrackedAttribute(); |
|
92 |
|
93 |
|
94 |
|
95 /** |
|
96 * Gets next tracked presence attribute |
|
97 * for the Presence ID. |
|
98 * |
|
99 * @since 3.0 |
|
100 * @return Next tracked presence attribute. |
|
101 * If there isn't any more tracked attributes, |
|
102 * returns KPEngNullAttributeType. |
|
103 */ |
|
104 IMPORT_C TUint32 NextTrackedAttribute(); |
|
105 |
|
106 |
|
107 |
|
108 /** |
|
109 * Resets the tracked attribute iterator to its |
|
110 * initial state, so the a subsequent call to |
|
111 * NextTrackedAttribute() method go to the first |
|
112 * tracked item. |
|
113 */ |
|
114 IMPORT_C void ResetTrackedIterator(); |
|
115 |
|
116 |
|
117 |
|
118 |
|
119 //----------------------------------------------------------------------- |
|
120 public: /* Iterators for changed attributes */ |
|
121 |
|
122 |
|
123 /** |
|
124 * Gets first changed presence attribute for the |
|
125 * Presence ID. Changed attributes are kept |
|
126 * in unsigned key order. |
|
127 * |
|
128 * Changed attributes are available only |
|
129 * after presence change notification. |
|
130 * |
|
131 * @since 3.0 |
|
132 * @return First changed presence attribute. |
|
133 * If there isn't any changed attributes, returns |
|
134 * KPEngNullAttributeType. |
|
135 */ |
|
136 IMPORT_C TUint32 FirstChangedAttribute(); |
|
137 |
|
138 |
|
139 |
|
140 /** |
|
141 * Gets next changed presence attribute |
|
142 * for the Presence ID. |
|
143 * |
|
144 * Changed attributes are available only |
|
145 * after presence change notification. |
|
146 * |
|
147 * @since 3.0 |
|
148 * @return Next changed presence attribute. |
|
149 * If there isn't any more changed attributes, |
|
150 * returns KPEngNullAttributeType. |
|
151 */ |
|
152 IMPORT_C TUint32 NextChangedAttribute(); |
|
153 |
|
154 |
|
155 |
|
156 /** |
|
157 * Resets the changed attribute iterator to its |
|
158 * initial state, so the a subsequent call to |
|
159 * NextChangedAttribute() method go to the first |
|
160 * changed item. |
|
161 * |
|
162 * @since 3.0 |
|
163 */ |
|
164 IMPORT_C void ResetChangedIterator(); |
|
165 |
|
166 |
|
167 |
|
168 //----------------------------------------------------------------------- |
|
169 private: /* Data */ |
|
170 |
|
171 |
|
172 /** |
|
173 * Implementation is friend. |
|
174 * @since 3.0 |
|
175 */ |
|
176 friend class CPEngTrackedPresenceIDEntry; // CSI: 36 # |
|
177 |
|
178 |
|
179 //REF: Implementation |
|
180 CPEngTrackedPresenceIDEntry& iImp; |
|
181 |
|
182 //OWN: Iterator index |
|
183 TInt iNextTrackedAttributeIx; |
|
184 |
|
185 //OWN: Iterator index |
|
186 TInt iNextChangedAttributeIx; |
|
187 |
|
188 }; |
|
189 |
|
190 #endif //__CPENGTRACKEDPRESENCEID2_H |
|
191 |
|
192 |
|
193 //End of file |
|
194 |
|
195 |
|
196 |
|
197 |
|
198 |