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: This file contains the header file of the 

    15 * CUIEngineRemote.

    16 *

    17 */

    18 

    19 

    20 #ifndef STIF_TFW_IF_REMOTE_H

    21 #define STIF_TFW_IF_REMOTE_H

    22 

    23 

    24 //  INCLUDES

    25 #include <e32std.h>

    26 #include <e32base.h>

    27 #include <stifinternal/UIEngineContainer.h>

    28 

    29 // CONSTANTS

    30 // None

    31 

    32 // MACROS

    33 // None

    34 

    35 // DATA TYPES

    36 // None

    37 

    38 // FUNCTION PROTOTYPES

    39 // None

    40 

    41 

    42 // FORWARD DECLARATIONS

    43 // None

    44 

    45 

    46 // CLASS DECLARATION

    47 

    48 

    49 // DESCRIPTION

    50 

    51 // CUIEngineRemote is a class that is used for remote protocol 

    52 // forwarding.

    53 class CUIEngineRemote

    54         :public CActive

    55     {

    56     public: // Enumerations

    57         // None

    58 

    59     private: // Enumerations

    60         enum TRemoteStatus

    61             {

    62             EIdle,

    63             EPending,

    64             EUIMsgPending,

    65             };

    66 

    67     public: // Constructors and destructor

    68 

    69         /**

    70         * NewL is two-phased constructor.

    71         */

    72         static CUIEngineRemote* NewL( CUIEngineContainer* aUIEngineContainer );

    73 

    74         /**

    75         * Destructor of CUIEngineRemote.

    76         */

    77         ~CUIEngineRemote();

    78 

    79     public: // New functions

    80 

    81         /**

    82         * StartL starts testing.

    83         */

    84         void StartL( RTestCase& aTestCase );

    85 

    86     public: // Functions from base classes

    87 

    88         /**

    89         * From CActive RunL handles request completion.

    90         */

    91         void RunL();

    92 

    93         /**

    94         * From CActive DoCancel handles request cancellation.

    95         */

    96         void DoCancel();

    97         /**

    98         * RunError derived from CActive handles errors from active object 

    99         * handler.

   100         */        

   101         TInt RunError(TInt aError);

   102 

   103     protected: // New functions

   104         // None

   105 

   106     protected: // Functions from base classes

   107         // None

   108 

   109     private: // New functions

   110 

   111         /** 

   112         * C++ default constructor.

   113         */

   114         CUIEngineRemote( CUIEngineContainer* aUIEngineContainer);

   115 

   116         /**

   117         * By default Symbian OS constructor is private.

   118         */

   119         void ConstructL();

   120 

   121 

   122         /**

   123         * Start request.

   124         */

   125         void Start();

   126 

   127     public: //Data

   128         // None

   129     

   130     protected: // Data

   131         // None

   132 

   133     private: // Data

   134 

   135         // Pointer to UIEngine

   136         CUIEngineContainer*             iUIEngineContainer;

   137 

   138         // Handle to Test Case

   139         RTestCase                       iTestCase;

   140         

   141         // Protocol message type

   142         TStifCommand                    iRemoteType;

   143         TStifCommandPckg                iRemoteTypePckg;

   144 

   145         // Protocol message length

   146         TInt                            iMsgLen;

   147         TPckg<TInt>                     iMsgLenPckg;

   148 

   149         TRemoteStatus                   iState;

   150     public: // Friend classes

   151         // None

   152 

   153     protected: // Friend classes

   154         // None

   155 

   156     private: // Friend classes

   157         // None

   158 

   159     };

   160 

   161 

   162 

   163 #endif // STIF_TFW_IF_REMOTE_H

   164 

   165 // End of File