cellular/psetnotesui/inc/psuinotecontroller.h
changeset 51 12bc758d6a02
parent 48 78df25012fda
child 53 25b8d29b7c59
equal deleted inserted replaced
48:78df25012fda 51:12bc758d6a02
     1 /*
       
     2 * Copyright (c) 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: 
       
    15 *     Singleton class for controlling notes. 
       
    16 *
       
    17 */
       
    18 
       
    19 
       
    20 #ifndef PSUINOTECONTROLLER_H
       
    21 #define PSUINOTECONTROLLER_H
       
    22 
       
    23 // INCLUDES
       
    24 #include <coemain.h>
       
    25 #include "psuinotemaster.h" 
       
    26 
       
    27 // CLASS DECLARATION
       
    28 
       
    29 class CPsuiNoteController : public CCoeStatic
       
    30     {
       
    31     public:  
       
    32 
       
    33         /**    
       
    34          * Returns an instance of this class. When called for the first
       
    35          * time, a new instance is created and returned.  After that,
       
    36          * calling InstanceL returns the same instance that was created
       
    37          * earlier.
       
    38          *   
       
    39          * @return A pointer to a CPsuiNoteController object    
       
    40          */    
       
    41         static CPsuiNoteController* InstanceL();   
       
    42         
       
    43         /**
       
    44         * Destructor.
       
    45         */
       
    46         virtual ~CPsuiNoteController();
       
    47 
       
    48         /**
       
    49         * Shows the requested note. 
       
    50         *
       
    51         * @param aType Type of note to be shown
       
    52         *    Error, confirmation, warning and waiting notes are supported.
       
    53         * @param aResourceID Content text's resource ID for the note
       
    54         */
       
    55         void ShowNoteL( TPsuiNoteTypes aType, TInt aResourceID );
       
    56 
       
    57         /**    
       
    58         * Shows the basic service list assosiated with supplementary service
       
    59         * activation or status check.
       
    60         * 
       
    61         * @param aResourceHeading Heading for the list
       
    62         * @param aBsc List of basic service groups
       
    63         */
       
    64         void ShowBscListL( 
       
    65             TInt aResourceHeading, 
       
    66             TUint8 aBsc[KPSUIMaxBscNumber] );
       
    67 
       
    68         /* 
       
    69         * Same as above, except intended for CF basic service lists.
       
    70         *
       
    71         * @param aResourceHeading Heading for the list
       
    72         * @param aList List of basic service groups and their statuses 
       
    73         *              and settings
       
    74         * @param aCFType Type of call forwarding
       
    75         * @param aIndex Index of list item user has selected
       
    76         * @return user action ID, i.e. what kind of list to show next
       
    77         */
       
    78         /*****************************************************
       
    79         *    Series 60 Customer / ETel
       
    80         *    Series 60  ETel API
       
    81         *****************************************************/ 
       
    82         TCFType ShowBscCFListL( 
       
    83             TInt aResourceHeading, 
       
    84             CMobilePhoneCFList& aList, 
       
    85             TCFType aCFType,
       
    86             TInt& aIndex );
       
    87 
       
    88         /**
       
    89         * Shows detailed info about the selected basic service group.
       
    90         *
       
    91         *   @param  aCFType Type of Call Forwarding, defines softkeys
       
    92         *   @param  aSetting List of basic service groups and their statuses
       
    93         *                    and settings
       
    94         */
       
    95         /*****************************************************
       
    96         *    Series 60 Customer / ETel
       
    97         *    Series 60  ETel API
       
    98         *****************************************************/ 
       
    99         void ShowCfInfoL( 
       
   100             TCFType& aCFType,
       
   101             const RMobilePhone::TMobilePhoneCFInfoEntryV1& aSetting );
       
   102 
       
   103         /*
       
   104         * Returns correct resource ID based on error code.
       
   105         * 
       
   106         *   @param aErrorCode Error code for which the resource ID is needed
       
   107         *   @return Resource ID for the string text in the error note
       
   108         */
       
   109         TInt SetErrorNoteResourceID ( const TInt aErrorCode );
       
   110         
       
   111         /**
       
   112         * Removes all notes that are being displayed by us.
       
   113         */
       
   114         void RemoveNotesL();
       
   115 
       
   116         /**
       
   117         * Kills waiting note when the request is completed.
       
   118         */
       
   119         void KillStaticNoteL();
       
   120 
       
   121         /**
       
   122         * Sets the connection to engine. 
       
   123         * This is needed to provide user the possibility to cancel
       
   124         * pending requests. All the pointers are set with same
       
   125         * command, if in the future the amount of parameters comes
       
   126         * too large, redesigning might be worth doing. 
       
   127         *
       
   128         * @param aWaitingEngine Reference to Phone Settings' object
       
   129         * @param aBarringEngine Reference to Phone Settings' object
       
   130         * @param aDivertEngine Reference to Phone Settings' object
       
   131         * @param aCliEngine Reference to Phone Settings' object
       
   132         */
       
   133         void SetEngineContacts( MPsetCallWaiting* aWaitingEngine,
       
   134             MPsetCallBarring* aBarringEngine, 
       
   135             MPsetCallDiverting* aDivertEngine,
       
   136             MPsetCli* aCliEngine);
       
   137 
       
   138 
       
   139     private:
       
   140 
       
   141         /**    
       
   142          * Default constructor is private because we are using the
       
   143          * singleton design pattern.
       
   144          */    
       
   145         CPsuiNoteController();  
       
   146         
       
   147         /**
       
   148         * By default EPOC constructor is private.
       
   149         */
       
   150         void ConstructL();
       
   151                         
       
   152         
       
   153     private:
       
   154     
       
   155         // Note Master does the actual showing of notes and lists
       
   156         CPsuiNoteMaster* iNote;
       
   157     };
       
   158     
       
   159 #endif // PSUINOTECONTROLLER_H
       
   160 
       
   161 // End of File