1 /*

     2 * ============================================================================

     3 *  Name        : bctestdomaiwserviceifmenu.h

     4 *  Part of     : BCTest / bctestdomaiwakn       

     5 *  Description : for testing CAiwServiceIfMenu and CAiwServiceIfBase

     6 *  Version     : %version: 1 % << Don't touch! Updated by Synergy at check-out.

     7 *

     8 *  Copyright © 2007.  All rights reserved.

     9 *  This material, including documentation and any related computer

    10 *  programs, is protected by copyright controlled by Nokia.  All

    11 *  rights are reserved.  Copying, including reproducing, storing,

    12 *  adapting or translating, any or all of this material requires the

    13 *  prior written consent of Nokia.  This material also contains

    14 *  confidential information which may not be disclosed to others

    15 *  without the prior written consent of Nokia.

    16 * ============================================================================

    17 * Template version: 4.2

    18 */

    19 

    20 #ifndef C_CBCTESTDOMAIWSERVICEIFMENU_H

    21 #define C_CBCTESTDOMAIWSERVICEIFMENU_H

    22 

    23 

    24 #include <aiwserviceifmenu.h> 

    25  

    26 

    27 /**

    28  *  test CAiwServiceIfMenu and CAiwServiceIfBase.

    29  *  

    30  *

    31  *  @code

    32  *    

    33  *  @endcode

    34  *

    35  *  @lib   

    36  *  @since S60 v5.0

    37  */ 

    38 class CBCTestDomAiwServiceIfMenu : public CAiwServiceIfMenu

    39     {

    40 

    41 

    42 public:

    43 

    44     IMPORT_C static CBCTestDomAiwServiceIfMenu* NewL();

    45 

    46     IMPORT_C static CBCTestDomAiwServiceIfMenu* NewLC();

    47 

    48     /**

    49      * Destructor.

    50      */

    51     IMPORT_C virtual ~CBCTestDomAiwServiceIfMenu();

    52 

    53     /**

    54      * test ExtensionInterface

    55      *  

    56      * @since S60 v5.0       

    57      */

    58     void TestFuncExtensionInterface() ;

    59 

    60 // from base class CAiwServiceIfBase  

    61     /**

    62      * From CAiwServiceIfBase.      

    63      * Called by the AIW framework to initialise provider with necessary

    64      * information from the Service Handler. This method is called when 

    65      * the consumer makes the attach operation.

    66      *

    67      * @since S60 v5.0       

    68      * @param aFrameworkCallback Framework provided callback for provider 

    69      *                  to send events to framework.

    70      * @param aInterest List of criteria items which invoked the provider.

    71      */

    72      virtual void InitialiseL(

    73          MAiwNotifyCallback& aFrameworkCallback,

    74          const RCriteriaArray& aInterest) ;

    75      

    76     /**

    77      * From CAiwServiceIfBase.      

    78      * Executes generic service commands included in criteria.

    79      *

    80      * @since S60 v5.0       

    81      * @param aCmdId Command to be executed.

    82      * @param aInParamList Input parameters, can be an empty list.

    83      * @param aOutParamList Output parameters, can be an empty list.

    84      * @param aCmdOptions Options for the command, see KAiwOpt* in 

    85      *        AiwCommon.hrh.

    86      * @param aCallback Callback for asynchronous command handling, 

    87      *        parameter checking, etc.

    88      * @leave KErrArgument Callback is missing when required.

    89      * @leave KErrNotSupported No provider supports service.

    90      */

    91      virtual void HandleServiceCmdL(

    92          const TInt& aCmdId,

    93          const CAiwGenericParamList& aInParamList,

    94          CAiwGenericParamList& aOutParamList,

    95          TUint aCmdOptions = 0,

    96          const MAiwNotifyCallback* aCallback = NULL) ;

    97     

    98 // from base class CAiwServiceIfMenu    

    99      

   100     /**

   101      * From CAiwServiceIfMenu.    

   102      * Provider should implement this method to initialise a menu pane by 

   103      * adding provider specific menu items. The AIW framework gives the 

   104      * parameters to beused in the addition process.

   105      *

   106      * @since S60 v5.0     

   107      * @param aMenuPane Menu pane handle.

   108      * @param aIndex The position of the item where to add menu items.

   109      * @param aCascadeId ID of cascade menu item.

   110      * @param aInParamList Input parameter list for provider's parameter

   111      *         checking.

   112      */

   113      virtual void InitializeMenuPaneL(

   114          CAiwMenuPane& aMenuPane,

   115          TInt aIndex,

   116          TInt aCascadeId,

   117          const CAiwGenericParamList& aInParamList);

   118 

   119     /**

   120      * From CAiwServiceIfMenu.    

   121      * Provider should implement this method to handle a menu command. 

   122      * Called by the Service Handler when a consumer calls ExecuteMenuCmdL().

   123      *

   124      * @since S60 v5.0     

   125      * @param aMenuCmdId Original provider specific ommand ID for the menu

   126      *              command.Defined in the provider's menu item resource.

   127      * @param aInParamList Input parameters, can be an empty list.

   128      * @param aOutParamList Output parameters, can be an empty list.

   129      * @param aCmdOptions Options for the command, see KAiwCmdOpt* in

   130      *         AiwCommon.hrh.

   131      * @param aCallback Callback if asynchronous command handling is wanted by

   132      *             consumer.The provider may or may not support this. A 

   133      *             provider should leave with KErrNotSupported, if not.

   134      * @leave KErrNotSupported Callback is not supported.

   135      */

   136      virtual void HandleMenuCmdL(

   137          TInt aMenuCmdId,

   138          const CAiwGenericParamList& aInParamList,

   139          CAiwGenericParamList& aOutParamList,

   140          TUint aCmdOptions = 0,

   141          const MAiwNotifyCallback* aCallback = NULL); 

   142         

   143 

   144 private:

   145 

   146     CBCTestDomAiwServiceIfMenu();

   147 

   148     void ConstructL();

   149 

   150     };

   151 

   152 #endif // C_CBCTESTDOMAIWSERVICEIFMENU_H