phoneapp/phoneuiutils/inc/cphoneclearblacklist.h
changeset 37 ba76fc04e6c2
child 51 f39ed5e045e0
equal deleted inserted replaced
36:2eacb6118286 37:ba76fc04e6c2
       
     1 /*
       
     2 * Copyright (c) 2002 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:  Singleton class that provides interfaces for controlling
       
    15 *                call blacklist clearing
       
    16 *
       
    17 */
       
    18 
       
    19 
       
    20 #ifndef CPHONECLEARBLACKLIST_H
       
    21 #define CPHONECLEARBLACKLIST_H
       
    22 
       
    23 // INCLUDES
       
    24 #include <e32base.h>
       
    25 #include <coemain.h>
       
    26 // #include <w32std.h>
       
    27 
       
    28 // FORWARD DECLARATIONS
       
    29 class RWsSession;
       
    30 class RWindowBase;
       
    31 class RAnimDll;
       
    32 class RPhoneAnimClearBlacklist;
       
    33 
       
    34 // CLASS DECLARATION
       
    35 
       
    36 /**
       
    37 * Blacklist clearing.
       
    38 *
       
    39 * Used to clear the call blacklist.
       
    40 *
       
    41 *  @since 5.0
       
    42 */
       
    43 class CPhoneClearBlacklist : public CCoeStatic
       
    44     {
       
    45     public: // Constructors and destructors.
       
    46 
       
    47         /**
       
    48         * First call initializes the singleton object. 
       
    49         * Singleton must be initialized only once and then Instance() method 
       
    50         * may be used to get handle to instance.
       
    51         * @param aWsSession window server session.
       
    52         * @param aDevice window.
       
    53         * @return the created instance.
       
    54         */
       
    55         IMPORT_C static CPhoneClearBlacklist* CreateL(
       
    56             RWsSession& aWsSession, 
       
    57             const RWindowBase& aDevice );
       
    58     
       
    59         /**
       
    60         * Returns an instance of this class.
       
    61         * @return A pointer to CPhoneClearBlacklist class 
       
    62         */
       
    63         IMPORT_C static CPhoneClearBlacklist* Instance();
       
    64 
       
    65         /**
       
    66         * C++ destructor.
       
    67         */
       
    68         IMPORT_C ~CPhoneClearBlacklist();
       
    69         
       
    70     public: // New functions
       
    71         
       
    72         /** 
       
    73         * Clear blacklist on next key press.
       
    74         * This function should be called in startup and after every call.
       
    75         */
       
    76         IMPORT_C void ClearBlackListOnNextKey();
       
    77         
       
    78         /** 
       
    79         * Clear blacklist.
       
    80         * This function should be called when call is established in redial.
       
    81         */
       
    82         IMPORT_C void ClearBlackListNow();
       
    83         
       
    84     private:
       
    85 
       
    86         /** 
       
    87         * Constructor. 
       
    88         */
       
    89         CPhoneClearBlacklist();
       
    90 
       
    91         /** 
       
    92         * 2nd phase constructor
       
    93         */
       
    94         void ConstructL( RWsSession& aWsSession, const RWindowBase& aDevice );
       
    95         
       
    96     private:
       
    97 
       
    98         // Owned anim dll instance.
       
    99         RAnimDll*                   iAnimDll;
       
   100 
       
   101         // Owned clear blacklist subsession.
       
   102         RPhoneAnimClearBlacklist*   iAnim;
       
   103 
       
   104     };
       
   105 
       
   106 #endif
       
   107 // End of File