commonuisupport/uikon/test/teiksrv/tbackup/tbackup.h
changeset 0 2f259fa3e83a
equal deleted inserted replaced
-1:000000000000 0:2f259fa3e83a
       
     1 // Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
       
     2 // All rights reserved.
       
     3 // This component and the accompanying materials are made available
       
     4 // under the terms of "Eclipse Public License v1.0"
       
     5 // which accompanies this distribution, and is available
       
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     7 //
       
     8 // Initial Contributors:
       
     9 // Nokia Corporation - initial contribution.
       
    10 //
       
    11 // Contributors:
       
    12 //
       
    13 // Description:
       
    14 // Tests CBaBackupSessionWrapper APIs and observers for backup server.\n
       
    15 // 
       
    16 //
       
    17 
       
    18 /**
       
    19  @file
       
    20  @internalComponent - Internal Symbian test code
       
    21 */
       
    22 
       
    23 #ifndef		__TBACKUP_H
       
    24 #define		__TBACKUP_H
       
    25 
       
    26 #include <eikenv.h>
       
    27 #include <coecntrl.h>
       
    28 #include <basched.h>
       
    29 #include <babackup.h>
       
    30 #include <eikappui.h>
       
    31 #include <eikdef.h>
       
    32 #include <eikapp.h>
       
    33 #include <eikdoc.h>
       
    34 #include <techview/eikon.hrh>
       
    35 #include <techview/eiktxlbx.h>
       
    36 #include <techview/eiktxlbm.h>
       
    37 #include <techview/eikchlst.h>
       
    38 #include <techview/eikclb.h>
       
    39 #include <techview/eikclbd.h>
       
    40 #include <techview/eikdialg.h>
       
    41 #include <techview/eikcapc.h>
       
    42 #include <apgwgnam.h>
       
    43 #include <apgtask.h>
       
    44 #include <eikcoctl.rsg>
       
    45 #include <techview/eikchkbx.h>
       
    46 #include <eikmsg.h>
       
    47 #include <techview/eikhopbt.h>
       
    48 #include <uiklafgt/eikcore.rsg>
       
    49 #include "appfwk_test_AppUi.h"
       
    50 
       
    51 _LIT(KTestBackupStep, "TBackup");
       
    52 
       
    53 
       
    54 //!  A CTestBackupStep test class. 
       
    55 /**
       
    56  Tests CBaBackupSessionWrapper APIs.
       
    57 */
       
    58 class CTestBackupStep : public CTmsTestStep
       
    59 	{
       
    60 public:
       
    61 	CTestBackupStep();
       
    62 	~CTestBackupStep();
       
    63 	virtual TVerdict doTestStepL();
       
    64 	void ConstructAppL(CEikonEnv* aCoe);
       
    65 private:
       
    66 	};
       
    67 
       
    68 
       
    69 const TInt KNumOfBackupOperationObservers = 3;
       
    70 class CBackupAppUi;
       
    71 class CBackupRunTest;
       
    72 
       
    73 //!  CBackupDialogBase - dialog base class. 
       
    74 /**
       
    75  Forms the dialog base class.
       
    76 */
       
    77 class CBackupDialogBase : public CEikDialog
       
    78 	{
       
    79 public:
       
    80 	enum TOperationGranularity
       
    81 		{
       
    82 		EAll,
       
    83 		ESingleFile
       
    84 		};
       
    85 protected:
       
    86 	CBackupDialogBase(CDesCArray& aFiles,TOperationGranularity& aGranularity,TDes& aFileName);
       
    87 protected: // from CEikDialog
       
    88 	void PreLayoutDynInitL();
       
    89 	TBool OkToExitL(TInt aButtonId);
       
    90 	void HandleControlStateChangeL(TInt aControlId);
       
    91 private:
       
    92 	void UpdateFileListDimmedState();
       
    93 protected:
       
    94 	CDesCArray& iFiles;
       
    95 	TOperationGranularity& iGranularity;
       
    96 	TDes& iFileName;
       
    97 	};
       
    98 
       
    99 
       
   100 //!  CBackupCloseDialog - close dialog class. 
       
   101 /**
       
   102  Creates the close backup dialog class.
       
   103 */
       
   104 class CBackupCloseDialog : public CBackupDialogBase
       
   105 	{
       
   106 public:
       
   107 	static TBool RunDlgLD(CDesCArray& aFiles,CBackupDialogBase::TOperationGranularity& aGranularity,TDes& aFileName,
       
   108 							MBackupObserver::TFileLockFlags& aFlag);
       
   109 	
       
   110 private:
       
   111 	CBackupCloseDialog(CDesCArray& aFiles,CBackupDialogBase::TOperationGranularity& aGranularity,TDes& aFileName,
       
   112 							MBackupObserver::TFileLockFlags& aFlag);
       
   113 private: // from CEikDialog
       
   114 	void PreLayoutDynInitL();
       
   115 	TBool OkToExitL(TInt aButtonId);
       
   116 private:
       
   117 	MBackupObserver::TFileLockFlags& iFileFlag;
       
   118 	};
       
   119 
       
   120 
       
   121 
       
   122 //!  CBackupRestartDialog - restart dialog class. 
       
   123 /**
       
   124  Creates the restart backup dialog class.
       
   125 */
       
   126 class CBackupRestartDialog : public CBackupDialogBase
       
   127 	{
       
   128 public:
       
   129 	static TBool RunDlgLD(CDesCArray& aFiles,CBackupDialogBase::TOperationGranularity& aGranularity,TDes& aFileName);
       
   130 private:
       
   131 	CBackupRestartDialog(CDesCArray& aFiles,CBackupDialogBase::TOperationGranularity& aGranularity,TDes& aFileName);
       
   132 private: // from CEikDialog
       
   133 	void PreLayoutDynInitL();
       
   134 	};
       
   135 
       
   136 
       
   137 
       
   138 //!  CBackupFileObserver - file observer class. 
       
   139 /**
       
   140  File observer class.
       
   141 */
       
   142 class CBackupFileObserver : public CBase, private MBackupObserver
       
   143 	{
       
   144 public:
       
   145 	enum TFileLock
       
   146 		{ELocked,EReadOnly,ENoAccess};
       
   147 	class TBackupFile
       
   148 		{
       
   149 	public:
       
   150 		TBackupFile(const TDesC& aFileName,TFileLock aLockState);
       
   151 	public:
       
   152 		TFileName iFileName;
       
   153 		TFileLock iLockState;
       
   154 		};
       
   155 public:
       
   156 	static CBackupFileObserver* NewLC();
       
   157 	~CBackupFileObserver();
       
   158 	void AddFileL(const TDesC& aFileName);
       
   159 	void RemoveFile(const TDesC& aFileName);
       
   160 	const RArray<TBackupFile>& BackupArray() const;
       
   161 private:
       
   162 	CBackupFileObserver();
       
   163 	void ConstructL();
       
   164 	TInt Find(const TDesC& aFileName) const;
       
   165 private: // from MBackupObserver
       
   166 	void ChangeFileLockL(const TDesC& aFileName,TFileLockFlags aFlags);
       
   167 private:
       
   168 	RArray<TBackupFile> iBackupArray;
       
   169 	CBaBackupSessionWrapper* iBackupSession;
       
   170 	};
       
   171 
       
   172 
       
   173 //!  CBackupOpeartionObserver - backup observer. 
       
   174 /**
       
   175  Observer for backup operation.
       
   176 */
       
   177 class CBackupOpeartionObserver : public CBase, public MBackupOperationObserver
       
   178 	{
       
   179 public:
       
   180 	static CBackupOpeartionObserver* NewL();
       
   181 	inline TBool IsRegistered() const;
       
   182 	inline void SetRegistered(TBool aIsRegistered);
       
   183 private:
       
   184 	CBackupOpeartionObserver();
       
   185 private: // from MBackupOperationObserver
       
   186 	void HandleBackupOperationEventL(const TBackupOperationAttributes& aBackupOperationAttributes);
       
   187 private:
       
   188 	TBool iRegistered;
       
   189 	TBackupOperationAttributes iBackupOperationAttributes;
       
   190 	};
       
   191 
       
   192 //!  CBackupOpeartionObserversWrapper. 
       
   193 /**
       
   194  Wrapper for backup operation observer.
       
   195 */
       
   196 
       
   197 class CBackupOpeartionObserversWrapper : public CBase
       
   198 	{
       
   199 public:
       
   200 	static CBackupOpeartionObserversWrapper* NewL(TInt aNumberOfObservers);
       
   201 	~CBackupOpeartionObserversWrapper();
       
   202 	void RegisterBackupOperationObserverL(CBackupOpeartionObserver& aBackupOpeartionObserver);
       
   203 	void DeRegisterBackupOperationObserver(CBackupOpeartionObserver& aBackupOpeartionObserver);
       
   204 	inline TInt CountObservers() const;
       
   205 	inline CBackupOpeartionObserver* Observer(TInt aIndex);
       
   206 private:
       
   207 	CBackupOpeartionObserversWrapper();
       
   208 	void ConstructL(TInt aNumberOfObservers);
       
   209 	void ResetAndDestroy();
       
   210 private:
       
   211 	CBaBackupSessionWrapper* iBackupSession;
       
   212 	RPointerArray<CBackupOpeartionObserver> iBackupOpeartionObserver;
       
   213 	};
       
   214 
       
   215 
       
   216 
       
   217 //!  CBackupRegistrationDialog. 
       
   218 /**
       
   219  Dialog for registration of observer.
       
   220 */
       
   221 class CBackupRegistrationDialog : public CEikDialog
       
   222 	{
       
   223 public:
       
   224 	CBackupRegistrationDialog(RPointerArray<CBackupOpeartionObserversWrapper>& aBackupOperationObserversWrapper);
       
   225 	TBool OkToExitL(TInt aButtonId);
       
   226 private: // from CEikDialog
       
   227 	void PreLayoutDynInitL();
       
   228 private:
       
   229 	RPointerArray<CBackupOpeartionObserversWrapper>& iBackupOperationObserversWrapper;
       
   230 	CBackupAppUi* iBackupAppUi;
       
   231 	};
       
   232 
       
   233 
       
   234 //!  CBackupOperationDialog. 
       
   235 /**
       
   236  Dialog for starting backup operation.
       
   237 */
       
   238 class CBackupOperationDialog : public CEikDialog
       
   239 	{
       
   240 public:
       
   241 	CBackupOperationDialog(CBaBackupSessionWrapper& aBackupSession);
       
   242 	TBool OkToExitL(TInt aButtonId);
       
   243 private: // from CEikDialog
       
   244 	void PreLayoutDynInitL();
       
   245 	
       
   246 private:
       
   247 	CBaBackupSessionWrapper& iBackupSession;
       
   248 	CBackupAppUi* iBackupAppUi;
       
   249 	};
       
   250 
       
   251 
       
   252 //!  CBackdrop. 
       
   253 /**
       
   254  Background control.
       
   255 */
       
   256 class CBackdrop : public CCoeControl
       
   257 	{
       
   258 public:
       
   259 	static CBackdrop* NewL();
       
   260 private: // from CCoeControl
       
   261 	void Draw(const TRect& aRect) const;
       
   262 	};
       
   263 
       
   264 
       
   265 //!  COpenAppList. 
       
   266 /**
       
   267  Control to list open apps.
       
   268 */
       
   269 class COpenAppList : public CEikTextListBox
       
   270 	{
       
   271 public:
       
   272 	void UpdateL();
       
   273 	};
       
   274 
       
   275 
       
   276 //!  COpenFileList. 
       
   277 /**
       
   278  Control to list open files.
       
   279 */
       
   280 class COpenFileList : public CCoeControl
       
   281 	{
       
   282 public:
       
   283 	COpenFileList(CArrayPtr<CBackupFileObserver>& aFileObservers);
       
   284 	~COpenFileList();
       
   285 	void ConstructL();
       
   286 	void UpdateL();
       
   287 private: // from CCoeControl
       
   288 	TSize MinimumSize();
       
   289 	void SizeChanged();
       
   290 	TInt CountComponentControls() const;
       
   291 	CCoeControl* ComponentControl(TInt aIndex) const;
       
   292 private:
       
   293 	CEikColumnListBox* iList;
       
   294 	const CArrayPtr<CBackupFileObserver>& iFileObservers;
       
   295 	};
       
   296 
       
   297 //!  CTBackupAppUi. 
       
   298 /**
       
   299  Test Ui class.
       
   300 */
       
   301 class CTBackupAppUi : public CTestAppUi
       
   302 	{
       
   303 public:
       
   304 	CTBackupAppUi(CTmsTestStep* aStep);
       
   305 	void ConstructL();
       
   306 	~CTBackupAppUi();
       
   307 	void RunTestStepL(TInt aNextStep);
       
   308 	
       
   309 private: // framework
       
   310 	void HandleCommandL(TInt aCommand);
       
   311 
       
   312 private:
       
   313 	void CreateBackgroundL();
       
   314 	void CreateAppListL();
       
   315 	void CreateFileListL();
       
   316 	void CreateFileObserversL();
       
   317 	void CmdListAppsL();
       
   318 	void CmdListOpenFilesL();
       
   319 	void CmdCloseL();
       
   320 	void CmdRestartL();
       
   321 	void AutoCmdCloseL();
       
   322 	void AutoCmdRestartL();
       
   323 	void CreateObserversListL();
       
   324 	void UpdateBackupObserverRegistrationL();
       
   325 	void UpdateBackupOperationStateL();
       
   326 	void AutoUpdateBackupObserverRegistrationL();
       
   327 	void AutoUpdateBackupOperationStateL();
       
   328 	void AutoCmdCloseAllAndRestartAllL();
       
   329 	
       
   330 
       
   331 private:
       
   332 	CBaBackupSessionWrapper* iBackupSession;
       
   333 	CBackdrop* iBackdrop;
       
   334 	COpenAppList* iAppList;
       
   335 	COpenFileList* iFileList;
       
   336 	CArrayPtr<CBackupFileObserver>* iFileObservers;
       
   337 	RPointerArray<CBackupOpeartionObserversWrapper> iBackupOperationObserversWrapper;
       
   338 	CEikBusyMsgWin* iBusyMsg;
       
   339 	};
       
   340 
       
   341 
       
   342 //!  CBackupDocument. 
       
   343 /*!
       
   344  Test Document class.
       
   345 */
       
   346 class CBackupDocument : public CEikDocument
       
   347 	{
       
   348 public: // from CApaDocument
       
   349 	CBackupDocument(CEikApplication& aApp);
       
   350 	CEikAppUi* CreateAppUiL();
       
   351 	};
       
   352 
       
   353 
       
   354 //!  CBackupApplication. 
       
   355 /**
       
   356  Test Application class.
       
   357 */
       
   358 class CBackupApplication: public CEikApplication
       
   359 	{
       
   360 private: // from CApaApplication
       
   361 	CApaDocument* CreateDocumentL();
       
   362 	TUid AppDllUid() const;
       
   363 private:
       
   364 	CApaDocument* CreateDocumentL(CApaProcess* a) { return CEikApplication::CreateDocumentL(a); }
       
   365 
       
   366 	};
       
   367 
       
   368 #endif
       
   369 
       
   370