1 /*

     2 * Copyright (c) 2009 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: 

    15 *

    16 */

    17 

    18 #ifndef CLCENGINE_H

    19 #define CLCENGINE_H

    20 

    21 // INCLUDES

    22 #include <e32base.h>

    23 

    24 // FORWARD DECLARATIONS

    25 class MLcSession;

    26 

    27 // CONSTANTS

    28 /** Interface UID of this ECOM interface */

    29 const TUid KLcEngineInterfaceUid = { 0x20021340 };

    30 

    31 // CLASS DECLARATION

    32 /**

    33 * A base class for ECom plug-ins implementing

    34 * the Live Comms engine plug-in API. 

    35 */

    36 class CLcEngine : public CBase

    37     {

    38     public: // Enumerations

    39 

    40         /**

    41         * The list of plug-in configurable features.

    42         */

    43         enum TLcFeature

    44             {

    45             ELcShowInvitingNote,

    46             ELcShowWaitingNote,

    47             ELcShowAcceptQuery,

    48             ELcSendVideoQuery

    49             };

    50 

    51     public: // Constructors and destructor

    52     

    53         /**

    54         * Loads and creats an instance of the plug-in.

    55         * @param aEngineName used in finding the correct implementation.

    56         * Matched to the IMPLEMENTATION_INFO / default_data of the plug-in.

    57         * @return a new instance of CLcEngine, the ownership is transferred

    58         */

    59         inline static CLcEngine* NewL( const TDesC8& aEngineName );

    60     

    61         /**

    62         * Destructor

    63         */

    64         inline ~CLcEngine();

    65 

    66     public: // New pure virtual functions

    67     

    68         /**

    69         * Returns a reference to the session created by the plug-in.

    70         * @return the session

    71         */

    72         virtual MLcSession& Session() = 0;

    73 

    74     public: // New virtual functions    

    75         

    76         /**

    77         * Checks if a feature should be used with the particular engine.

    78         * @param aLcFeature the identifier of the feature

    79         * @return ETrue if the feature is supported, otherwise EFalse.

    80         */

    81         inline virtual TBool IsFeatureSupported( TLcFeature aLcFeature );

    82 

    83     protected: // Constructors

    84 

    85         inline CLcEngine();

    86     

    87     public: // Data

    88 

    89         TUid iInstanceKey;

    90     };

    91 

    92 #include "lcengine.inl"    

    93     

    94 #endif // CLCENGINE_H

    95 

    96 // end of file