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