phoneapp/phoneuiutils/inc/tphonecmdparamtranseffect.h
branchRCL_3
changeset 25 91c2fb4b78df
parent 0 5f000ab63145
child 58 40a3f856b14d
equal deleted inserted replaced
19:544e34b3255a 25:91c2fb4b78df
    35 * EPhoneTransitionEffectStop - TBD 
    35 * EPhoneTransitionEffectStop - TBD 
    36 */
    36 */
    37 enum TPhoneTransEffectType
    37 enum TPhoneTransEffectType
    38     {
    38     {
    39     EPhoneTransEffectNone,
    39     EPhoneTransEffectNone,
       
    40     // These 3 effect types can be used only when dialer is
       
    41     // opened/closed when some other app than phone is visible 
       
    42     // on the foreground/in the background.
       
    43     // These cannot be used for internal transitions (=call ui<->dialer).
    40     EPhoneTransEffectDialerOpen,
    44     EPhoneTransEffectDialerOpen,
    41     EPhoneTransEffectDialerClose,
    45     EPhoneTransEffectDialerClose,
    42     EPhoneTransEffectDialerCreate,
    46     EPhoneTransEffectDialerCreate,
       
    47     // For applying effect to external app launch done from dialer.
       
    48     // Effects triggered by App FW don't work properly.
       
    49     EPhoneTransEffectAppStartFromDialer,
    43     EPhoneTransEffectStop
    50     EPhoneTransEffectStop
    44     };
    51     };
    45 
    52 
    46 // CLASS DECLARATION
    53 // CLASS DECLARATION
    47 
    54 
    48 /**
    55 /**
    49 *  A parameter class for note dialog information.
    56 *  A parameter class for transition effect information.
    50 */
    57 */
    51 class TPhoneCmdParamTransEffect : public TPhoneUICommandParam
    58 class TPhoneCmdParamTransEffect : public TPhoneUICommandParam
    52     {   
    59     {   
    53    
    60 
    54     
       
    55     public: 
    61     public: 
    56            
    62            
    57         /**
    63         /**
    58         * C++ default constructor.
    64         * C++ default constructor.
    59         */
    65         */
    65         * Sets the effect type
    71         * Sets the effect type
    66         * @param aType is the effect type
    72         * @param aType is the effect type
    67         */
    73         */
    68         IMPORT_C void SetType( TPhoneTransEffectType aType );
    74         IMPORT_C void SetType( TPhoneTransEffectType aType );
    69 
    75 
    70  
    76         /**
       
    77         * Sets application uid associated with the effect.
       
    78         * @param    aAppUid, Id of app.
       
    79         * @return   None.
       
    80         */
       
    81         IMPORT_C void SetAppUid( const TUid& aAppUid );
       
    82 
    71         /**
    83         /**
    72         * Returns the effect type
    84         * Returns the effect type
    73         * @return Returns the type
    85         * @return Returns the type
    74         */
    86         */
    75         IMPORT_C TPhoneTransEffectType Type() const;
    87         IMPORT_C TPhoneTransEffectType Type() const;
    76    
    88 
       
    89         /**
       
    90         * Returns App uid associated with the effect.
       
    91         * @param    None.
       
    92         * @return   iAppUid.
       
    93         */
       
    94         IMPORT_C TUid AppUid() const;
       
    95 
    77     private:    
    96     private:    
    78         
    97         
    79         /**
    98         /**
    80         * Note type
    99         * Effect type
    81         */
   100         */
    82         TPhoneTransEffectType iType;
   101         TPhoneTransEffectType iType;
       
   102         
       
   103         /**
       
   104         * App UID
       
   105         */
       
   106         TUid iAppUid;
    83 
   107 
    84     };
   108     };
    85 
   109 
    86 #endif // __TPHONECMDPARAMTRANSEFFECT_H   
   110 #endif // __TPHONECMDPARAMTRANSEFFECT_H   
    87             
   111