vtengines/videoteleng/Inc/Extensions/CVtEngExtensionBase.h
changeset 0 ed9695c8bcbe
equal deleted inserted replaced
-1:000000000000 0:ed9695c8bcbe
       
     1 /*
       
     2 * Copyright (c) 2006 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:  Videoteleng extension base class 
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef CVTENGEXTENSIONSBASE_H
       
    20 #define CVTENGEXTENSIONSBASE_H
       
    21 
       
    22 //  INCLUDES
       
    23 #include <e32base.h>
       
    24 #include "vtengcommands.h"
       
    25 
       
    26 // FORWARD DECLARATIONS
       
    27 class CVtEngOperation;
       
    28 
       
    29 // CLASS DECLARATION
       
    30 
       
    31 /**
       
    32 *  Videoteleng extension base class.
       
    33 *
       
    34 *  @lib videoteleng.lib
       
    35 *  @since S60 v3.2
       
    36 */
       
    37 NONSHARABLE_CLASS ( CVtEngExtensionBase ): public CBase
       
    38     
       
    39     {
       
    40     public: // pure virtuals.
       
    41         
       
    42         /**
       
    43         * Returns extension API interface 
       
    44         * @return API IF as TAny pointer
       
    45         */
       
    46         virtual TAny* GetInterface() = 0;
       
    47         
       
    48         /**
       
    49         * Handles requested extension operation
       
    50         * @param aOp requested operation pointer
       
    51         * @return TBool if operation succeed or not 
       
    52         */
       
    53         virtual TBool HandleL( CVtEngOperation* aOp ) = 0;
       
    54         
       
    55         /**
       
    56         * Validates requested extension command
       
    57         * @param aCommandId requested command identifier (TInt)
       
    58         * @return TBool if command is valid or not 
       
    59         */
       
    60         virtual TBool ValidateCommand( const TVtEngCommandId aCommandId ) = 0;
       
    61         
       
    62         /**
       
    63         * Gets extension UID
       
    64         * @return extension UID
       
    65         */
       
    66         const TUid& Uid() const;
       
    67         
       
    68     protected:// Constructor.
       
    69         /*
       
    70         * C++ default constructor.
       
    71         */        
       
    72         CVtEngExtensionBase( TUid aExtensionUid );
       
    73     
       
    74     private:
       
    75         
       
    76         // Extension UID 
       
    77         const TUid iExtensionUid;
       
    78     };
       
    79         
       
    80 #endif //CVTENGEXTENSIONSBASE_H