1 /* |
1 /* |
2 * Copyright (c) 2003-2005 Nokia Corporation and/or its subsidiary(-ies). |
2 * Copyright (c) 2003-2005 Nokia Corporation and/or its subsidiary(-ies). |
3 * All rights reserved. |
3 * All rights reserved. |
4 * This component and the accompanying materials are made available |
4 * This component and the accompanying materials are made available |
5 * under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members |
5 * under the terms of "Eclipse Public License v1.0" |
6 * which accompanies this distribution, and is available |
6 * which accompanies this distribution, and is available |
7 * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html". |
7 * at the URL "http://www.eclipse.org/legal/epl-v10.html". |
8 * |
8 * |
9 * Initial Contributors: |
9 * Initial Contributors: |
10 * Nokia Corporation - initial contribution. |
10 * Nokia Corporation - initial contribution. |
11 * |
11 * |
12 * Contributors: |
12 * Contributors: |
209 IMPORT_C void InitializeMenuPaneL( |
209 IMPORT_C void InitializeMenuPaneL( |
210 CEikMenuPane& aMenuPane, |
210 CEikMenuPane& aMenuPane, |
211 TInt aMenuResourceId, |
211 TInt aMenuResourceId, |
212 TInt aBaseMenuCmdId, |
212 TInt aBaseMenuCmdId, |
213 const CAiwGenericParamList& aInParamList); |
213 const CAiwGenericParamList& aInParamList); |
214 |
214 |
215 /** |
215 /** |
216 * Initialises menu pane with service commands from a provider. |
216 * Initialises menu pane with service commands from a provider. |
217 * This method must be called upon DynInitMenuPaneL of consumer |
217 * This method must be called upon DynInitMenuPaneL of consumer |
218 * application in order to let the provider to hook its menu items. |
218 * application in order to let the provider to hook its menu items. |
219 * In normal circumstances, the other variant of this method should be used. |
219 * In normal circumstances, the other variant of this method should be used. |
241 TInt aBaseMenuCmdId, |
241 TInt aBaseMenuCmdId, |
242 const CAiwGenericParamList& aInParamList, |
242 const CAiwGenericParamList& aInParamList, |
243 TBool aUseSubmenuTextsIfAvailable); |
243 TBool aUseSubmenuTextsIfAvailable); |
244 |
244 |
245 /** |
245 /** |
|
246 * Initialises menu pane with service commands from a provider. |
|
247 * This method must be called upon DynInitMenuPaneL of consumer |
|
248 * application in order to let the provider to hook its menu items. |
|
249 * In normal circumstances, the other variant of this method should be used. |
|
250 * |
|
251 * @since S60 3.1 |
|
252 * @param aMenuPane Handle of the menu pane to initialise. |
|
253 * @param aMenuResourceId The menu to be attached. |
|
254 * @param aBaseMenuCmdId Base ID for the Service Handler to generate |
|
255 * menu IDs for placeholders. |
|
256 * @param aInParamList Input parameter list for provider's parameters checking. |
|
257 * @param aUseSubmenuTextsIfAvailable If the provider has specified alternative submenu |
|
258 * texts for its menu items, those can be taken into use if this |
|
259 * parameter is set to ETrue. This should be used only for manually |
|
260 * created submenus. If using AIW_CASCADE_ID or |
|
261 * AIW_INTELLIGENT_CASCADE_ID, the AIW framework can automatically |
|
262 * decide whether to use the submenu texts or not, and this parameter |
|
263 * has no effect. |
|
264 * @param aSetAsItemSpecific Added commands are marked as item specific. |
|
265 * @leave KErrNotSupported CCoeEnv is not accessible. |
|
266 * @leave KErrOverflow Consumer application has too many AIW placeholders in its menu. |
|
267 * Currently, maximum 16 is supported. |
|
268 */ |
|
269 IMPORT_C void InitializeMenuPaneL( |
|
270 CEikMenuPane& aMenuPane, |
|
271 TInt aMenuResourceId, |
|
272 TInt aBaseMenuCmdId, |
|
273 const CAiwGenericParamList& aInParamList, |
|
274 TBool aUseSubmenuTextsIfAvailable, |
|
275 TBool aSetAsItemSpecific); |
|
276 |
|
277 /** |
246 * Returns the service command ID associated to the menu command. If found, it means |
278 * Returns the service command ID associated to the menu command. If found, it means |
247 * that there is a provider which can handle the menu command. Thus the command |
279 * that there is a provider which can handle the menu command. Thus the command |
248 * handling needs to be routed to the provider via ExecuteMenuCmdL. |
280 * handling needs to be routed to the provider via ExecuteMenuCmdL. |
249 * |
281 * |
250 * @param aMenuCmdId Menu command ID to be mapped to service cmd. |
282 * @param aMenuCmdId Menu command ID to be mapped to service cmd. |