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:  Avkon TAS default control traverse ECOM plugin interface definition.

    15 *

    16 */

    17 

    18 #ifndef TASTRAVERSEPLUGININTERFACE_H_

    19 #define TASTRAVERSEPLUGININTERFACE_H_

    20 

    21 // INCLUDES

    22 #include <e32base.h>

    23 #include <ecom/ecom.h>

    24 #include <e32hashtab.h>

    25 

    26 // FORWARD DECLARATIONS

    27 class CAknTasPluginInterface;

    28 

    29 // CONSTANTS

    30 const static TUid KTasTraversePluginInterfaceUid = { 0x2002A4F2 };

    31 

    32 // MACROS

    33 

    34 // DATA TYPES

    35 

    36 // FUNCTION PROTOTYPES

    37 

    38 // FORWARD DECLARATIONS

    39 class MTasObject;

    40 

    41 // CLASS DECLARATION

    42 

    43 /**

    44 *  Avkon traverse ECom plugin interface definition class.

    45 *  It provides ECom interface instantiation and destruction as well as the 

    46 *  interface for services it provides. The concrete implementations are 

    47 *  defined in inherited classes.

    48 */

    49 class CTasTraversePluginInterface : public CBase

    50     {

    51     public:

    52         

    53         /**

    54           * @brief Two-phased constructor. 

    55           *

    56           * Creates an instance of a CTasTraversePluginInterface implementation.

    57           * ECom framework is used in finding and creating the suitable 

    58           * implementation by its name. 

    59           *

    60           * @return A new instance of a CTasTraversePluginInterface implementation

    61           */ 

    62          static CTasTraversePluginInterface* NewL( const TDesC8& aTraverseObjectName, CAknTasPluginInterface * aAknTasPluginInterface );

    63     

    64         /**

    65          * @brief Destructor.

    66          */

    67         virtual ~CTasTraversePluginInterface();

    68         

    69         

    70     public:

    71 

    72         /**

    73          * @brief Traverse method for traversing the UI object. 

    74          *

    75          * Reads the UI object information using aPbjectPtr.

    76          * Writes the information into tasObject enabling XML format exports in the upper levels.         

    77          *

    78          * @param tasObject Father object under which the new object is created

    79          * @param aObjectPtr Pointer to the object to be traversed

    80          * @return void

    81          */ 

    82         virtual void TraverseL(MTasObject& tasObject, TAny* aObjectPtr) = 0;

    83         

    84     protected:

    85         CAknTasPluginInterface * iAknTasPluginInterface;

    86         TPtrC8  iAknTasTraverseObjectName;

    87 

    88     private: // Data

    89         

    90         /// Current instance identifier

    91         TUid iImplementation;

    92         

    93     };

    94 

    95 #include <TasTraversePluginInterface.inl>

    96 

    97 #endif /* TASTRAVERSEPLUGININTERFACE_H_ */