Mercurial Repositories > eric / file comparison

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

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

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

Mercurial Repository: eric

eric ide

mercurial