|
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: NWSessionSlotEvent |
|
15 * |
|
16 */ |
|
17 |
|
18 #ifndef __CPENGNWSESSIONSLOTEVENT2_H |
|
19 #define __CPENGNWSESSIONSLOTEVENT2_H |
|
20 |
|
21 // INCLUDES |
|
22 #include <E32Base.h> |
|
23 #include <PEngPresenceEngineConsts2.h> |
|
24 |
|
25 |
|
26 // FORWARD DECLARATIONS |
|
27 class CPEngNWSessionSlotEvent2Copy; |
|
28 class CPEngNWSessionSlotEventEntry; |
|
29 class CPEngNWSessionSlotID2; |
|
30 |
|
31 |
|
32 |
|
33 // CLASS DECLARATION |
|
34 /** |
|
35 * NWSessionSlotEvent. |
|
36 * |
|
37 * Presents the NWSessionSlotEvent. |
|
38 * |
|
39 * @lib PEngManager2.lib |
|
40 * @since 3.0 |
|
41 */ |
|
42 class CPEngNWSessionSlotEvent2 : public CBase |
|
43 { |
|
44 //----------------------------------------------------------------------- |
|
45 protected: /* Construction */ |
|
46 CPEngNWSessionSlotEvent2(); |
|
47 ~CPEngNWSessionSlotEvent2(); |
|
48 |
|
49 |
|
50 |
|
51 public: // Cloning support |
|
52 |
|
53 /** |
|
54 * Creates a new deep copy from NWSessionSlotEvent object. |
|
55 * |
|
56 * Creates a deep copy from NWSessionSlotEvent object and |
|
57 * returns it ownership to client. Created object is placed |
|
58 * on the CleanupStack. |
|
59 * |
|
60 * Created copy is derived from CPEngNWSessionSlotEvent2Copy |
|
61 * interface to allow client to delete created object. |
|
62 * |
|
63 * @since 3.0 |
|
64 * @return New copy from CPEngNWSessionSlotEvent2. |
|
65 * Ownership of created object is returned to calling client. |
|
66 */ |
|
67 IMPORT_C CPEngNWSessionSlotEvent2Copy* CloneLC() const; |
|
68 |
|
69 |
|
70 |
|
71 //----------------------------------------------------------------------- |
|
72 public: /* NWSessionSlotEvent data */ |
|
73 |
|
74 |
|
75 /** |
|
76 * NWSessionSlotID. |
|
77 * ID of changed NWSessionSlot. |
|
78 * |
|
79 * @since 3.0 |
|
80 * @return NWSessionSlotID. |
|
81 */ |
|
82 IMPORT_C const CPEngNWSessionSlotID2& NWSessionSlotID() const; |
|
83 |
|
84 |
|
85 /** |
|
86 * The event. |
|
87 * |
|
88 * @since 3.0 |
|
89 * @return The event |
|
90 */ |
|
91 IMPORT_C TPEngNWSessionSlotEvent Event() const; |
|
92 |
|
93 |
|
94 /** |
|
95 * The NWSessionSlot state after event. |
|
96 * This is the AppID specific state. |
|
97 * (Compare to CSPSessionState() ) |
|
98 * |
|
99 * @since 3.0 |
|
100 * @return NWSessionSlot state after event. |
|
101 */ |
|
102 IMPORT_C TPEngNWSessionSlotState NWSessionSlotState() const; |
|
103 |
|
104 |
|
105 /** |
|
106 * The CSP session state after event. |
|
107 * This is global CSP session state. |
|
108 * |
|
109 * @since 3.0 |
|
110 * @return CSP session state after event. |
|
111 */ |
|
112 IMPORT_C TPEngNWSessionSlotState CSPSessionState() const; |
|
113 |
|
114 |
|
115 /** |
|
116 * Additional event integer. |
|
117 * Content depends from actual TPEngNWSessionSlotEvent. |
|
118 * |
|
119 * @since 3.0 |
|
120 * @return Additional event integer. |
|
121 */ |
|
122 IMPORT_C TInt EventInt() const; |
|
123 |
|
124 |
|
125 /** |
|
126 * Additional event descriptor. |
|
127 * Content meaning depends from actual TPEngNWSessionSlotEvent event |
|
128 * and EventInt. |
|
129 * |
|
130 * @since 3.0 |
|
131 * @return Additional event descriptor. |
|
132 */ |
|
133 IMPORT_C TPtrC EventDesc16() const; |
|
134 |
|
135 |
|
136 |
|
137 //----------------------------------------------------------------------- |
|
138 public: /* Non exported access to implementation */ |
|
139 |
|
140 /** |
|
141 * Presence Engine internal access |
|
142 * to CPEngNWSessionSlotEvent2 implementation. |
|
143 * |
|
144 * @return Implementation. |
|
145 */ |
|
146 CPEngNWSessionSlotEventEntry* Implementation(); |
|
147 const CPEngNWSessionSlotEventEntry* Implementation() const; |
|
148 |
|
149 |
|
150 |
|
151 //----------------------------------------------------------------------- |
|
152 protected: /* Data */ |
|
153 |
|
154 |
|
155 //OWN: Implementation |
|
156 CPEngNWSessionSlotEventEntry* iImp; |
|
157 |
|
158 }; |
|
159 |
|
160 |
|
161 |
|
162 |
|
163 /** |
|
164 * This interface offers possibility to client to |
|
165 * control cloned CPEngNWSessionSlotEvent2 object |
|
166 * lifetime. |
|
167 * |
|
168 * @since 3.0 |
|
169 */ |
|
170 class CPEngNWSessionSlotEvent2Copy : public CPEngNWSessionSlotEvent2 |
|
171 { |
|
172 public: /* Construction */ |
|
173 |
|
174 /** |
|
175 * Instantiates CPEngNWSessionSlotEvent2 object. |
|
176 * |
|
177 * @return New CPEngNWSessionSlotEvent2 instance. |
|
178 */ |
|
179 static CPEngNWSessionSlotEvent2Copy* NewL(); |
|
180 |
|
181 |
|
182 /** |
|
183 * Destructor. |
|
184 * Virtual by CBase. |
|
185 */ |
|
186 ~CPEngNWSessionSlotEvent2Copy(); |
|
187 |
|
188 |
|
189 |
|
190 protected: /* Construction */ |
|
191 |
|
192 CPEngNWSessionSlotEvent2Copy(); |
|
193 }; |
|
194 |
|
195 |
|
196 |
|
197 |
|
198 #endif // __CPENGNWSESSIONSLOTEVENT2_H |
|
199 |
|
200 // End of File |
|
201 |
|
202 |