1 /* |
|
2 * Copyright (c) 2007 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: This class handles dynamic search label-key pair storing. |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 /*! \def To avoid multiple inclusions |
|
20 */ |
|
21 #ifndef C_SEARCHGETSEARCHKEYS_H |
|
22 #define C_SEARCHGETSEARCHKEYS_H |
|
23 |
|
24 #include <e32base.h> |
|
25 #include <e32cmn.h> |
|
26 #include <ximpbase.h> |
|
27 #include "mossprotocolconnectionmanager.h" |
|
28 |
|
29 /*! \file |
|
30 * \brief Interfaces for the get search key request |
|
31 */ |
|
32 |
|
33 |
|
34 /*! \class CSearchGetSearchKeys csearchgetsearchkeys.h |
|
35 * \brief This class derived from CActive impliments a request |
|
36 * for the get search keys |
|
37 */ |
|
38 class CSearchGetSearchKeys : public CActive |
|
39 { |
|
40 |
|
41 public: |
|
42 |
|
43 /*! \fn |
|
44 * \brief static function to create a new object of this class |
|
45 */ |
|
46 static CSearchGetSearchKeys* NewL( |
|
47 MOSSProtocolConnectionManager& aConnMan, |
|
48 TXIMPRequestId aRequestId ); |
|
49 |
|
50 |
|
51 /*! \fn |
|
52 * \brief Default Constructor for this class |
|
53 */ |
|
54 CSearchGetSearchKeys( |
|
55 MOSSProtocolConnectionManager& aConnMan, |
|
56 TXIMPRequestId aRequestId ); |
|
57 |
|
58 /*! \fn |
|
59 * \brief destructor |
|
60 */ |
|
61 ~CSearchGetSearchKeys(); |
|
62 |
|
63 |
|
64 /*! \brief Function to issue a request, in this case |
|
65 * it is geting search keys |
|
66 */ |
|
67 void GetSearchKeysL(); |
|
68 |
|
69 |
|
70 protected: |
|
71 |
|
72 /*! \fn |
|
73 * \brief Called when a cancel is done on the active object |
|
74 */ |
|
75 void DoCancel(); |
|
76 |
|
77 /*! \fn |
|
78 * \brief Called when the request submitted by this object |
|
79 * is completed |
|
80 */ |
|
81 void RunL(); |
|
82 |
|
83 /*! \fn |
|
84 * \brief Called when the RunL leaves |
|
85 */ |
|
86 TInt RunError( TInt aError ); |
|
87 |
|
88 |
|
89 |
|
90 private: |
|
91 |
|
92 /*! \fn |
|
93 * \brief 2nd phase constructor for this class |
|
94 */ |
|
95 void ConstructL(); |
|
96 |
|
97 /*! \var Data Id generated for the request |
|
98 */ |
|
99 TInt iSendId; |
|
100 |
|
101 |
|
102 /*! \var TXIMPRequestId Request Id |
|
103 * |
|
104 */ |
|
105 TXIMPRequestId iRequestId; |
|
106 |
|
107 /*! \var iConnMan handle to connection manager |
|
108 * This variable is not owned by this class |
|
109 */ |
|
110 MOSSProtocolConnectionManager& iConnMan; |
|
111 |
|
112 }; |
|
113 |
|
114 |
|
115 #endif //C_SEARCHGETSEARCHKEYS_H |
|