|
1 /* |
|
2 * Copyright (c) 2002-2005 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: vkb layout pool header file |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 #ifndef C_AKNFEPVKBLAYOUTPOOL_H |
|
20 #define C_AKNFEPVKBLAYOUTPOOL_H |
|
21 |
|
22 // INCLUDES |
|
23 #include <e32base.h> |
|
24 #include <w32std.h> |
|
25 #include <barsread.h> |
|
26 #include <peninputvkbctrllayout.h> |
|
27 |
|
28 // FORWARD DECLARATION |
|
29 class CAknFepCtrlVkbLayout; |
|
30 class CPeninputVkbLayoutInfo; |
|
31 class CAknFepVkbImLayout; |
|
32 |
|
33 /** |
|
34 * vkb layout pool class |
|
35 * |
|
36 * This class is layout pool. Application can use this class to |
|
37 * manage their layout. Layout creates out side and add it to this |
|
38 * pool. Application can get and remove one layout based on layout |
|
39 * id. |
|
40 * |
|
41 * @lib peninputvkbcn.lib |
|
42 * @since S60 v3.2 |
|
43 */ |
|
44 class CAknFepLayoutPool: public CBase |
|
45 { |
|
46 |
|
47 public: |
|
48 |
|
49 /** |
|
50 * Symbian constructor |
|
51 * |
|
52 * @since S60 v3.2 |
|
53 * @return Pointer to created CAknFepLayoutPool object |
|
54 */ |
|
55 static CAknFepLayoutPool* NewL( CAknFepCtrlVkbLayout& aVkbLayout ); |
|
56 |
|
57 /** |
|
58 * Symbian constructor |
|
59 * |
|
60 * @since S60 v3.2 |
|
61 * @return Pointer to created CAknFepLayoutPool object |
|
62 */ |
|
63 static CAknFepLayoutPool* NewLC( CAknFepCtrlVkbLayout& aVkbLayout ); |
|
64 |
|
65 /** |
|
66 * Destructor |
|
67 * |
|
68 * @since S60 v3.2 |
|
69 * @return None |
|
70 */ |
|
71 virtual ~CAknFepLayoutPool(); |
|
72 |
|
73 /** |
|
74 * Add one client layout to the poo |
|
75 * |
|
76 * @since S60 v3.2 |
|
77 * @param aImLayout Pointer to image layout |
|
78 * @return None |
|
79 */ |
|
80 void AddImLayout(CAknFepVkbImLayout* aImLayout); |
|
81 |
|
82 /** |
|
83 * Remove one client layout from the pool based on image layout id |
|
84 * |
|
85 * @since S60 v3.2 |
|
86 * @param aImLayout Image layout id |
|
87 * @return None |
|
88 */ |
|
89 void RemoveImLayout(const TInt aImLayout); |
|
90 |
|
91 /** |
|
92 * Get one client layout from the pool based on image layout id |
|
93 * |
|
94 * @since S60 v3.2 |
|
95 * @param aImLayout image layout id |
|
96 * @return Pointer to image layout |
|
97 */ |
|
98 CAknFepVkbImLayout* GetImLayout(const TInt aImLayout) const; |
|
99 |
|
100 /** |
|
101 * Add one vkb layout to the pooling |
|
102 * |
|
103 * @since S60 v3.2 |
|
104 * @param aVkbLayout Pointer to image layout |
|
105 * @return None |
|
106 */ |
|
107 void AddVkbLayout(CPeninputVkbLayoutInfo* aVkbLayout); |
|
108 |
|
109 /** |
|
110 * Remove one client layout from the pool based on layout id |
|
111 * |
|
112 * @since S60 v3.2 |
|
113 * @param aVkbLayout Vkb layout id |
|
114 * @return None |
|
115 */ |
|
116 void RemoveVkbLayout(const TInt aVkbLayout); |
|
117 |
|
118 /** |
|
119 * Get one vkb layout from the pool based on layout id |
|
120 * |
|
121 * @since S60 v3.2 |
|
122 * @param aVkbLayout Vkb layout id |
|
123 * @return Pointer to vkb layout |
|
124 */ |
|
125 CPeninputVkbLayoutInfo* GetVkbLayout(const TInt aVkbLayout) const; |
|
126 |
|
127 /** |
|
128 * Delete all image layout from the pool |
|
129 * |
|
130 * @since S60 v3.2 |
|
131 * @return None |
|
132 */ |
|
133 void ResetImLayout(); |
|
134 |
|
135 /** |
|
136 * Delete all vkb layout from the pool |
|
137 * |
|
138 * @since S60 v3.2 |
|
139 * @return None |
|
140 */ |
|
141 void ResetVkbLayout(); |
|
142 |
|
143 /** |
|
144 * Delete all vkb and image layout from the pool |
|
145 * |
|
146 * @since S60 v3.2 |
|
147 * @return None |
|
148 */ |
|
149 void Reset(); |
|
150 |
|
151 /** |
|
152 * Get vkb layout array |
|
153 * |
|
154 * @since S60 v3.2 |
|
155 * @return None |
|
156 */ |
|
157 inline RPointerArray<CPeninputVkbLayoutInfo>& VkbLayoutInfoList(); |
|
158 |
|
159 /** |
|
160 * Get image layout array |
|
161 * |
|
162 * @since S60 v3.2 |
|
163 * @return None |
|
164 */ |
|
165 inline RPointerArray<CAknFepVkbImLayout>& ImLayoutList(); |
|
166 |
|
167 protected: |
|
168 |
|
169 /** |
|
170 * C++ default constructor |
|
171 * |
|
172 * @since S60 v3.2 |
|
173 * @return None |
|
174 */ |
|
175 CAknFepLayoutPool(); |
|
176 |
|
177 /** |
|
178 * Contruct from resource |
|
179 * |
|
180 * @since S60 v3.2 |
|
181 * @return None |
|
182 */ |
|
183 void ConstructFromResourceL( CAknFepCtrlVkbLayout& aVkbLayout ); |
|
184 |
|
185 /** |
|
186 * Symbian second-phase constructor |
|
187 * |
|
188 * @since S60 v3.2 |
|
189 * @return None |
|
190 */ |
|
191 void ConstructL( CAknFepCtrlVkbLayout& aVkbLayout ); |
|
192 |
|
193 private: // Data |
|
194 |
|
195 /** |
|
196 * Image layout array |
|
197 */ |
|
198 RPointerArray<CAknFepVkbImLayout> iImLayoutList; |
|
199 |
|
200 /** |
|
201 * Vkb layout array |
|
202 */ |
|
203 RPointerArray<CPeninputVkbLayoutInfo> iVkbLayoutInfoList; |
|
204 |
|
205 }; |
|
206 |
|
207 #include "peninputvkblayoutpool.inl" |
|
208 |
|
209 #endif // C_AKNFEPVKBLAYOUTPOOL_H |
|
210 |
|
211 // End Of File |