email/imum/Utils/Inc/IMSSettingsItemApprover.h
changeset 0 72b543305e3a
equal deleted inserted replaced
-1:000000000000 0:72b543305e3a
       
     1 /*
       
     2 * Copyright (c) 2006 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:  IMSSettingsItemApprover.h
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef IMSSETTINGSITEMAPPROVER_H
       
    20 #define IMSSETTINGSITEMAPPROVER_H
       
    21 
       
    22 // INCLUDES
       
    23 #include <e32base.h>
       
    24 #include "MuiuDynamicSettingItemBase.h" // CMuiuSettingBase
       
    25 #include <msvapi.h>                     // CMsvSession
       
    26 #include <muiuflagger.h>                // CMuiuFlags
       
    27 #include "MuiuDynamicSettingsDialog.h"  // TMuiuPageEventResult
       
    28 
       
    29 #include "ComDbUtl.h"                   // CMsvCommDbUtilities
       
    30 #include "IMSSettingsNoteUi.h"          // CIMSSettingsNoteUi
       
    31 #include "IMSSettingsItemApprover.h"    // CIMSSettingsItemApprover
       
    32 #include "IMSSettingsBaseUi.h"          // CIMSSettingsBaseUi
       
    33 
       
    34 // CONSTANTS
       
    35 enum TIMSApproverFlags
       
    36     {
       
    37     // Indicates that the item contains unprepared value
       
    38     EIMSApproverGenerate = 15
       
    39     };
       
    40 
       
    41 enum TIMSApproverEvent
       
    42     {
       
    43     EIMSApproverNoEvent = 0,
       
    44     EIMSApproverRemoveAlwaysOnline,
       
    45     EIMSApproverRemoveOmaEmn
       
    46     };
       
    47 
       
    48 // MACROS
       
    49 // DATA TYPES
       
    50 // FUNCTION PROTOTYPES
       
    51 // FORWARD DECLARATIONS
       
    52 class CImumInternalApi;
       
    53 class CImumInSettingsData;
       
    54 
       
    55 // CLASS DECLARATION
       
    56 
       
    57 /**
       
    58 *  ?one_line_short_description.
       
    59 *  ?other_description_lines
       
    60 *
       
    61 *  @lib ?library
       
    62 *  @since S60 3.0
       
    63 */
       
    64 class CIMSSettingsItemApprover : public CBase
       
    65     {
       
    66     public: // Constructors and destructor
       
    67 
       
    68         /**
       
    69         * Destructor
       
    70         * @since S60
       
    71         */
       
    72         ~CIMSSettingsItemApprover();
       
    73 
       
    74         /**
       
    75         *
       
    76         * @since S60
       
    77         */
       
    78         static CIMSSettingsItemApprover* NewL(
       
    79             CImumInternalApi& aMailboxApi,
       
    80             CMsvCommDbUtilities& aCommsDb,
       
    81             CIMSSettingsNoteUi& aNoteUi,
       
    82             CIMSSettingsBaseUI& aDialog );
       
    83 
       
    84         /**
       
    85         *
       
    86         * @since S60
       
    87         */
       
    88         static CIMSSettingsItemApprover* NewLC(
       
    89             CImumInternalApi& aMailboxApi,
       
    90             CMsvCommDbUtilities& aCommsDb,
       
    91             CIMSSettingsNoteUi& aNoteUi,
       
    92             CIMSSettingsBaseUI& aDialog );
       
    93 
       
    94     public: // New functions
       
    95 
       
    96         /**
       
    97         *
       
    98         * @since S60 3.0
       
    99         */
       
   100         TMuiuPageEventResult EvaluateText(
       
   101             TIMSApproverEvent& aEvent,
       
   102             const CMuiuSettingBase& aBaseItem,
       
   103             TDes& aNewText );
       
   104 
       
   105         /**
       
   106         *
       
   107         * @since S60 3.0
       
   108         */
       
   109         TMuiuPageEventResult EvaluateValue(
       
   110             TIMSApproverEvent& aEvent,
       
   111             const CMuiuSettingBase& aBaseItem,
       
   112             TInt& aNewValue );
       
   113 
       
   114     public: // Functions from base classes
       
   115 
       
   116     protected:  // New virtual functions
       
   117     protected:  // New functions
       
   118     protected:  // Functions from base classes
       
   119 
       
   120     private: // Constructors
       
   121 
       
   122         /**
       
   123         *
       
   124         * @since S60
       
   125         */
       
   126         CIMSSettingsItemApprover(
       
   127             CImumInternalApi& aMailboxApi,
       
   128             CMsvCommDbUtilities& aCommsDb,
       
   129             CIMSSettingsNoteUi& aNoteUi,
       
   130             CIMSSettingsBaseUI& aDialog );
       
   131 
       
   132         /**
       
   133         *
       
   134         * @since S60
       
   135         */
       
   136         void ConstructL();
       
   137 
       
   138     private:  // New virtual functions
       
   139     private:  // New functions
       
   140 
       
   141         // COMMON ITEM VALIDATION
       
   142 
       
   143         /**
       
   144         *
       
   145         * @since S60 3.0
       
   146         */
       
   147         TIMSErrors ValidateType(
       
   148             const CMuiuSettingBase& aBaseItem,
       
   149             TDes& aNewText,
       
   150             TInt& aNewValue );
       
   151 
       
   152         /**
       
   153         *
       
   154         * @since S60 3.0
       
   155         */
       
   156         TIMSErrors EvaluateWizardItems(
       
   157             TIMSApproverEvent& aEvent,
       
   158             const CMuiuSettingBase& aBaseItem,
       
   159             TDes& aNewText,
       
   160             TInt& aNewValue );
       
   161 
       
   162         /**
       
   163         *
       
   164         * @since S60 3.0
       
   165         */
       
   166         TIMSErrors EvaluateSettingItems(
       
   167             TIMSApproverEvent& aEvent,
       
   168             const CMuiuSettingBase& aBaseItem,
       
   169             TDes& aNewText,
       
   170             TInt& aNewValue );
       
   171 
       
   172         /**
       
   173         *
       
   174         * @since S60 3.0
       
   175         */
       
   176         TMuiuPageEventResult EvaluateItem(
       
   177             TIMSApproverEvent& aEvent,
       
   178             const CMuiuSettingBase& aBaseItem,
       
   179             TDes& aNewText,
       
   180             TInt& aNewValue );
       
   181 
       
   182         /**
       
   183         *
       
   184         * @since S60 3.0
       
   185         */
       
   186         TBool IsItemFilled(
       
   187             const CMuiuSettingBase& aBaseItem,
       
   188             const TInt aLength );
       
   189 
       
   190         /**
       
   191         *
       
   192         * @since S60 3.0
       
   193         */
       
   194         TIMSErrors ValidateText(
       
   195             const CMuiuSettingBase& aBaseItem,
       
   196             const TDesC& aNewText );
       
   197 
       
   198         /**
       
   199         *
       
   200         * @since S60 3.0
       
   201         */
       
   202         TIMSErrors ValidateValue(
       
   203             const CMuiuSettingBase& aBaseItem,
       
   204             TInt& aNewValue );
       
   205 
       
   206         /**
       
   207         *
       
   208         * @since S60 3.0
       
   209         */
       
   210         TIMSErrors ValidateRadioButtons(
       
   211             const TInt aNewValue );
       
   212 
       
   213         // SPESIFIC ITEM VALIDATION
       
   214 
       
   215         /**
       
   216         *
       
   217         * @since S60 3.0
       
   218         */
       
   219         TIMSErrors EvaluateAccountName(
       
   220             const CMuiuSettingBase& aBaseItem,
       
   221             TDes& aNewText );
       
   222 
       
   223         /**
       
   224         *
       
   225         * @since Series60 3.0
       
   226         */
       
   227         TIMSErrors EvaluateServerAddress(
       
   228             const CMuiuSettingBase& aBaseItem,
       
   229             const TDesC& aNewText );
       
   230 
       
   231         /**
       
   232         *
       
   233         * @since Series60 3.0
       
   234         */
       
   235         TIMSErrors EvaluateEmailAddress(
       
   236             const CMuiuSettingBase& aBaseItem,
       
   237             const TDesC& aNewText );
       
   238 
       
   239         /**
       
   240         *
       
   241         * @since Series60 3.0
       
   242         */
       
   243         TIMSErrors EvaluateInternetAccessPoint(
       
   244             const CMuiuSettingBase& aBaseItem,
       
   245             TInt& aNewValue );
       
   246 
       
   247         // ITEM VALIDATION UTILITIES
       
   248 
       
   249         /**
       
   250         *
       
   251         * @since S60 3.0
       
   252         */
       
   253         TIMSErrors EvaluateUsernameOrPassword(
       
   254             TIMSApproverEvent& aEvent,
       
   255             TDes& aNewText );
       
   256 
       
   257         /**
       
   258          * Evaluates free text fields that have no special
       
   259          * restrictions.
       
   260          *
       
   261          * @since S60 5.0
       
   262          */
       
   263         TIMSErrors EvaluateFreeText( TDes& aNewText );
       
   264 
       
   265         // Always Online and OMA EMN checks
       
   266 
       
   267         /**
       
   268         *
       
   269         * @since S60 3.0
       
   270         */
       
   271         TIMSErrors CheckItemOnlineSettingsCheckTurnOn(
       
   272             TIMSApproverEvent& aEvent,
       
   273             const TInt aNewValue,
       
   274             TBool aIsEmn );
       
   275 
       
   276         /**
       
   277         *
       
   278         * @since S60 3.0
       
   279         */
       
   280         TIMSErrors CheckItemOnlineSettingsCheckTurnOnL(
       
   281             TIMSApproverEvent& aEvent,
       
   282             TBool aIsEmn );
       
   283 
       
   284         /**
       
   285         *
       
   286         * @since S60 3.0
       
   287         */
       
   288         TIMSErrors CheckItemAoCountOkL();
       
   289 
       
   290         /**
       
   291         *
       
   292         * @since S60 3.0
       
   293         */
       
   294         TIMSErrors CheckItemAoAccessPointOkL();
       
   295 
       
   296         /**
       
   297         *
       
   298         * @since S60 3.0
       
   299         */
       
   300         TIMSErrors CheckItemAoOmaEmnOffL( TBool aIsEmn );
       
   301 
       
   302         /**
       
   303         *
       
   304         * @since S60 3.0
       
   305         */
       
   306         TIMSErrors CheckItemAoUsernameAndPasswordL();
       
   307 
       
   308         /**
       
   309         *
       
   310         * @since S60 3.0
       
   311         */
       
   312         TIMSErrors CheckItemAoConnectionTypeL();
       
   313 
       
   314         /**
       
   315         *
       
   316         * @since S60 3.0
       
   317         */
       
   318         TIMSErrors CheckItemAOFixFetchL();
       
   319 
       
   320     private:  // Functions from base classes
       
   321 
       
   322     public:     // Data
       
   323     protected:  // Data
       
   324     private:    // Data
       
   325 
       
   326         // Internal mail API implementation
       
   327         CImumInternalApi&   iMailboxApi;
       
   328         // CommsDb utils
       
   329         CMsvCommDbUtilities& iCommsDbUtils;
       
   330         // Class to handle notes in UI
       
   331         CIMSSettingsNoteUi& iNoteUi;
       
   332         // The ownerdialog item
       
   333         CIMSSettingsBaseUI& iDialog;
       
   334         //
       
   335         TMuiuSettingsText*  iTempText;
       
   336     };
       
   337 
       
   338 #endif // IMSSETTINGSITEMAPPROVER_H
       
   339 
       
   340 // End of File