Mercurial Repositories > eric / file comparison

comparison: eric7/Documentation/Source/eric7.WebBrowser.Sync.DirectorySyncHandler.html

eric7/Documentation/Source/eric7.WebBrowser.Sync.DirectorySyncHandler.html

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
equal deleted inserted replaced
8371:d6062691d424 8372:e0227a7c850e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.WebBrowser.Sync.DirectorySyncHandler</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.Sync.DirectorySyncHandler</h1>
24
25 <p>
26 Module implementing a synchronization handler using a shared directory.
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="#DirectorySyncHandler">DirectorySyncHandler</a></td>
39 <td>Class implementing a synchronization handler using a shared directory.</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="DirectorySyncHandler" ID="DirectorySyncHandler"></a>
50 <h2>DirectorySyncHandler</h2>
51
52 <p>
53 Class implementing a synchronization handler using a shared directory.
54 </p>
55 <h3>Signals</h3>
56 <dl>
57
58 <dt>syncError(message)</dt>
59 <dd>
60 emitted for a general error with the error
61 message (string)
62 </dd>
63 <dt>syncFinished(type_, done, download)</dt>
64 <dd>
65 emitted after a
66 synchronization has finished (string one of "bookmarks", "history",
67 "passwords", "useragents" or "speeddial", boolean, boolean)
68 </dd>
69 <dt>syncMessage(message)</dt>
70 <dd>
71 emitted to send a message about
72 synchronization (string)
73 </dd>
74 <dt>syncStatus(type_, message)</dt>
75 <dd>
76 emitted to indicate the synchronization
77 status (string one of "bookmarks", "history", "passwords",
78 "useragents" or "speeddial", string)
79 </dd>
80 </dl>
81 <h3>Derived from</h3>
82 SyncHandler
83 <h3>Class Attributes</h3>
84
85 <table>
86 <tr><td>None</td></tr>
87 </table>
88 <h3>Class Methods</h3>
89
90 <table>
91 <tr><td>None</td></tr>
92 </table>
93 <h3>Methods</h3>
94
95 <table>
96
97 <tr>
98 <td><a href="#DirectorySyncHandler.__init__">DirectorySyncHandler</a></td>
99 <td>Constructor</td>
100 </tr>
101 <tr>
102 <td><a href="#DirectorySyncHandler.__downloadFile">__downloadFile</a></td>
103 <td>Private method to downlaod the given file.</td>
104 </tr>
105 <tr>
106 <td><a href="#DirectorySyncHandler.__initialSync">__initialSync</a></td>
107 <td>Private slot to do the initial synchronization.</td>
108 </tr>
109 <tr>
110 <td><a href="#DirectorySyncHandler.__initialSyncFile">__initialSyncFile</a></td>
111 <td>Private method to do the initial synchronization of the given file.</td>
112 </tr>
113 <tr>
114 <td><a href="#DirectorySyncHandler.__syncFile">__syncFile</a></td>
115 <td>Private method to synchronize the given file.</td>
116 </tr>
117 <tr>
118 <td><a href="#DirectorySyncHandler.__uploadFile">__uploadFile</a></td>
119 <td>Private method to upload the given file.</td>
120 </tr>
121 <tr>
122 <td><a href="#DirectorySyncHandler.initialLoadAndCheck">initialLoadAndCheck</a></td>
123 <td>Public method to do the initial check.</td>
124 </tr>
125 <tr>
126 <td><a href="#DirectorySyncHandler.shutdown">shutdown</a></td>
127 <td>Public method to shut down the handler.</td>
128 </tr>
129 <tr>
130 <td><a href="#DirectorySyncHandler.syncBookmarks">syncBookmarks</a></td>
131 <td>Public method to synchronize the bookmarks.</td>
132 </tr>
133 <tr>
134 <td><a href="#DirectorySyncHandler.syncHistory">syncHistory</a></td>
135 <td>Public method to synchronize the history.</td>
136 </tr>
137 <tr>
138 <td><a href="#DirectorySyncHandler.syncPasswords">syncPasswords</a></td>
139 <td>Public method to synchronize the passwords.</td>
140 </tr>
141 <tr>
142 <td><a href="#DirectorySyncHandler.syncSpeedDial">syncSpeedDial</a></td>
143 <td>Public method to synchronize the speed dial data.</td>
144 </tr>
145 <tr>
146 <td><a href="#DirectorySyncHandler.syncUserAgents">syncUserAgents</a></td>
147 <td>Public method to synchronize the user agents.</td>
148 </tr>
149 </table>
150 <h3>Static Methods</h3>
151
152 <table>
153 <tr><td>None</td></tr>
154 </table>
155
156 <a NAME="DirectorySyncHandler.__init__" ID="DirectorySyncHandler.__init__"></a>
157 <h4>DirectorySyncHandler (Constructor)</h4>
158 <b>DirectorySyncHandler</b>(<i>parent=None</i>)
159
160 <p>
161 Constructor
162 </p>
163 <dl>
164
165 <dt><i>parent</i></dt>
166 <dd>
167 reference to the parent object (QObject)
168 </dd>
169 </dl>
170 <a NAME="DirectorySyncHandler.__downloadFile" ID="DirectorySyncHandler.__downloadFile"></a>
171 <h4>DirectorySyncHandler.__downloadFile</h4>
172 <b>__downloadFile</b>(<i>type_, fileName, timestamp</i>)
173
174 <p>
175 Private method to downlaod the given file.
176 </p>
177 <dl>
178
179 <dt><i>type_</i></dt>
180 <dd>
181 type of the synchronization event (string one
182 of "bookmarks", "history", "passwords", "useragents" or
183 "speeddial")
184 </dd>
185 <dt><i>fileName</i></dt>
186 <dd>
187 name of the file to be downloaded (string)
188 </dd>
189 <dt><i>timestamp</i></dt>
190 <dd>
191 time stamp in seconds of the file to be downloaded
192 (integer)
193 </dd>
194 </dl>
195 <a NAME="DirectorySyncHandler.__initialSync" ID="DirectorySyncHandler.__initialSync"></a>
196 <h4>DirectorySyncHandler.__initialSync</h4>
197 <b>__initialSync</b>(<i></i>)
198
199 <p>
200 Private slot to do the initial synchronization.
201 </p>
202 <a NAME="DirectorySyncHandler.__initialSyncFile" ID="DirectorySyncHandler.__initialSyncFile"></a>
203 <h4>DirectorySyncHandler.__initialSyncFile</h4>
204 <b>__initialSyncFile</b>(<i>type_, fileName</i>)
205
206 <p>
207 Private method to do the initial synchronization of the given file.
208 </p>
209 <dl>
210
211 <dt><i>type_</i></dt>
212 <dd>
213 type of the synchronization event (string one
214 of "bookmarks", "history", "passwords", "useragents" or
215 "speeddial")
216 </dd>
217 <dt><i>fileName</i></dt>
218 <dd>
219 name of the file to be synchronized (string)
220 </dd>
221 </dl>
222 <a NAME="DirectorySyncHandler.__syncFile" ID="DirectorySyncHandler.__syncFile"></a>
223 <h4>DirectorySyncHandler.__syncFile</h4>
224 <b>__syncFile</b>(<i>type_, fileName</i>)
225
226 <p>
227 Private method to synchronize the given file.
228 </p>
229 <dl>
230
231 <dt><i>type_</i></dt>
232 <dd>
233 type of the synchronization event (string one
234 of "bookmarks", "history", "passwords", "useragents" or
235 "speeddial")
236 </dd>
237 <dt><i>fileName</i></dt>
238 <dd>
239 name of the file to be synchronized (string)
240 </dd>
241 </dl>
242 <a NAME="DirectorySyncHandler.__uploadFile" ID="DirectorySyncHandler.__uploadFile"></a>
243 <h4>DirectorySyncHandler.__uploadFile</h4>
244 <b>__uploadFile</b>(<i>type_, fileName</i>)
245
246 <p>
247 Private method to upload the given file.
248 </p>
249 <dl>
250
251 <dt><i>type_</i></dt>
252 <dd>
253 type of the synchronization event (string one
254 of "bookmarks", "history", "passwords", "useragents" or
255 "speeddial")
256 </dd>
257 <dt><i>fileName</i></dt>
258 <dd>
259 name of the file to be uploaded (string)
260 </dd>
261 </dl>
262 <a NAME="DirectorySyncHandler.initialLoadAndCheck" ID="DirectorySyncHandler.initialLoadAndCheck"></a>
263 <h4>DirectorySyncHandler.initialLoadAndCheck</h4>
264 <b>initialLoadAndCheck</b>(<i>forceUpload</i>)
265
266 <p>
267 Public method to do the initial check.
268 </p>
269 <dl>
270
271 <dt><i>forceUpload</i></dt>
272 <dd>
273 flag indicating a forced upload of the files
274 (boolean)
275 </dd>
276 </dl>
277 <a NAME="DirectorySyncHandler.shutdown" ID="DirectorySyncHandler.shutdown"></a>
278 <h4>DirectorySyncHandler.shutdown</h4>
279 <b>shutdown</b>(<i></i>)
280
281 <p>
282 Public method to shut down the handler.
283 </p>
284 <a NAME="DirectorySyncHandler.syncBookmarks" ID="DirectorySyncHandler.syncBookmarks"></a>
285 <h4>DirectorySyncHandler.syncBookmarks</h4>
286 <b>syncBookmarks</b>(<i></i>)
287
288 <p>
289 Public method to synchronize the bookmarks.
290 </p>
291 <a NAME="DirectorySyncHandler.syncHistory" ID="DirectorySyncHandler.syncHistory"></a>
292 <h4>DirectorySyncHandler.syncHistory</h4>
293 <b>syncHistory</b>(<i></i>)
294
295 <p>
296 Public method to synchronize the history.
297 </p>
298 <a NAME="DirectorySyncHandler.syncPasswords" ID="DirectorySyncHandler.syncPasswords"></a>
299 <h4>DirectorySyncHandler.syncPasswords</h4>
300 <b>syncPasswords</b>(<i></i>)
301
302 <p>
303 Public method to synchronize the passwords.
304 </p>
305 <a NAME="DirectorySyncHandler.syncSpeedDial" ID="DirectorySyncHandler.syncSpeedDial"></a>
306 <h4>DirectorySyncHandler.syncSpeedDial</h4>
307 <b>syncSpeedDial</b>(<i></i>)
308
309 <p>
310 Public method to synchronize the speed dial data.
311 </p>
312 <a NAME="DirectorySyncHandler.syncUserAgents" ID="DirectorySyncHandler.syncUserAgents"></a>
313 <h4>DirectorySyncHandler.syncUserAgents</h4>
314 <b>syncUserAgents</b>(<i></i>)
315
316 <p>
317 Public method to synchronize the user agents.
318 </p>
319 <div align="right"><a href="#top">Up</a></div>
320 <hr />
321 </body></html>

Mercurial Repository: eric

eric ide

mercurial