Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.WebBrowser.Sync.SyncManager.html
src/eric7/Documentation/Source/eric7.WebBrowser.Sync.SyncManager.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.SyncManager</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.SyncManager</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the synchronization manager class. | |
| 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="#SyncManager">SyncManager</a></td> | |
| 25 <td>Class implementing the synchronization manager.</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="SyncManager" ID="SyncManager"></a> | |
| 36 <h2>SyncManager</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing the synchronization manager. | |
| 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 give status info about the sync | |
| 58 process (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 QObject | |
| 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="#SyncManager.__init__">SyncManager</a></td> | |
| 85 <td>Constructor</td> | |
| 86 </tr> | |
| 87 <tr> | |
| 88 <td><a href="#SyncManager.__syncBookmarks">__syncBookmarks</a></td> | |
| 89 <td>Private slot to synchronize the bookmarks.</td> | |
| 90 </tr> | |
| 91 <tr> | |
| 92 <td><a href="#SyncManager.__syncError">__syncError</a></td> | |
| 93 <td>Private slot to handle general synchronization issues.</td> | |
| 94 </tr> | |
| 95 <tr> | |
| 96 <td><a href="#SyncManager.__syncFinished">__syncFinished</a></td> | |
| 97 <td>Private slot to handle a finished synchronization event.</td> | |
| 98 </tr> | |
| 99 <tr> | |
| 100 <td><a href="#SyncManager.__syncHistory">__syncHistory</a></td> | |
| 101 <td>Private slot to synchronize the history.</td> | |
| 102 </tr> | |
| 103 <tr> | |
| 104 <td><a href="#SyncManager.__syncPasswords">__syncPasswords</a></td> | |
| 105 <td>Private slot to synchronize the passwords.</td> | |
| 106 </tr> | |
| 107 <tr> | |
| 108 <td><a href="#SyncManager.__syncSpeedDial">__syncSpeedDial</a></td> | |
| 109 <td>Private slot to synchronize the speed dial settings.</td> | |
| 110 </tr> | |
| 111 <tr> | |
| 112 <td><a href="#SyncManager.__syncStatus">__syncStatus</a></td> | |
| 113 <td>Private slot to handle a status update of a synchronization event.</td> | |
| 114 </tr> | |
| 115 <tr> | |
| 116 <td><a href="#SyncManager.__syncUserAgents">__syncUserAgents</a></td> | |
| 117 <td>Private slot to synchronize the user agent settings.</td> | |
| 118 </tr> | |
| 119 <tr> | |
| 120 <td><a href="#SyncManager.close">close</a></td> | |
| 121 <td>Public slot to shut down the synchronization manager.</td> | |
| 122 </tr> | |
| 123 <tr> | |
| 124 <td><a href="#SyncManager.handler">handler</a></td> | |
| 125 <td>Public method to get a reference to the sync handler object.</td> | |
| 126 </tr> | |
| 127 <tr> | |
| 128 <td><a href="#SyncManager.loadSettings">loadSettings</a></td> | |
| 129 <td>Public method to load the settings.</td> | |
| 130 </tr> | |
| 131 <tr> | |
| 132 <td><a href="#SyncManager.showSyncDialog">showSyncDialog</a></td> | |
| 133 <td>Public method to show the synchronization dialog.</td> | |
| 134 </tr> | |
| 135 <tr> | |
| 136 <td><a href="#SyncManager.syncEnabled">syncEnabled</a></td> | |
| 137 <td>Public method to check, if synchronization is enabled.</td> | |
| 138 </tr> | |
| 139 </table> | |
| 140 <h3>Static Methods</h3> | |
| 141 | |
| 142 <table> | |
| 143 <tr><td>None</td></tr> | |
| 144 </table> | |
| 145 | |
| 146 <a NAME="SyncManager.__init__" ID="SyncManager.__init__"></a> | |
| 147 <h4>SyncManager (Constructor)</h4> | |
| 148 <b>SyncManager</b>(<i>parent=None</i>) | |
| 149 | |
| 150 <p> | |
| 151 Constructor | |
| 152 </p> | |
| 153 <dl> | |
| 154 | |
| 155 <dt><i>parent</i></dt> | |
| 156 <dd> | |
| 157 reference to the parent object (QObject) | |
| 158 </dd> | |
| 159 </dl> | |
| 160 <a NAME="SyncManager.__syncBookmarks" ID="SyncManager.__syncBookmarks"></a> | |
| 161 <h4>SyncManager.__syncBookmarks</h4> | |
| 162 <b>__syncBookmarks</b>(<i></i>) | |
| 163 | |
| 164 <p> | |
| 165 Private slot to synchronize the bookmarks. | |
| 166 </p> | |
| 167 <a NAME="SyncManager.__syncError" ID="SyncManager.__syncError"></a> | |
| 168 <h4>SyncManager.__syncError</h4> | |
| 169 <b>__syncError</b>(<i>message</i>) | |
| 170 | |
| 171 <p> | |
| 172 Private slot to handle general synchronization issues. | |
| 173 </p> | |
| 174 <dl> | |
| 175 | |
| 176 <dt><i>message</i></dt> | |
| 177 <dd> | |
| 178 error message (string) | |
| 179 </dd> | |
| 180 </dl> | |
| 181 <a NAME="SyncManager.__syncFinished" ID="SyncManager.__syncFinished"></a> | |
| 182 <h4>SyncManager.__syncFinished</h4> | |
| 183 <b>__syncFinished</b>(<i>type_, status, download</i>) | |
| 184 | |
| 185 <p> | |
| 186 Private slot to handle a finished synchronization event. | |
| 187 </p> | |
| 188 <dl> | |
| 189 | |
| 190 <dt><i>type_</i></dt> | |
| 191 <dd> | |
| 192 type of the synchronization event (string one | |
| 193 of "bookmarks", "history", "passwords", "useragents" or | |
| 194 "speeddial") | |
| 195 </dd> | |
| 196 <dt><i>status</i></dt> | |
| 197 <dd> | |
| 198 flag indicating success (boolean) | |
| 199 </dd> | |
| 200 <dt><i>download</i></dt> | |
| 201 <dd> | |
| 202 flag indicating a download of a file (boolean) | |
| 203 </dd> | |
| 204 </dl> | |
| 205 <a NAME="SyncManager.__syncHistory" ID="SyncManager.__syncHistory"></a> | |
| 206 <h4>SyncManager.__syncHistory</h4> | |
| 207 <b>__syncHistory</b>(<i></i>) | |
| 208 | |
| 209 <p> | |
| 210 Private slot to synchronize the history. | |
| 211 </p> | |
| 212 <a NAME="SyncManager.__syncPasswords" ID="SyncManager.__syncPasswords"></a> | |
| 213 <h4>SyncManager.__syncPasswords</h4> | |
| 214 <b>__syncPasswords</b>(<i></i>) | |
| 215 | |
| 216 <p> | |
| 217 Private slot to synchronize the passwords. | |
| 218 </p> | |
| 219 <a NAME="SyncManager.__syncSpeedDial" ID="SyncManager.__syncSpeedDial"></a> | |
| 220 <h4>SyncManager.__syncSpeedDial</h4> | |
| 221 <b>__syncSpeedDial</b>(<i></i>) | |
| 222 | |
| 223 <p> | |
| 224 Private slot to synchronize the speed dial settings. | |
| 225 </p> | |
| 226 <a NAME="SyncManager.__syncStatus" ID="SyncManager.__syncStatus"></a> | |
| 227 <h4>SyncManager.__syncStatus</h4> | |
| 228 <b>__syncStatus</b>(<i>type_, message</i>) | |
| 229 | |
| 230 <p> | |
| 231 Private slot to handle a status update of a synchronization event. | |
| 232 </p> | |
| 233 <dl> | |
| 234 | |
| 235 <dt><i>type_</i></dt> | |
| 236 <dd> | |
| 237 type of the synchronization event (string one | |
| 238 of "bookmarks", "history", "passwords", "useragents" or | |
| 239 "speeddial") | |
| 240 </dd> | |
| 241 <dt><i>message</i></dt> | |
| 242 <dd> | |
| 243 status message for the event (string) | |
| 244 </dd> | |
| 245 </dl> | |
| 246 <a NAME="SyncManager.__syncUserAgents" ID="SyncManager.__syncUserAgents"></a> | |
| 247 <h4>SyncManager.__syncUserAgents</h4> | |
| 248 <b>__syncUserAgents</b>(<i></i>) | |
| 249 | |
| 250 <p> | |
| 251 Private slot to synchronize the user agent settings. | |
| 252 </p> | |
| 253 <a NAME="SyncManager.close" ID="SyncManager.close"></a> | |
| 254 <h4>SyncManager.close</h4> | |
| 255 <b>close</b>(<i></i>) | |
| 256 | |
| 257 <p> | |
| 258 Public slot to shut down the synchronization manager. | |
| 259 </p> | |
| 260 <a NAME="SyncManager.handler" ID="SyncManager.handler"></a> | |
| 261 <h4>SyncManager.handler</h4> | |
| 262 <b>handler</b>(<i></i>) | |
| 263 | |
| 264 <p> | |
| 265 Public method to get a reference to the sync handler object. | |
| 266 </p> | |
| 267 <dl> | |
| 268 <dt>Return:</dt> | |
| 269 <dd> | |
| 270 reference to the sync handler object (SyncHandler) | |
| 271 </dd> | |
| 272 </dl> | |
| 273 <a NAME="SyncManager.loadSettings" ID="SyncManager.loadSettings"></a> | |
| 274 <h4>SyncManager.loadSettings</h4> | |
| 275 <b>loadSettings</b>(<i>forceUpload=False</i>) | |
| 276 | |
| 277 <p> | |
| 278 Public method to load the settings. | |
| 279 </p> | |
| 280 <dl> | |
| 281 | |
| 282 <dt><i>forceUpload</i></dt> | |
| 283 <dd> | |
| 284 flag indicating a forced upload of the files | |
| 285 (boolean) | |
| 286 </dd> | |
| 287 </dl> | |
| 288 <a NAME="SyncManager.showSyncDialog" ID="SyncManager.showSyncDialog"></a> | |
| 289 <h4>SyncManager.showSyncDialog</h4> | |
| 290 <b>showSyncDialog</b>(<i></i>) | |
| 291 | |
| 292 <p> | |
| 293 Public method to show the synchronization dialog. | |
| 294 </p> | |
| 295 <a NAME="SyncManager.syncEnabled" ID="SyncManager.syncEnabled"></a> | |
| 296 <h4>SyncManager.syncEnabled</h4> | |
| 297 <b>syncEnabled</b>(<i></i>) | |
| 298 | |
| 299 <p> | |
| 300 Public method to check, if synchronization is enabled. | |
| 301 </p> | |
| 302 <dl> | |
| 303 <dt>Return:</dt> | |
| 304 <dd> | |
| 305 flag indicating enabled synchronization | |
| 306 </dd> | |
| 307 </dl> | |
| 308 <div align="right"><a href="#top">Up</a></div> | |
| 309 <hr /> | |
| 310 </body></html> |
