phoneapp/phoneuicontrol/inc/tphonetransitionhandler.h
branchRCL_3
changeset 81 c26cc2a7c548
parent 73 e30d4a1b8bad
child 82 b49b5af297a7
equal deleted inserted replaced
73:e30d4a1b8bad 81:c26cc2a7c548
     1 /*
       
     2 * Copyright (c) 2010 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: Class handles phoneapp internal/external transitions.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef TPHONETRANSITIONHANDLER_H
       
    20 #define TPHONETRANSITIONHANDLER_H
       
    21 
       
    22 //INCLUDES
       
    23 #include <e32base.h>
       
    24 #include "mphoneviewcommandhandle.h"
       
    25 #include "tphonecmdparamtranseffect.h"
       
    26 
       
    27 class CPhoneState;
       
    28 
       
    29 /**
       
    30  * Class handles phoneapp internal/external transitions.
       
    31  *
       
    32  * @lib phoneuicontrol
       
    33  * @since S60 v9.2
       
    34  */
       
    35 class TPhoneTransitionHandler
       
    36     {
       
    37     public:
       
    38         /**
       
    39         * default constructor.
       
    40         */
       
    41         TPhoneTransitionHandler(
       
    42                 CPhoneState& aState,
       
    43                 MPhoneViewCommandHandle& aViewCommandHandle );
       
    44         
       
    45         /**
       
    46         * Informs view to start Transition effect if effect
       
    47         * type is feasible for current state.
       
    48         * @param aType a transition effect, default none
       
    49         * EndTransEffect() must be called when update is done.
       
    50         */
       
    51         IMPORT_C void BeginTransEffectLC( TPhoneTransEffectType aType = EPhoneTransEffectNone );
       
    52 
       
    53         /**
       
    54         * Informs view to complete Transition effect
       
    55         */
       
    56         IMPORT_C void EndTransEffect();
       
    57         
       
    58         /**
       
    59         * Informs view that UI is being updated (call bubble or number editor).
       
    60         * EndUiUpdate() must be called when update is done.
       
    61         */
       
    62         IMPORT_C void BeginUiUpdateLC();
       
    63        
       
    64         /**
       
    65         * Informs view that UI update is completed.
       
    66         */
       
    67         IMPORT_C void EndUiUpdate();
       
    68         
       
    69         /**
       
    70         * Informs view that UI is being updated (call bubble or number editor).
       
    71         * EndUiUpdate() must be called when update is done.
       
    72         */
       
    73         IMPORT_C void IncomingCallUiUpdateLC();
       
    74       
       
    75         /**
       
    76         * Informs view that UI is being updated (call bubble or number editor).
       
    77         * EndUiUpdate() must be called when update is done.
       
    78         */
       
    79         IMPORT_C void IdleCallUiUpdateLC();
       
    80        
       
    81         /**
       
    82         * Informs view that UI update is completed.
       
    83         */
       
    84         IMPORT_C void EndUiUpdateAndEffect();
       
    85         
       
    86     private:
       
    87         
       
    88         /**
       
    89         * TCleanupOperation to call EndUiUpdate(), if leave occurs
       
    90         * after BeginUiUpdate().
       
    91         */
       
    92         static void UiUpdateCleanup(TAny* aThis );
       
    93 
       
    94         /**
       
    95         * TCleanupOperation to call EndTransEffect, if leave occurs
       
    96         * after BeginTransEffect().
       
    97         */
       
    98         static void EffectCleanup(TAny* aThis );
       
    99         
       
   100     private:
       
   101             
       
   102         // Not owned:
       
   103         CPhoneState& iState;
       
   104         MPhoneViewCommandHandle& iViewCommandHandle;
       
   105     };
       
   106 
       
   107 
       
   108 #endif // TPHONETRANSITIONHANDLER_H