Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Helpviewer.Sync.DirectorySyncHandler.html
Documentation/Source/eric5.Helpviewer.Sync.DirectorySyncHandler.html
- changeset 1695
- 7b115f986d48
- child 1702
- 870ee0fa9007
equal
deleted
inserted
replaced
| 1694:648466a9451b | 1695:7b115f986d48 |
|---|---|
| 1 <?xml version="1.0" encoding="utf-8"?> | |
| 2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' | |
| 3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
| 4 <html><head> | |
| 5 <title>eric5.Helpviewer.Sync.DirectorySyncHandler</title> | |
| 6 <style> | |
| 7 body { | |
| 8 background: #EDECE6; | |
| 9 margin: 0em 1em 10em 1em; | |
| 10 color: black; | |
| 11 } | |
| 12 | |
| 13 h1 { color: white; background: #85774A; } | |
| 14 h2 { color: white; background: #85774A; } | |
| 15 h3 { color: white; background: #9D936E; } | |
| 16 h4 { color: white; background: #9D936E; } | |
| 17 | |
| 18 a { color: #BA6D36; } | |
| 19 | |
| 20 </style> | |
| 21 </head> | |
| 22 <body><a NAME="top" ID="top"></a> | |
| 23 <h1>eric5.Helpviewer.Sync.DirectorySyncHandler</h1> | |
| 24 <p> | |
| 25 Module implementing a synchronization handler using a shared directory. | |
| 26 </p> | |
| 27 <h3>Global Attributes</h3> | |
| 28 <table> | |
| 29 <tr><td>None</td></tr> | |
| 30 </table> | |
| 31 <h3>Classes</h3> | |
| 32 <table> | |
| 33 <tr> | |
| 34 <td><a href="#DirectorySyncHandler">DirectorySyncHandler</a></td> | |
| 35 <td>Class implementing a synchronization handler using a shared directory.</td> | |
| 36 </tr> | |
| 37 </table> | |
| 38 <h3>Functions</h3> | |
| 39 <table> | |
| 40 <tr><td>None</td></tr> | |
| 41 </table> | |
| 42 <hr /><hr /> | |
| 43 <a NAME="DirectorySyncHandler" ID="DirectorySyncHandler"></a> | |
| 44 <h2>DirectorySyncHandler</h2> | |
| 45 <p> | |
| 46 Class implementing a synchronization handler using a shared directory. | |
| 47 </p><h3>Signals</h3> | |
| 48 <dl> | |
| 49 <dt>syncError(message)</dt> | |
| 50 <dd> | |
| 51 emitted for a general error with the error message (string) | |
| 52 </dd><dt>syncFinished(type_, done, download)</dt> | |
| 53 <dd> | |
| 54 emitted after a synchronization has | |
| 55 finished (string one of "bookmarks", "history", "passwords" or "useragents", | |
| 56 boolean, boolean) | |
| 57 </dd><dt>syncMessage(message)</dt> | |
| 58 <dd> | |
| 59 emitted to send a message about synchronization (string) | |
| 60 </dd><dt>syncStatus(type_, done, message)</dt> | |
| 61 <dd> | |
| 62 emitted to indicate the synchronization | |
| 63 status (string one of "bookmarks", "history", "passwords" or "useragents", | |
| 64 boolean, string) | |
| 65 </dd> | |
| 66 </dl> | |
| 67 <h3>Derived from</h3> | |
| 68 SyncHandler | |
| 69 <h3>Class Attributes</h3> | |
| 70 <table> | |
| 71 <tr><td>None</td></tr> | |
| 72 </table> | |
| 73 <h3>Class Methods</h3> | |
| 74 <table> | |
| 75 <tr><td>None</td></tr> | |
| 76 </table> | |
| 77 <h3>Methods</h3> | |
| 78 <table> | |
| 79 <tr> | |
| 80 <td><a href="#DirectorySyncHandler.__init__">DirectorySyncHandler</a></td> | |
| 81 <td>Constructor</td> | |
| 82 </tr><tr> | |
| 83 <td><a href="#DirectorySyncHandler.__downloadFile">__downloadFile</a></td> | |
| 84 <td>Private method to downlaod the given file.</td> | |
| 85 </tr><tr> | |
| 86 <td><a href="#DirectorySyncHandler.__initialSync">__initialSync</a></td> | |
| 87 <td>Private slot to do the initial synchronization.</td> | |
| 88 </tr><tr> | |
| 89 <td><a href="#DirectorySyncHandler.__initialSyncFile">__initialSyncFile</a></td> | |
| 90 <td>Private method to do the initial synchronization of the given file.</td> | |
| 91 </tr><tr> | |
| 92 <td><a href="#DirectorySyncHandler.__syncFile">__syncFile</a></td> | |
| 93 <td>Private method to synchronize the given file.</td> | |
| 94 </tr><tr> | |
| 95 <td><a href="#DirectorySyncHandler.__uploadFile">__uploadFile</a></td> | |
| 96 <td>Private method to upload the given file.</td> | |
| 97 </tr><tr> | |
| 98 <td><a href="#DirectorySyncHandler.initialLoadAndCheck">initialLoadAndCheck</a></td> | |
| 99 <td>Public method to do the initial check.</td> | |
| 100 </tr><tr> | |
| 101 <td><a href="#DirectorySyncHandler.shutdown">shutdown</a></td> | |
| 102 <td>Public method to shut down the handler.</td> | |
| 103 </tr><tr> | |
| 104 <td><a href="#DirectorySyncHandler.syncBookmarks">syncBookmarks</a></td> | |
| 105 <td>Public method to synchronize the bookmarks.</td> | |
| 106 </tr><tr> | |
| 107 <td><a href="#DirectorySyncHandler.syncHistory">syncHistory</a></td> | |
| 108 <td>Public method to synchronize the history.</td> | |
| 109 </tr><tr> | |
| 110 <td><a href="#DirectorySyncHandler.syncPasswords">syncPasswords</a></td> | |
| 111 <td>Public method to synchronize the passwords.</td> | |
| 112 </tr><tr> | |
| 113 <td><a href="#DirectorySyncHandler.syncUserAgents">syncUserAgents</a></td> | |
| 114 <td>Public method to synchronize the user agents.</td> | |
| 115 </tr> | |
| 116 </table> | |
| 117 <h3>Static Methods</h3> | |
| 118 <table> | |
| 119 <tr><td>None</td></tr> | |
| 120 </table> | |
| 121 <a NAME="DirectorySyncHandler.__init__" ID="DirectorySyncHandler.__init__"></a> | |
| 122 <h4>DirectorySyncHandler (Constructor)</h4> | |
| 123 <b>DirectorySyncHandler</b>(<i>parent=None</i>) | |
| 124 <p> | |
| 125 Constructor | |
| 126 </p><dl> | |
| 127 <dt><i>parent</i></dt> | |
| 128 <dd> | |
| 129 reference to the parent object (QObject) | |
| 130 </dd> | |
| 131 </dl><a NAME="DirectorySyncHandler.__downloadFile" ID="DirectorySyncHandler.__downloadFile"></a> | |
| 132 <h4>DirectorySyncHandler.__downloadFile</h4> | |
| 133 <b>__downloadFile</b>(<i>type_, fileName</i>) | |
| 134 <p> | |
| 135 Private method to downlaod the given file. | |
| 136 </p><dl> | |
| 137 <dt><i>type_</i></dt> | |
| 138 <dd> | |
| 139 type of the synchronization event (string one | |
| 140 of "bookmarks", "history", "passwords" or "useragents") | |
| 141 </dd><dt><i>fileName</i></dt> | |
| 142 <dd> | |
| 143 name of the file to be downloaded (string) | |
| 144 </dd> | |
| 145 </dl><a NAME="DirectorySyncHandler.__initialSync" ID="DirectorySyncHandler.__initialSync"></a> | |
| 146 <h4>DirectorySyncHandler.__initialSync</h4> | |
| 147 <b>__initialSync</b>(<i></i>) | |
| 148 <p> | |
| 149 Private slot to do the initial synchronization. | |
| 150 </p><a NAME="DirectorySyncHandler.__initialSyncFile" ID="DirectorySyncHandler.__initialSyncFile"></a> | |
| 151 <h4>DirectorySyncHandler.__initialSyncFile</h4> | |
| 152 <b>__initialSyncFile</b>(<i>type_, fileName</i>) | |
| 153 <p> | |
| 154 Private method to do the initial synchronization of the given file. | |
| 155 </p><dl> | |
| 156 <dt><i>type_</i></dt> | |
| 157 <dd> | |
| 158 type of the synchronization event (string one | |
| 159 of "bookmarks", "history", "passwords" or "useragents") | |
| 160 </dd><dt><i>fileName</i></dt> | |
| 161 <dd> | |
| 162 name of the file to be synchronized (string) | |
| 163 </dd> | |
| 164 </dl><a NAME="DirectorySyncHandler.__syncFile" ID="DirectorySyncHandler.__syncFile"></a> | |
| 165 <h4>DirectorySyncHandler.__syncFile</h4> | |
| 166 <b>__syncFile</b>(<i>type_, fileName</i>) | |
| 167 <p> | |
| 168 Private method to synchronize the given file. | |
| 169 </p><dl> | |
| 170 <dt><i>type_</i></dt> | |
| 171 <dd> | |
| 172 type of the synchronization event (string one | |
| 173 of "bookmarks", "history", "passwords" or "useragents") | |
| 174 </dd><dt><i>fileName</i></dt> | |
| 175 <dd> | |
| 176 name of the file to be synchronized (string) | |
| 177 </dd> | |
| 178 </dl><a NAME="DirectorySyncHandler.__uploadFile" ID="DirectorySyncHandler.__uploadFile"></a> | |
| 179 <h4>DirectorySyncHandler.__uploadFile</h4> | |
| 180 <b>__uploadFile</b>(<i>type_, fileName</i>) | |
| 181 <p> | |
| 182 Private method to upload the given file. | |
| 183 </p><dl> | |
| 184 <dt><i>type_</i></dt> | |
| 185 <dd> | |
| 186 type of the synchronization event (string one | |
| 187 of "bookmarks", "history", "passwords" or "useragents") | |
| 188 </dd><dt><i>fileName</i></dt> | |
| 189 <dd> | |
| 190 name of the file to be uploaded (string) | |
| 191 </dd> | |
| 192 </dl><a NAME="DirectorySyncHandler.initialLoadAndCheck" ID="DirectorySyncHandler.initialLoadAndCheck"></a> | |
| 193 <h4>DirectorySyncHandler.initialLoadAndCheck</h4> | |
| 194 <b>initialLoadAndCheck</b>(<i>forceUpload</i>) | |
| 195 <p> | |
| 196 Public method to do the initial check. | |
| 197 </p><dl> | |
| 198 <dt><i>forceUpload=</i></dt> | |
| 199 <dd> | |
| 200 flag indicating a forced upload of the files (boolean) | |
| 201 </dd> | |
| 202 </dl><a NAME="DirectorySyncHandler.shutdown" ID="DirectorySyncHandler.shutdown"></a> | |
| 203 <h4>DirectorySyncHandler.shutdown</h4> | |
| 204 <b>shutdown</b>(<i></i>) | |
| 205 <p> | |
| 206 Public method to shut down the handler. | |
| 207 </p><a NAME="DirectorySyncHandler.syncBookmarks" ID="DirectorySyncHandler.syncBookmarks"></a> | |
| 208 <h4>DirectorySyncHandler.syncBookmarks</h4> | |
| 209 <b>syncBookmarks</b>(<i></i>) | |
| 210 <p> | |
| 211 Public method to synchronize the bookmarks. | |
| 212 </p><a NAME="DirectorySyncHandler.syncHistory" ID="DirectorySyncHandler.syncHistory"></a> | |
| 213 <h4>DirectorySyncHandler.syncHistory</h4> | |
| 214 <b>syncHistory</b>(<i></i>) | |
| 215 <p> | |
| 216 Public method to synchronize the history. | |
| 217 </p><a NAME="DirectorySyncHandler.syncPasswords" ID="DirectorySyncHandler.syncPasswords"></a> | |
| 218 <h4>DirectorySyncHandler.syncPasswords</h4> | |
| 219 <b>syncPasswords</b>(<i></i>) | |
| 220 <p> | |
| 221 Public method to synchronize the passwords. | |
| 222 </p><a NAME="DirectorySyncHandler.syncUserAgents" ID="DirectorySyncHandler.syncUserAgents"></a> | |
| 223 <h4>DirectorySyncHandler.syncUserAgents</h4> | |
| 224 <b>syncUserAgents</b>(<i></i>) | |
| 225 <p> | |
| 226 Public method to synchronize the user agents. | |
| 227 </p> | |
| 228 <div align="right"><a href="#top">Up</a></div> | |
| 229 <hr /> | |
| 230 </body></html> |
