|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric7.WebBrowser.Tools.DelayedFileWatcher</title> |
|
4 <meta charset="UTF-8"> |
|
5 <style> |
|
6 body { |
|
7 background: #EDECE6; |
|
8 margin: 0em 1em 10em 1em; |
|
9 color: black; |
|
10 } |
|
11 |
|
12 h1 { color: white; background: #85774A; } |
|
13 h2 { color: white; background: #85774A; } |
|
14 h3 { color: white; background: #9D936E; } |
|
15 h4 { color: white; background: #9D936E; } |
|
16 |
|
17 a { color: #BA6D36; } |
|
18 |
|
19 </style> |
|
20 </head> |
|
21 <body> |
|
22 <a NAME="top" ID="top"></a> |
|
23 <h1>eric7.WebBrowser.Tools.DelayedFileWatcher</h1> |
|
24 |
|
25 <p> |
|
26 Module implementing a file system watcher with a delay. |
|
27 </p> |
|
28 <h3>Global Attributes</h3> |
|
29 |
|
30 <table> |
|
31 <tr><td>None</td></tr> |
|
32 </table> |
|
33 <h3>Classes</h3> |
|
34 |
|
35 <table> |
|
36 |
|
37 <tr> |
|
38 <td><a href="#DelayedFileWatcher">DelayedFileWatcher</a></td> |
|
39 <td>Class implementing a file system watcher with a delay.</td> |
|
40 </tr> |
|
41 </table> |
|
42 <h3>Functions</h3> |
|
43 |
|
44 <table> |
|
45 <tr><td>None</td></tr> |
|
46 </table> |
|
47 <hr /> |
|
48 <hr /> |
|
49 <a NAME="DelayedFileWatcher" ID="DelayedFileWatcher"></a> |
|
50 <h2>DelayedFileWatcher</h2> |
|
51 |
|
52 <p> |
|
53 Class implementing a file system watcher with a delay. |
|
54 </p> |
|
55 <h3>Signals</h3> |
|
56 <dl> |
|
57 |
|
58 <dt>delayedDirectoryChanged(path)</dt> |
|
59 <dd> |
|
60 emitted to indicate a changed |
|
61 directory |
|
62 </dd> |
|
63 <dt>delayedFileChanged(path)</dt> |
|
64 <dd> |
|
65 emitted to indicate a changed file |
|
66 </dd> |
|
67 </dl> |
|
68 <h3>Derived from</h3> |
|
69 QFileSystemWatcher |
|
70 <h3>Class Attributes</h3> |
|
71 |
|
72 <table> |
|
73 <tr><td>None</td></tr> |
|
74 </table> |
|
75 <h3>Class Methods</h3> |
|
76 |
|
77 <table> |
|
78 <tr><td>None</td></tr> |
|
79 </table> |
|
80 <h3>Methods</h3> |
|
81 |
|
82 <table> |
|
83 |
|
84 <tr> |
|
85 <td><a href="#DelayedFileWatcher.__init__">DelayedFileWatcher</a></td> |
|
86 <td>Constructor</td> |
|
87 </tr> |
|
88 <tr> |
|
89 <td><a href="#DelayedFileWatcher.__dequeueDirectory">__dequeueDirectory</a></td> |
|
90 <td>Private slot to signal a directory change.</td> |
|
91 </tr> |
|
92 <tr> |
|
93 <td><a href="#DelayedFileWatcher.__dequeueFile">__dequeueFile</a></td> |
|
94 <td>Private slot to signal a file change.</td> |
|
95 </tr> |
|
96 <tr> |
|
97 <td><a href="#DelayedFileWatcher.__directoryChanged">__directoryChanged</a></td> |
|
98 <td>Private slot handling a changed directory.</td> |
|
99 </tr> |
|
100 <tr> |
|
101 <td><a href="#DelayedFileWatcher.__fileChanged">__fileChanged</a></td> |
|
102 <td>Private slot handling a changed file.</td> |
|
103 </tr> |
|
104 </table> |
|
105 <h3>Static Methods</h3> |
|
106 |
|
107 <table> |
|
108 <tr><td>None</td></tr> |
|
109 </table> |
|
110 |
|
111 <a NAME="DelayedFileWatcher.__init__" ID="DelayedFileWatcher.__init__"></a> |
|
112 <h4>DelayedFileWatcher (Constructor)</h4> |
|
113 <b>DelayedFileWatcher</b>(<i>paths=None, parent=None</i>) |
|
114 |
|
115 <p> |
|
116 Constructor |
|
117 </p> |
|
118 <dl> |
|
119 |
|
120 <dt><i>paths</i> (list of str)</dt> |
|
121 <dd> |
|
122 list of paths to be watched |
|
123 </dd> |
|
124 <dt><i>parent</i> (QObject)</dt> |
|
125 <dd> |
|
126 reference to the parent object |
|
127 </dd> |
|
128 </dl> |
|
129 <a NAME="DelayedFileWatcher.__dequeueDirectory" ID="DelayedFileWatcher.__dequeueDirectory"></a> |
|
130 <h4>DelayedFileWatcher.__dequeueDirectory</h4> |
|
131 <b>__dequeueDirectory</b>(<i></i>) |
|
132 |
|
133 <p> |
|
134 Private slot to signal a directory change. |
|
135 </p> |
|
136 <a NAME="DelayedFileWatcher.__dequeueFile" ID="DelayedFileWatcher.__dequeueFile"></a> |
|
137 <h4>DelayedFileWatcher.__dequeueFile</h4> |
|
138 <b>__dequeueFile</b>(<i></i>) |
|
139 |
|
140 <p> |
|
141 Private slot to signal a file change. |
|
142 </p> |
|
143 <a NAME="DelayedFileWatcher.__directoryChanged" ID="DelayedFileWatcher.__directoryChanged"></a> |
|
144 <h4>DelayedFileWatcher.__directoryChanged</h4> |
|
145 <b>__directoryChanged</b>(<i>path</i>) |
|
146 |
|
147 <p> |
|
148 Private slot handling a changed directory. |
|
149 </p> |
|
150 <dl> |
|
151 |
|
152 <dt><i>path</i> (str)</dt> |
|
153 <dd> |
|
154 name of the changed directory |
|
155 </dd> |
|
156 </dl> |
|
157 <a NAME="DelayedFileWatcher.__fileChanged" ID="DelayedFileWatcher.__fileChanged"></a> |
|
158 <h4>DelayedFileWatcher.__fileChanged</h4> |
|
159 <b>__fileChanged</b>(<i>path</i>) |
|
160 |
|
161 <p> |
|
162 Private slot handling a changed file. |
|
163 </p> |
|
164 <dl> |
|
165 |
|
166 <dt><i>path</i> (str)</dt> |
|
167 <dd> |
|
168 name of the changed file |
|
169 </dd> |
|
170 </dl> |
|
171 <div align="right"><a href="#top">Up</a></div> |
|
172 <hr /> |
|
173 </body></html> |