Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Helpviewer.Sync.SyncManager.html
Documentation/Source/eric5.Helpviewer.Sync.SyncManager.html
- changeset 1626
- a77c8ea8582c
- child 1680
- 28e57079dab5
equal
deleted
inserted
replaced
| 1625:4f03e45703e9 | 1626:a77c8ea8582c |
|---|---|
| 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.SyncManager</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.SyncManager</h1> | |
| 24 <p> | |
| 25 Module implementing the synchronization manager class. | |
| 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="#SyncManager">SyncManager</a></td> | |
| 35 <td>Class implementing the synchronization manager.</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="SyncManager" ID="SyncManager"></a> | |
| 44 <h2>SyncManager</h2> | |
| 45 <p> | |
| 46 Class implementing the synchronization manager. | |
| 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> | |
| 53 </dl> | |
| 54 <h3>Derived from</h3> | |
| 55 QObject | |
| 56 <h3>Class Attributes</h3> | |
| 57 <table> | |
| 58 <tr><td>None</td></tr> | |
| 59 </table> | |
| 60 <h3>Class Methods</h3> | |
| 61 <table> | |
| 62 <tr><td>None</td></tr> | |
| 63 </table> | |
| 64 <h3>Methods</h3> | |
| 65 <table> | |
| 66 <tr> | |
| 67 <td><a href="#SyncManager.__init__">SyncManager</a></td> | |
| 68 <td>Constructor</td> | |
| 69 </tr><tr> | |
| 70 <td><a href="#SyncManager.__syncBookmarks">__syncBookmarks</a></td> | |
| 71 <td>Private slot to synchronize the bookmarks.</td> | |
| 72 </tr><tr> | |
| 73 <td><a href="#SyncManager.__syncError">__syncError</a></td> | |
| 74 <td>Private slot to handle general synchronization issues.</td> | |
| 75 </tr><tr> | |
| 76 <td><a href="#SyncManager.__syncFinished">__syncFinished</a></td> | |
| 77 <td>Private slot to handle a finished synchronization event.</td> | |
| 78 </tr><tr> | |
| 79 <td><a href="#SyncManager.__syncHistory">__syncHistory</a></td> | |
| 80 <td>Private slot to synchronize the history.</td> | |
| 81 </tr><tr> | |
| 82 <td><a href="#SyncManager.__syncPasswords">__syncPasswords</a></td> | |
| 83 <td>Private slot to synchronize the passwords.</td> | |
| 84 </tr><tr> | |
| 85 <td><a href="#SyncManager.__syncUserAgents">__syncUserAgents</a></td> | |
| 86 <td>Private slot to synchronize the user agent settings.</td> | |
| 87 </tr><tr> | |
| 88 <td><a href="#SyncManager.close">close</a></td> | |
| 89 <td>Public slot to shut down the synchronization manager.</td> | |
| 90 </tr><tr> | |
| 91 <td><a href="#SyncManager.handler">handler</a></td> | |
| 92 <td>Public method to get a reference to the sync handler object.</td> | |
| 93 </tr><tr> | |
| 94 <td><a href="#SyncManager.loadSettings">loadSettings</a></td> | |
| 95 <td>Public method to load the settings.</td> | |
| 96 </tr><tr> | |
| 97 <td><a href="#SyncManager.showSyncDialog">showSyncDialog</a></td> | |
| 98 <td>Public method to show the synchronization dialog.</td> | |
| 99 </tr><tr> | |
| 100 <td><a href="#SyncManager.syncEnabled">syncEnabled</a></td> | |
| 101 <td>Public method to check, if synchronization is enabled.</td> | |
| 102 </tr> | |
| 103 </table> | |
| 104 <h3>Static Methods</h3> | |
| 105 <table> | |
| 106 <tr><td>None</td></tr> | |
| 107 </table> | |
| 108 <a NAME="SyncManager.__init__" ID="SyncManager.__init__"></a> | |
| 109 <h4>SyncManager (Constructor)</h4> | |
| 110 <b>SyncManager</b>(<i>parent=None</i>) | |
| 111 <p> | |
| 112 Constructor | |
| 113 </p><dl> | |
| 114 <dt><i>parent</i></dt> | |
| 115 <dd> | |
| 116 reference to the parent object (QObject) | |
| 117 </dd> | |
| 118 </dl><a NAME="SyncManager.__syncBookmarks" ID="SyncManager.__syncBookmarks"></a> | |
| 119 <h4>SyncManager.__syncBookmarks</h4> | |
| 120 <b>__syncBookmarks</b>(<i></i>) | |
| 121 <p> | |
| 122 Private slot to synchronize the bookmarks. | |
| 123 </p><a NAME="SyncManager.__syncError" ID="SyncManager.__syncError"></a> | |
| 124 <h4>SyncManager.__syncError</h4> | |
| 125 <b>__syncError</b>(<i>message</i>) | |
| 126 <p> | |
| 127 Private slot to handle general synchronization issues. | |
| 128 </p><dl> | |
| 129 <dt><i>message</i></dt> | |
| 130 <dd> | |
| 131 error message (string) | |
| 132 </dd> | |
| 133 </dl><a NAME="SyncManager.__syncFinished" ID="SyncManager.__syncFinished"></a> | |
| 134 <h4>SyncManager.__syncFinished</h4> | |
| 135 <b>__syncFinished</b>(<i>type_, status, download</i>) | |
| 136 <p> | |
| 137 Private slot to handle a finished synchronization event. | |
| 138 </p><dl> | |
| 139 <dt><i>type_</i></dt> | |
| 140 <dd> | |
| 141 type of the synchronization event (string one | |
| 142 of "bookmarks", "history", "passwords" or "useragents") | |
| 143 </dd><dt><i>status</i></dt> | |
| 144 <dd> | |
| 145 flag indicating success (boolean) | |
| 146 </dd><dt><i>download</i></dt> | |
| 147 <dd> | |
| 148 flag indicating a download of a file (boolean) | |
| 149 </dd> | |
| 150 </dl><a NAME="SyncManager.__syncHistory" ID="SyncManager.__syncHistory"></a> | |
| 151 <h4>SyncManager.__syncHistory</h4> | |
| 152 <b>__syncHistory</b>(<i></i>) | |
| 153 <p> | |
| 154 Private slot to synchronize the history. | |
| 155 </p><a NAME="SyncManager.__syncPasswords" ID="SyncManager.__syncPasswords"></a> | |
| 156 <h4>SyncManager.__syncPasswords</h4> | |
| 157 <b>__syncPasswords</b>(<i></i>) | |
| 158 <p> | |
| 159 Private slot to synchronize the passwords. | |
| 160 </p><a NAME="SyncManager.__syncUserAgents" ID="SyncManager.__syncUserAgents"></a> | |
| 161 <h4>SyncManager.__syncUserAgents</h4> | |
| 162 <b>__syncUserAgents</b>(<i></i>) | |
| 163 <p> | |
| 164 Private slot to synchronize the user agent settings. | |
| 165 </p><a NAME="SyncManager.close" ID="SyncManager.close"></a> | |
| 166 <h4>SyncManager.close</h4> | |
| 167 <b>close</b>(<i></i>) | |
| 168 <p> | |
| 169 Public slot to shut down the synchronization manager. | |
| 170 </p><a NAME="SyncManager.handler" ID="SyncManager.handler"></a> | |
| 171 <h4>SyncManager.handler</h4> | |
| 172 <b>handler</b>(<i></i>) | |
| 173 <p> | |
| 174 Public method to get a reference to the sync handler object. | |
| 175 </p><dl> | |
| 176 <dt>Returns:</dt> | |
| 177 <dd> | |
| 178 reference to the sync handler object (SyncHandler) | |
| 179 </dd> | |
| 180 </dl><a NAME="SyncManager.loadSettings" ID="SyncManager.loadSettings"></a> | |
| 181 <h4>SyncManager.loadSettings</h4> | |
| 182 <b>loadSettings</b>(<i></i>) | |
| 183 <p> | |
| 184 Public method to load the settings. | |
| 185 </p><a NAME="SyncManager.showSyncDialog" ID="SyncManager.showSyncDialog"></a> | |
| 186 <h4>SyncManager.showSyncDialog</h4> | |
| 187 <b>showSyncDialog</b>(<i></i>) | |
| 188 <p> | |
| 189 Public method to show the synchronization dialog. | |
| 190 </p><a NAME="SyncManager.syncEnabled" ID="SyncManager.syncEnabled"></a> | |
| 191 <h4>SyncManager.syncEnabled</h4> | |
| 192 <b>syncEnabled</b>(<i></i>) | |
| 193 <p> | |
| 194 Public method to check, if synchronization is enabled. | |
| 195 </p><dl> | |
| 196 <dt>Returns:</dt> | |
| 197 <dd> | |
| 198 flag indicating enabled synchronization | |
| 199 </dd> | |
| 200 </dl> | |
| 201 <div align="right"><a href="#top">Up</a></div> | |
| 202 <hr /> | |
| 203 </body></html> |
