|
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
2 <html xmlns="http://www.w3.org/1999/xhtml"> |
|
3 <head> |
|
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
|
5 <title>TB9.2 Example Applications: examples/Base/FileServer/FileChangeNotifier/inc/filechangenotifier.h Source File</title> |
|
6 <link href="tabs.css" rel="stylesheet" type="text/css"/> |
|
7 <link href="doxygen.css" rel="stylesheet" type="text/css"/> |
|
8 </head> |
|
9 <body> |
|
10 <!-- Generated by Doxygen 1.6.2 --> |
|
11 <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> |
|
12 <a name="l00002"></a>00002 <span class="comment">// All rights reserved.</span> |
|
13 <a name="l00003"></a>00003 <span class="comment">// This component and the accompanying materials are made available</span> |
|
14 <a name="l00004"></a>00004 <span class="comment">// under the terms of "Eclipse Public License v1.0"</span> |
|
15 <a name="l00005"></a>00005 <span class="comment">// which accompanies this distribution, and is available</span> |
|
16 <a name="l00006"></a>00006 <span class="comment">// at the URL "http://www.eclipse.org/legal/epl-v10.html".</span> |
|
17 <a name="l00007"></a>00007 <span class="comment">//</span> |
|
18 <a name="l00008"></a>00008 <span class="comment">// Initial Contributors:</span> |
|
19 <a name="l00009"></a>00009 <span class="comment">// Nokia Corporation - initial contribution.</span> |
|
20 <a name="l00010"></a>00010 <span class="comment">//</span> |
|
21 <a name="l00011"></a>00011 <span class="comment">// Contributors:</span> |
|
22 <a name="l00012"></a>00012 <span class="comment">//</span> |
|
23 <a name="l00013"></a>00013 <span class="comment">// Description:</span> |
|
24 <a name="l00014"></a>00014 <span class="comment">//</span> |
|
25 <a name="l00015"></a>00015 |
|
26 <a name="l00016"></a>00016 |
|
27 <a name="l00017"></a>00017 <span class="preprocessor">#ifndef __FILECHANGENOTIFIER_H__</span> |
|
28 <a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define __FILECHANGENOTIFIER_H__</span> |
|
29 <a name="l00019"></a>00019 <span class="preprocessor"></span> |
|
30 <a name="l00020"></a>00020 <span class="preprocessor">#include <e32base.h></span> |
|
31 <a name="l00021"></a>00021 <span class="preprocessor">#include <e32cons.h></span> |
|
32 <a name="l00022"></a>00022 <span class="preprocessor">#include <f32file.h></span> |
|
33 <a name="l00023"></a>00023 <span class="preprocessor">#include <f32notification.h></span> |
|
34 <a name="l00024"></a>00024 |
|
35 <a name="l00025"></a>00025 <span class="comment">/*</span> |
|
36 <a name="l00026"></a>00026 <span class="comment"> * Demonstrates the various features of Enhanced File change notifier.</span> |
|
37 <a name="l00027"></a>00027 <span class="comment"> * - User gets notified when there is a change in a File.</span> |
|
38 <a name="l00028"></a>00028 <span class="comment"> * - User gets notified when there is a change in a Folder.</span> |
|
39 <a name="l00029"></a>00029 <span class="comment"> * - User gets notified when there is a change in a Drive.</span> |
|
40 <a name="l00030"></a>00030 <span class="comment"> */</span> |
|
41 <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 |
|
42 <a name="l00032"></a>00032 { |
|
43 <a name="l00033"></a>00033 <span class="keyword">public</span>: |
|
44 <a name="l00034"></a>00034 <span class="keyword">static</span> <a class="code" href="class_c_change_notifier.html">CChangeNotifier</a>* NewL(TInt aPriority = EPriorityStandard); |
|
45 <a name="l00035"></a>00035 <span class="keyword">virtual</span> <a class="code" href="class_c_change_notifier.html#a408470e934332f6644929bbad83a4e53">~CChangeNotifier</a>(); |
|
46 <a name="l00036"></a>00036 <span class="keywordtype">void</span> RequestCharacter(); |
|
47 <a name="l00037"></a>00037 <span class="keyword">protected</span>: |
|
48 <a name="l00038"></a>00038 <span class="keywordtype">void</span> ConstructL(); |
|
49 <a name="l00039"></a>00039 |
|
50 <a name="l00040"></a>00040 <span class="keyword">public</span>: |
|
51 <a name="l00041"></a>00041 <span class="keyword">enum</span> TFileOperations{ |
|
52 <a name="l00042"></a>00042 ECreateFile, |
|
53 <a name="l00043"></a>00043 EChangeFileContents, |
|
54 <a name="l00044"></a>00044 ERenameFile, |
|
55 <a name="l00045"></a>00045 EChangeFileAttributes , |
|
56 <a name="l00046"></a>00046 EDeleteFile, |
|
57 <a name="l00047"></a>00047 ECreateFolder, |
|
58 <a name="l00048"></a>00048 ERenameFolder, |
|
59 <a name="l00049"></a>00049 EDeleteFolder, |
|
60 <a name="l00050"></a>00050 EVolumeNameChange, |
|
61 <a name="l00051"></a>00051 EMultipleNotifications |
|
62 <a name="l00052"></a>00052 }; |
|
63 <a name="l00053"></a>00053 <span class="keyword">private</span>: |
|
64 <a name="l00054"></a>00054 <span class="keyword">virtual</span> <span class="keywordtype">void</span> DoCancel(); |
|
65 <a name="l00055"></a>00055 <span class="keyword">virtual</span> <span class="keywordtype">void</span> RunL(); |
|
66 <a name="l00056"></a>00056 <span class="keywordtype">void</span> PressAnyKey(); |
|
67 <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> |
|
68 <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> |
|
69 <a name="l00059"></a>00059 <span class="keywordtype">void</span> CreateFile(); <span class="comment">// get notified when a new file is created.</span> |
|
70 <a name="l00060"></a>00060 <span class="keywordtype">void</span> ChangeFileContents(); <span class="comment">// get notified when the file contents are changed.</span> |
|
71 <a name="l00061"></a>00061 <span class="keywordtype">void</span> RenameFile(); <span class="comment">// get notified when a file is renamed.</span> |
|
72 <a name="l00062"></a>00062 <span class="keywordtype">void</span> ChangeFileAttributes (); <span class="comment">// get notified when the file attributes change.</span> |
|
73 <a name="l00063"></a>00063 <span class="keywordtype">void</span> DeleteFile(); <span class="comment">// get notified when a file is deleted.</span> |
|
74 <a name="l00064"></a>00064 <span class="keywordtype">void</span> CreateFolder(); <span class="comment">// get notified when a folder is created.</span> |
|
75 <a name="l00065"></a>00065 <span class="keywordtype">void</span> RenameFolder(); <span class="comment">// get notified when a folder is renamed.</span> |
|
76 <a name="l00066"></a>00066 <span class="keywordtype">void</span> DeleteFolder(); <span class="comment">// get notified when a folder is deleted.</span> |
|
77 <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> |
|
78 <a name="l00068"></a>00068 <span class="keywordtype">void</span> VolumeNameChange(); <span class="comment">// get notified when there is a volume name change.</span> |
|
79 <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> |
|
80 <a name="l00070"></a>00070 <span class="keywordtype">void</span> DoChanges(CChangeNotifier::TFileOperations operation); <span class="comment">// Do file/folder changes.</span> |
|
81 <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> |
|
82 <a name="l00072"></a>00072 |
|
83 <a name="l00073"></a>00073 <span class="keyword">private</span>: |
|
84 <a name="l00074"></a>00074 <a class="code" href="class_c_change_notifier.html">CChangeNotifier</a>(TInt aPriority = EPriorityStandard ); |
|
85 <a name="l00075"></a>00075 <span class="comment">/*</span> |
|
86 <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> |
|
87 <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> |
|
88 <a name="l00078"></a>00078 <span class="comment"> */</span> |
|
89 <a name="l00079"></a>00079 TBool iIsCreateFolder; <span class="comment">// to verify whether a folder is created or not.</span> |
|
90 <a name="l00080"></a>00080 TBool iIsRenameFolder; <span class="comment">// to verify whether the rename operation on a folder is performed already.</span> |
|
91 <a name="l00081"></a>00081 TBool iIsDeleteFolder; <span class="comment">// to verify whether the delete folder operation is performed already.</span> |
|
92 <a name="l00082"></a>00082 TBool iIsVolumeNameChange; <span class="comment">// to verify whether the volume name change operation is done already.</span> |
|
93 <a name="l00083"></a>00083 TBool iIsCreateFile; <span class="comment">// to verify whether the file is created in the desired location already.</span> |
|
94 <a name="l00084"></a>00084 TBool iIsRenameFile; <span class="comment">// to verify whether the rename operation on the file is performed already.</span> |
|
95 <a name="l00085"></a>00085 TBool iIsChangeFileAttributes ; <span class="comment">// to verify whether the file attributed are changed already.</span> |
|
96 <a name="l00086"></a>00086 TBool iIsDeleteFile; <span class="comment">// to verify whether the file is deleted already.</span> |
|
97 <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> |
|
98 <a name="l00088"></a>00088 TBool iIsMultipleNotifications; |
|
99 <a name="l00089"></a>00089 RFs iFs; |
|
100 <a name="l00090"></a>00090 TChar iDrive; <span class="comment">// System drive</span> |
|
101 <a name="l00091"></a>00091 TInt iDriveNumber; <span class="comment">// drive number of U: drive</span> |
|
102 <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> |
|
103 <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> |
|
104 <a name="l00094"></a>00094 CConsoleBase* iConsole; |
|
105 <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> |
|
106 <a name="l00096"></a>00096 TRequestStatus iReqStatus; |
|
107 <a name="l00097"></a>00097 }; |
|
108 <a name="l00098"></a>00098 <span class="preprocessor">#endif // __CHANGENOTIFIER_H__</span> |
|
109 <a name="l00099"></a>00099 <span class="preprocessor"></span> |
|
110 <a name="l00100"></a>00100 |
|
111 </pre></div></div> |
|
112 <hr size="1"/><address style="text-align: right;"><small>Generated by |
|
113 <a href="http://www.doxygen.org/index.html"> |
|
114 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address> |
|
115 </body> |
|
116 </html> |