1 /*

     2 * Copyright (c) 2004 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:  Control step driver.

    15 *

    16 */

    17 

    18 #ifndef __CCNUICNTRLSTEPDRIVER_H

    19 #define __CCNUICNTRLSTEPDRIVER_H

    20 

    21 //  INCLUDES

    22 #include <E32Base.h>

    23 

    24 

    25 // FORWARD DECLARATIONS

    26 class MCnUiCntrlStep;

    27 

    28 

    29 

    30 // CLASS DECLARATION

    31 /**

    32  * Control step driver.

    33  * Implements step execution behaviour

    34  * as desribed in MCnUiCntrlStep.

    35  *

    36  * @since 2.1

    37  */

    38 NONSHARABLE_CLASS( CCnUiCntrlStepDriver ) : public CBase

    39     {

    40 public:  // Two-phased constructors and destructor

    41 

    42     /**

    43      * Two-phased constructor.

    44      */

    45     static CCnUiCntrlStepDriver* NewL();

    46 

    47     /**

    48      * Two-phased constructor.

    49      */

    50     static CCnUiCntrlStepDriver* NewLC();

    51 

    52     /**

    53      * Destructor.

    54      */

    55     ~CCnUiCntrlStepDriver();

    56 

    57 protected: //Protected constructors to allow derivation

    58 

    59     /**

    60      * C++ constructor.

    61      */

    62     CCnUiCntrlStepDriver();

    63 

    64 

    65 

    66 public: // New methods

    67 

    68 

    69     /**

    70      * Appends new step to que of executed steps.

    71      * New step is appended after existing ones.

    72      * AppendStepL() takes ownership of

    73      * given aStep if operation fully succeeds.

    74      *

    75      * @since 2.1

    76      * @param aStep New control step to add

    77      * Parameter aStep may not be NULL, or

    78      * EIMPSConn_NULLPtr panic is raised.

    79      */

    80     void AppendStepL( MCnUiCntrlStep* aStep );

    81 

    82 

    83     /**

    84      * Executes the added steps.

    85      * For more information about execution

    86      * behaviour, see MCnUiCntrlStep.

    87      *

    88      * Driver must have at least one

    89      * step added before it can be executed.

    90      * In other case, EIMPSConnStepDriverUninitialized

    91      * panic is raised.

    92      *

    93      * @see MCnUiCntrlStep

    94      * @since 2.1

    95      * @return Execution status.

    96      * This is the error value returned

    97      * from last run RunStepL().

    98      */

    99     TInt ExecuteL();

   100 

   101 

   102 

   103 private: //Data

   104 

   105     ///<Steps to execute. Array & steps owned.

   106     RPointerArray< MCnUiCntrlStep >   iSteps;

   107 

   108     };

   109 

   110 #endif      //__CCNUICNTRLSTEPDRIVER_H

   111 //  End of File

   112 

   113