1 /*

     2 * Copyright (c) 2005-2007 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:  Phonebook 2 phased service observer interface.

    15 *

    16 */

    17 

    18 

    19 #ifndef MPBK2SERVICEPHASEOBSERVER_H

    20 #define MPBK2SERVICEPHASEOBSERVER_H

    21 

    22 // INCLUDES

    23 #include <e32std.h>

    24 

    25 // FORWARD DECLARATIONS

    26 class MPbk2ServicePhase;

    27 

    28 // CLASS DECLARATION

    29 

    30 /**

    31  * Phonebook 2 phased service observer interface.

    32  */

    33 class MPbk2ServicePhaseObserver

    34     {

    35     public: // Interface

    36 

    37         /**

    38          * Phase complete callback.

    39          * Proceeds to next phase.

    40          *

    41          * @param aPhase    The calling phase.

    42          */

    43         virtual void NextPhase(

    44                 MPbk2ServicePhase& aPhase ) = 0;

    45 

    46         /**

    47          * Phase complete callback.

    48          * Proceeds to previous phase.

    49          *

    50          * @param aPhase    The calling phase.

    51          */

    52         virtual void PreviousPhase(

    53                 MPbk2ServicePhase& aPhase ) = 0;

    54 

    55         /**

    56          * Cancel callback.

    57          *

    58          * @param aPhase    The calling phase.

    59          */

    60         virtual void PhaseCanceled(

    61                 MPbk2ServicePhase& aPhase ) = 0;

    62 

    63         /**

    64          * Abort callback.

    65          *

    66          * @param aPhase    The calling phase.

    67          */

    68         virtual void PhaseAborted(

    69                 MPbk2ServicePhase& aPhase ) = 0;

    70 

    71         /**

    72          * Error callback.

    73          *

    74          * @param aPhase    The calling phase.

    75          * @param aErrorCode    Error code.

    76          */

    77         virtual void PhaseError(

    78                 MPbk2ServicePhase& aPhase,

    79                 TInt aErrorCode ) = 0;

    80 

    81         /**

    82          * Asks a permission to exit.

    83          *

    84          * @param aCommandId    Exit command id.

    85          * @return  ETrue to exit, EFalse to not to exit.

    86          */

    87         virtual TBool PhaseOkToExit(

    88                 MPbk2ServicePhase& aPhase,

    89                 TInt aCommandId ) = 0;

    90 

    91         /**

    92          * Accept callback.

    93          *

    94          * @param aMarkedEntries    Number of marked entries.

    95          * @param aLinkData         Lastly marked contact packed

    96          *                          in contact link buffer.

    97          */

    98         virtual void PhaseAccept(

    99                 MPbk2ServicePhase& aPhase,

   100                 const TDesC8& aMarkedEntries,

   101                 const TDesC8& aLinkData ) = 0;

   102 

   103     protected: // Disabled functions

   104         virtual ~MPbk2ServicePhaseObserver()

   105             {};

   106     };

   107 

   108 #endif // MPBK2SERVICEPHASEOBSERVER_H

   109 

   110 // End of File