homescreensrv_plat/sapi_homescreenplugin/inc/hspsprovider.h
changeset 0 79c6a41cd166
child 1 844b978f8d5e
equal deleted inserted replaced
-1:000000000000 0:79c6a41cd166
       
     1 /*
       
     2 * Copyright (c) 2008 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:  Defination of class CHSPSProvider
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef C_CHSPSPROVIDER_H
       
    20 #define C_CHSPSPROVIDER_H
       
    21 
       
    22 #include <LiwCommon.h>
       
    23 #include <LiwServiceIfBase.h>
       
    24 
       
    25 /**
       
    26 * @ingroup group_hsps_sapi
       
    27 * Provides implementation to HSPS SAPI provider
       
    28 *
       
    29 **/
       
    30 NONSHARABLE_CLASS( CHSPSProvider ) : public CLiwServiceIfBase
       
    31     {
       
    32     public:
       
    33         static CHSPSProvider* NewL();
       
    34 
       
    35 
       
    36         // CLiwServiceIfBase member functions
       
    37         /**
       
    38         * Called by the LIW framework to initialise necessary information 
       
    39         * from the Service Handler. This method is called when the consumer makes 
       
    40         * the attach operation.
       
    41         *
       
    42         * @param aFrameworkCallback Framework provided callback for provider to send 
       
    43         *                           events to framework.
       
    44         * @param aInterest List of criteria items which invoked the provider.
       
    45         */
       
    46         void InitialiseL( 
       
    47             MLiwNotifyCallback& aFrameworkCallback, 
       
    48             const RCriteriaArray& aInterest );
       
    49 
       
    50         /**
       
    51         * Called by the LIW framework to instantiate the requested interface
       
    52         *
       
    53         * @param aCmdId Command to be executed.
       
    54         * @param aInParamList Input parameters, can be an empty list.
       
    55         * @param aOutParamList Output parameters, can be an empty list.
       
    56         * @param aCmdOptions Options for the command, see KLiwOpt* in LiwCommon.hrh.
       
    57         * @param aCallback Callback for asynchronous command handling, parameter checking, etc.
       
    58         * @leave KErrArgument Callback is missing when required.
       
    59         * @leave KErrNotSupported No provider supports service.
       
    60         */
       
    61         void HandleServiceCmdL( 
       
    62             const TInt& aCmdId, 
       
    63             const CLiwGenericParamList& aInParamList,
       
    64             CLiwGenericParamList& aOutParamList,
       
    65             TUint aCmdOptions = 0,
       
    66             const MLiwNotifyCallback* aCallback = NULL );
       
    67 
       
    68     private:
       
    69         /**
       
    70         * Constructor.
       
    71         */
       
    72         CHSPSProvider();
       
    73 
       
    74     };
       
    75 
       
    76 #endif C_CHSPSPROVIDER_H