Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/filechangenotifier_8h-source.html
Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>TB10.1 Example Applications: examples/Base/FileServer/FileChangeNotifier/inc/filechangenotifier.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.3 -->
<h1>examples/Base/FileServer/FileChangeNotifier/inc/filechangenotifier.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// Copyright (c) 2000-2009 Nokia Corporation and/or its subsidiary(-ies).</span>
<a name="l00002"></a>00002 <span class="comment">// All rights reserved.</span>
<a name="l00003"></a>00003 <span class="comment">// This component and the accompanying materials are made available</span>
<a name="l00004"></a>00004 <span class="comment">// under the terms of "Eclipse Public License v1.0"</span>
<a name="l00005"></a>00005 <span class="comment">// which accompanies this distribution, and is available</span>
<a name="l00006"></a>00006 <span class="comment">// at the URL "http://www.eclipse.org/legal/epl-v10.html".</span>
<a name="l00007"></a>00007 <span class="comment">//</span>
<a name="l00008"></a>00008 <span class="comment">// Initial Contributors:</span>
<a name="l00009"></a>00009 <span class="comment">// Nokia Corporation - initial contribution.</span>
<a name="l00010"></a>00010 <span class="comment">//</span>
<a name="l00011"></a>00011 <span class="comment">// Contributors:</span>
<a name="l00012"></a>00012 <span class="comment">//</span>
<a name="l00013"></a>00013 <span class="comment">// Description:</span>
<a name="l00014"></a>00014 <span class="comment">//</span>
<a name="l00015"></a>00015
<a name="l00016"></a>00016
<a name="l00017"></a>00017 <span class="preprocessor">#ifndef __FILECHANGENOTIFIER_H__</span>
<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define __FILECHANGENOTIFIER_H__</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span>
<a name="l00020"></a>00020 <span class="preprocessor">#include <e32base.h></span>
<a name="l00021"></a>00021 <span class="preprocessor">#include <e32cons.h></span>
<a name="l00022"></a>00022 <span class="preprocessor">#include <f32file.h></span>
<a name="l00023"></a>00023 <span class="preprocessor">#include <f32notification.h></span>
<a name="l00024"></a>00024
<a name="l00025"></a>00025 <span class="comment">/*</span>
<a name="l00026"></a>00026 <span class="comment"> * Demonstrates the various features of Enhanced File change notifier.</span>
<a name="l00027"></a>00027 <span class="comment"> * - User gets notified when there is a change in a File.</span>
<a name="l00028"></a>00028 <span class="comment"> * - User gets notified when there is a change in a Folder.</span>
<a name="l00029"></a>00029 <span class="comment"> * - User gets notified when there is a change in a Drive.</span>
<a name="l00030"></a>00030 <span class="comment"> */</span>
<a name="l00031"></a><a class="code" href="class_c_change_notifier.html">00031</a> <span class="keyword">class </span><a class="code" href="class_c_change_notifier.html">CChangeNotifier</a>: <span class="keyword">public</span> CActive
<a name="l00032"></a>00032 {
<a name="l00033"></a>00033 <span class="keyword">public</span>:
<a name="l00034"></a>00034 <span class="keyword">static</span> <a class="code" href="class_c_change_notifier.html">CChangeNotifier</a>* <a class="code" href="class_c_change_notifier.html#675776d5cdfcb7de2a5cc1c769ec84b2">NewL</a>(TInt aPriority = EPriorityStandard);
<a name="l00035"></a>00035 <span class="keyword">virtual</span> <a class="code" href="class_c_change_notifier.html#408470e934332f6644929bbad83a4e53">~CChangeNotifier</a>();
<a name="l00036"></a>00036 <span class="keywordtype">void</span> <a class="code" href="class_c_change_notifier.html#78549195a4c4966a8fc1fe86a21367ac">RequestCharacter</a>();
<a name="l00037"></a>00037 <span class="keyword">protected</span>:
<a name="l00038"></a>00038 <span class="keywordtype">void</span> <a class="code" href="class_c_change_notifier.html#253e317e641ef6e3a3082976a488ab19">ConstructL</a>();
<a name="l00039"></a>00039
<a name="l00040"></a>00040 <span class="keyword">public</span>:
<a name="l00041"></a><a class="code" href="class_c_change_notifier.html#90443db727bcc59986db1763797301c5">00041</a> <span class="keyword">enum</span> <a class="code" href="class_c_change_notifier.html#90443db727bcc59986db1763797301c5">TFileOperations</a>{
<a name="l00042"></a><a class="code" href="class_c_change_notifier.html#90443db727bcc59986db1763797301c515102208233bc18de975d6c79f811f9c">00042</a> <a class="code" href="class_c_change_notifier.html#90443db727bcc59986db1763797301c515102208233bc18de975d6c79f811f9c">ECreateFile</a>,
<a name="l00043"></a><a class="code" href="class_c_change_notifier.html#90443db727bcc59986db1763797301c5777717de5f78f6c4c8c80ebda017992b">00043</a> <a class="code" href="class_c_change_notifier.html#90443db727bcc59986db1763797301c5777717de5f78f6c4c8c80ebda017992b">EChangeFileContents</a>,
<a name="l00044"></a><a class="code" href="class_c_change_notifier.html#90443db727bcc59986db1763797301c54086aa74b0fd0df50f31e02d31b6b97d">00044</a> <a class="code" href="class_c_change_notifier.html#90443db727bcc59986db1763797301c54086aa74b0fd0df50f31e02d31b6b97d">ERenameFile</a>,
<a name="l00045"></a><a class="code" href="class_c_change_notifier.html#90443db727bcc59986db1763797301c547a4d94aab0195608bdd9777e786c3bc">00045</a> <a class="code" href="class_c_change_notifier.html#90443db727bcc59986db1763797301c547a4d94aab0195608bdd9777e786c3bc">EChangeFileAttributes</a> ,
<a name="l00046"></a><a class="code" href="class_c_change_notifier.html#90443db727bcc59986db1763797301c53d2724c1c9aaa655e7bdc769a6526b82">00046</a> <a class="code" href="class_c_change_notifier.html#90443db727bcc59986db1763797301c53d2724c1c9aaa655e7bdc769a6526b82">EDeleteFile</a>,
<a name="l00047"></a><a class="code" href="class_c_change_notifier.html#90443db727bcc59986db1763797301c5fb02316236b6c1979d6cd987287992a4">00047</a> <a class="code" href="class_c_change_notifier.html#90443db727bcc59986db1763797301c5fb02316236b6c1979d6cd987287992a4">ECreateFolder</a>,
<a name="l00048"></a><a class="code" href="class_c_change_notifier.html#90443db727bcc59986db1763797301c533841cf50185d5ed61646afbd9c4acae">00048</a> <a class="code" href="class_c_change_notifier.html#90443db727bcc59986db1763797301c533841cf50185d5ed61646afbd9c4acae">ERenameFolder</a>,
<a name="l00049"></a><a class="code" href="class_c_change_notifier.html#90443db727bcc59986db1763797301c55300dd0de3cc1c67086998918952b39a">00049</a> <a class="code" href="class_c_change_notifier.html#90443db727bcc59986db1763797301c55300dd0de3cc1c67086998918952b39a">EDeleteFolder</a>,
<a name="l00050"></a><a class="code" href="class_c_change_notifier.html#90443db727bcc59986db1763797301c52aa5885f121033f6daf1fb6d1e85720d">00050</a> <a class="code" href="class_c_change_notifier.html#90443db727bcc59986db1763797301c52aa5885f121033f6daf1fb6d1e85720d">EVolumeNameChange</a>,
<a name="l00051"></a><a class="code" href="class_c_change_notifier.html#90443db727bcc59986db1763797301c5ba8dbedfc3959d7e2f96aa6973f3b3cc">00051</a> <a class="code" href="class_c_change_notifier.html#90443db727bcc59986db1763797301c5ba8dbedfc3959d7e2f96aa6973f3b3cc">EMultipleNotifications</a>
<a name="l00052"></a>00052 };
<a name="l00053"></a>00053 <span class="keyword">private</span>:
<a name="l00054"></a>00054 <span class="keyword">virtual</span> <span class="keywordtype">void</span> DoCancel();
<a name="l00055"></a>00055 <span class="keyword">virtual</span> <span class="keywordtype">void</span> RunL();
<a name="l00056"></a>00056 <span class="keywordtype">void</span> PressAnyKey();
<a name="l00057"></a>00057 <span class="keywordtype">void</span> NotifyChangeToFile(); <span class="comment">// get notified when there is a change in the file.</span>
<a name="l00058"></a>00058 <span class="keywordtype">void</span> NotifyChangeToFolder(); <span class="comment">// get notified when there is a change in the folder.</span>
<a name="l00059"></a>00059 <span class="keywordtype">void</span> CreateFile(); <span class="comment">// get notified when a new file is created.</span>
<a name="l00060"></a>00060 <span class="keywordtype">void</span> ChangeFileContents(); <span class="comment">// get notified when the file contents are changed.</span>
<a name="l00061"></a>00061 <span class="keywordtype">void</span> RenameFile(); <span class="comment">// get notified when a file is renamed.</span>
<a name="l00062"></a>00062 <span class="keywordtype">void</span> ChangeFileAttributes (); <span class="comment">// get notified when the file attributes change.</span>
<a name="l00063"></a>00063 <span class="keywordtype">void</span> DeleteFile(); <span class="comment">// get notified when a file is deleted.</span>
<a name="l00064"></a>00064 <span class="keywordtype">void</span> CreateFolder(); <span class="comment">// get notified when a folder is created.</span>
<a name="l00065"></a>00065 <span class="keywordtype">void</span> RenameFolder(); <span class="comment">// get notified when a folder is renamed.</span>
<a name="l00066"></a>00066 <span class="keywordtype">void</span> DeleteFolder(); <span class="comment">// get notified when a folder is deleted.</span>
<a name="l00067"></a>00067 <span class="keywordtype">void</span> DeleteFileandFolder(); <span class="comment">// get notitified when a folder is deleted, file in the folder is also deleted.</span>
<a name="l00068"></a>00068 <span class="keywordtype">void</span> VolumeNameChange(); <span class="comment">// get notified when there is a volume name change.</span>
<a name="l00069"></a>00069 <span class="keywordtype">void</span> MultipleNotifications(); <span class="comment">// multiple notifications can be requested at once, completed notifications are filled in the buffer.</span>
<a name="l00070"></a>00070 <span class="keywordtype">void</span> DoChanges(<a class="code" href="class_c_change_notifier.html#90443db727bcc59986db1763797301c5">CChangeNotifier::TFileOperations</a> operation); <span class="comment">// Do file/folder changes.</span>
<a name="l00071"></a>00071 <span class="keywordtype">void</span> ProcessMultipleChanges(<span class="keyword">const</span> TFsNotification* aNotification); <span class="comment">// Process the completion of multiple notifications requested by 'Multiple Notifications' use case.</span>
<a name="l00072"></a>00072
<a name="l00073"></a>00073 <span class="keyword">private</span>:
<a name="l00074"></a>00074 <a class="code" href="class_c_change_notifier.html">CChangeNotifier</a>(TInt aPriority = EPriorityStandard );
<a name="l00075"></a>00075 <span class="comment">/*</span>
<a name="l00076"></a>00076 <span class="comment"> * These booleans are used to detect whether the file change operation was performed earlier or not.</span>
<a name="l00077"></a>00077 <span class="comment"> * Ex: If a folder is already created and the user tries to create it once again, it prints that the file is created.</span>
<a name="l00078"></a>00078 <span class="comment"> */</span>
<a name="l00079"></a>00079 TBool iIsCreateFolder; <span class="comment">// to verify whether a folder is created or not.</span>
<a name="l00080"></a>00080 TBool iIsRenameFolder; <span class="comment">// to verify whether the rename operation on a folder is performed already.</span>
<a name="l00081"></a>00081 TBool iIsDeleteFolder; <span class="comment">// to verify whether the delete folder operation is performed already.</span>
<a name="l00082"></a>00082 TBool iIsVolumeNameChange; <span class="comment">// to verify whether the volume name change operation is done already.</span>
<a name="l00083"></a>00083 TBool iIsCreateFile; <span class="comment">// to verify whether the file is created in the desired location already.</span>
<a name="l00084"></a>00084 TBool iIsRenameFile; <span class="comment">// to verify whether the rename operation on the file is performed already.</span>
<a name="l00085"></a>00085 TBool iIsChangeFileAttributes ; <span class="comment">// to verify whether the file attributed are changed already.</span>
<a name="l00086"></a>00086 TBool iIsDeleteFile; <span class="comment">// to verify whether the file is deleted already.</span>
<a name="l00087"></a>00087 TBool iDeleteFileContinue; <span class="comment">// this boolean is used when a folder with a file needs to be removed. it removes the file and then calls folder removal.</span>
<a name="l00088"></a>00088 TBool iIsMultipleNotifications;
<a name="l00089"></a>00089 RFs iFs;
<a name="l00090"></a>00090 TChar iDrive; <span class="comment">// System drive</span>
<a name="l00091"></a>00091 TInt iDriveNumber; <span class="comment">// drive number of U: drive</span>
<a name="l00092"></a>00092 TBool iOption; <span class="comment">// This boolean is used to exit, if none of the Main menu options is chosen.</span>
<a name="l00093"></a>00093 TBool iOptionContinue; <span class="comment">// it is used to continue with the Main menu, if none of the sub menu options is chosen.</span>
<a name="l00094"></a>00094 CConsoleBase* iConsole;
<a name="l00095"></a>00095 CFsNotify* iNotify; <span class="comment">// This is client which will be posting notification requests and will be notified after completion of these requests.</span>
<a name="l00096"></a>00096 TRequestStatus iReqStatus;
<a name="l00097"></a>00097 };
<a name="l00098"></a>00098 <span class="preprocessor">#endif // __CHANGENOTIFIER_H__</span>
<a name="l00099"></a>00099 <span class="preprocessor"></span>
<a name="l00100"></a>00100
</pre></div><hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 21 10:32:56 2010 for TB10.1 Example Applications by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
</body>
</html>