1.1 --- a/epoc32/include/mw/aiwservicehandler.h Wed Mar 31 12:27:01 2010 +0100
1.2 +++ b/epoc32/include/mw/aiwservicehandler.h Wed Mar 31 12:33:34 2010 +0100
1.3 @@ -2,9 +2,9 @@
1.4 * Copyright (c) 2003-2005 Nokia Corporation and/or its subsidiary(-ies).
1.5 * All rights reserved.
1.6 * This component and the accompanying materials are made available
1.7 -* 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
1.8 +* under the terms of "Eclipse Public License v1.0"
1.9 * which accompanies this distribution, and is available
1.10 -* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
1.11 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.12 *
1.13 * Initial Contributors:
1.14 * Nokia Corporation - initial contribution.
1.15 @@ -25,7 +25,7 @@
1.16
1.17 // INCLUDES
1.18 #include <barsread.h>
1.19 -#include <aiwcommon.h>
1.20 +#include <AiwCommon.h>
1.21
1.22 // CONSTANTS
1.23
1.24 @@ -211,7 +211,7 @@
1.25 TInt aMenuResourceId,
1.26 TInt aBaseMenuCmdId,
1.27 const CAiwGenericParamList& aInParamList);
1.28 -
1.29 +
1.30 /**
1.31 * Initialises menu pane with service commands from a provider.
1.32 * This method must be called upon DynInitMenuPaneL of consumer
1.33 @@ -243,6 +243,38 @@
1.34 TBool aUseSubmenuTextsIfAvailable);
1.35
1.36 /**
1.37 + * Initialises menu pane with service commands from a provider.
1.38 + * This method must be called upon DynInitMenuPaneL of consumer
1.39 + * application in order to let the provider to hook its menu items.
1.40 + * In normal circumstances, the other variant of this method should be used.
1.41 + *
1.42 + * @since S60 3.1
1.43 + * @param aMenuPane Handle of the menu pane to initialise.
1.44 + * @param aMenuResourceId The menu to be attached.
1.45 + * @param aBaseMenuCmdId Base ID for the Service Handler to generate
1.46 + * menu IDs for placeholders.
1.47 + * @param aInParamList Input parameter list for provider's parameters checking.
1.48 + * @param aUseSubmenuTextsIfAvailable If the provider has specified alternative submenu
1.49 + * texts for its menu items, those can be taken into use if this
1.50 + * parameter is set to ETrue. This should be used only for manually
1.51 + * created submenus. If using AIW_CASCADE_ID or
1.52 + * AIW_INTELLIGENT_CASCADE_ID, the AIW framework can automatically
1.53 + * decide whether to use the submenu texts or not, and this parameter
1.54 + * has no effect.
1.55 + * @param aSetAsItemSpecific Added commands are marked as item specific.
1.56 + * @leave KErrNotSupported CCoeEnv is not accessible.
1.57 + * @leave KErrOverflow Consumer application has too many AIW placeholders in its menu.
1.58 + * Currently, maximum 16 is supported.
1.59 + */
1.60 + IMPORT_C void InitializeMenuPaneL(
1.61 + CEikMenuPane& aMenuPane,
1.62 + TInt aMenuResourceId,
1.63 + TInt aBaseMenuCmdId,
1.64 + const CAiwGenericParamList& aInParamList,
1.65 + TBool aUseSubmenuTextsIfAvailable,
1.66 + TBool aSetAsItemSpecific);
1.67 +
1.68 + /**
1.69 * Returns the service command ID associated to the menu command. If found, it means
1.70 * that there is a provider which can handle the menu command. Thus the command
1.71 * handling needs to be routed to the provider via ExecuteMenuCmdL.