S60 3rd Edition API Reference: apsettingshandlercommons.h Source File

00001 /*
00002 * ============================================================================
00003 *  Name     : ApSettingsHandlerCommons.h 
00004 *  Part of  : Access Point Settings Handler UI
00005 *
00006 *  Description:
00007 *     Contains common consts, typedefs for the Access Point settings.
00008 *  Version:
00009 *
00010 *  Copyright (C) 2002 Nokia Corporation.
00011 *  This material, including documentation and any related 
00012 *  computer programs, is protected by copyright controlled by 
00013 *  Nokia Corporation. All rights are reserved. Copying, 
00014 *  including reproducing, storing,  adapting or translating, any 
00015 *  or all of this material requires the prior written consent of 
00016 *  Nokia Corporation. This material also contains confidential 
00017 *  information which may not be disclosed to others without the 
00018 *  prior written consent of Nokia Corporation.
00019 *
00020 * ============================================================================
00021 */
00022 
00023 #ifndef APSETTINGS_HANDLER_COMMONS_H
00024 #define APSETTINGS_HANDLER_COMMONS_H
00025 
00026 // INCLUDES
00027 #include <ApEngineConsts.h>
00028 
00029 
00030 //#define __TEST_OOMDEBUG
00031 
00032 
00033 // CONSTANTS
00034 _LIT( KEmpty, "");
00035 
00036 _LIT( KTestFileName, "C:\\Data\\ApSetUiTest\\TestState.txt" );
00037 
00038 const TInt  KApSelectionCanceled    = -350;
00039 const TInt  KTxtNotOverriden        = -351;
00040 const TInt  KErrInvalidTextId       = -355;
00041 
00042 #ifdef __TEST_OOMDEBUG
00043     const TInt  KDialogListTest      = 1;   // Done
00044     const TInt  KPopupListTest       = 2;   // Done
00045     const TInt  KQueryTest           = 3;   // Done
00046     const TInt  KEditingTest         = 4;   // Done
00047     const TInt  KViewerTest          = 5;   // impl.
00048     const TInt  KCreateBlankTest     = 6;   // Impl
00049     const TInt  KCreateUseExistTest  = 7;   // Impl
00050     const TInt  KDeleteTest          = 8;   // N/I!
00051 
00052     const TUint32   KOOMRetryCount   = 10;
00053     const TUint32   KOOMRetryOffset  = 5;
00054 // __TEST_OOMDEBUG
00055 #endif
00056 
00057 // DATA TYPES
00058 enum TTextID    
00059 
00060     {
00061     EApSettingsSelStatusPaneText = 0x00,
00062     EApSettingsSelListEmptyText,
00063     EPopupPromptText            
00064     };
00065 
00066 
00067 enum TTransactionResult         
00068     {
00069     EOwnTransaction,            
00070     EUsingAlreadyStarted,       
00071     EFailedWithLocked           
00072     };
00073 
00074 
00075 enum TApUiExitReason
00076     {
00077     EExitNone,
00078     EExit,
00079     EShutDown
00080     };
00081 
00082 
00083 // CONSTANTS
00084 const TInt  KTTextIdMin             =  EApSettingsSelStatusPaneText;
00085 const TInt  KTTextIdMax             =  EPopupPromptText;
00086 
00087 const TInt  KMaxNumOfLockedDbRetries= 3;
00088 
00091 
00096 const TInt  KApUiEventNone              = 0x00000000;   
00097 const TInt  KApUiEventSelected          = 0x00000001;   
00098 const TInt  KApUiEventCreatedBlank      = 0x00000002;   
00099 
00100 const TInt  KApUiEventCreatedUsedOld    = 0x00000004;   
00101 
00102 
00103 const TInt  KApUiEventEdited            = 0x00000008;   
00104 const TInt  KApUiEventDeleted           = 0x00000010;   
00105 const TInt  KApUiEventExitRequested     = 0x00000020;   
00106 const TInt  KApUiEventShutDownRequested = 0x00000040;   
00107 
00108 // INTERNAL flag
00109 const TUint32  KApUiEventInternal       = 0x80000000;   
00110 
00111 
00112 const TUint32  KApNoneUID               = 0x00000000;
00113 
00114 
00115 enum TSelectionListType         
00116     {
00117     EApSettingsSelListIsPopUp, 
00118     EApSettingsSelListIsListPane,
00119     EApSettingsSelListIsPopUpWithNone
00120     };
00121 
00122 
00123 enum TSelectionMenuType         
00124     {
00125     EApSettingsSelMenuNormal, 
00126     EApSettingsSelMenuSelectOnly,
00127     EApSettingsSelMenuSelectNormal
00128     };
00129 
00130 
00131 
00132 enum TApSettingsHandlerUiPanicCodes 
00133     {
00134     EMenuCommandUnknown,            
00135     EInvalidDbType,                 
00136     EInvalidBitmapType,             
00137     EInvalidBearerType,             
00138     EInvalidIspRequest,             
00139     ENullPointer,                   
00140     EUnknownCase,                   
00141     EInvalidTextType,               
00142     EInvalidState                   
00143     } ;
00144 
00145 
00146 
00151 void Panic( TApSettingsHandlerUiPanicCodes aPanic );
00152 
00153 
00160 TInt AskQueryL( TInt aResId, TDesC* aVar = NULL );
00161 
00162 
00169 TInt ShowNoteL( TInt aResId, TDesC* aVar = NULL );
00170 
00171 
00172 #ifdef __TEST_OOMDEBUG
00173     TInt GetTestState();
00174 // __TEST_OOMDEBUG
00175 #endif
00176 
00177 #endif
00178 
00179 
00180 // End of File