5 <link rel="stylesheet" href="styles.css"> |
5 <link rel="stylesheet" href="styles.css"> |
6 </head> |
6 </head> |
7 <body> |
7 <body> |
8 <a NAME="top" ID="top"></a> |
8 <a NAME="top" ID="top"></a> |
9 <h1>eric7.WebBrowser.Sync.SyncManager</h1> |
9 <h1>eric7.WebBrowser.Sync.SyncManager</h1> |
10 |
|
11 <p> |
10 <p> |
12 Module implementing the synchronization manager class. |
11 Module implementing the synchronization manager class. |
13 </p> |
12 </p> |
|
13 |
14 <h3>Global Attributes</h3> |
14 <h3>Global Attributes</h3> |
15 |
15 <table> |
16 <table> |
16 <tr><td>None</td></tr> |
17 <tr><td>None</td></tr> |
17 </table> |
18 </table> |
18 |
19 <h3>Classes</h3> |
19 <h3>Classes</h3> |
20 |
20 <table> |
21 <table> |
|
22 |
|
23 <tr> |
21 <tr> |
24 <td><a href="#SyncManager">SyncManager</a></td> |
22 <td><a href="#SyncManager">SyncManager</a></td> |
25 <td>Class implementing the synchronization manager.</td> |
23 <td>Class implementing the synchronization manager.</td> |
26 </tr> |
24 </tr> |
27 </table> |
25 </table> |
|
26 |
28 <h3>Functions</h3> |
27 <h3>Functions</h3> |
29 |
28 <table> |
30 <table> |
29 <tr><td>None</td></tr> |
31 <tr><td>None</td></tr> |
30 </table> |
32 </table> |
31 |
33 <hr /> |
32 <hr /> |
34 <hr /> |
33 <hr /> |
35 <a NAME="SyncManager" ID="SyncManager"></a> |
34 <a NAME="SyncManager" ID="SyncManager"></a> |
36 <h2>SyncManager</h2> |
35 <h2>SyncManager</h2> |
37 |
|
38 <p> |
36 <p> |
39 Class implementing the synchronization manager. |
37 Class implementing the synchronization manager. |
40 </p> |
38 </p> |
|
39 |
41 <h3>Signals</h3> |
40 <h3>Signals</h3> |
42 <dl> |
41 <dl> |
43 |
42 |
44 <dt>syncError(message)</dt> |
43 <dt>syncError(message)</dt> |
45 <dd> |
44 <dd> |
130 <tr> |
127 <tr> |
131 <td><a href="#SyncManager.syncEnabled">syncEnabled</a></td> |
128 <td><a href="#SyncManager.syncEnabled">syncEnabled</a></td> |
132 <td>Public method to check, if synchronization is enabled.</td> |
129 <td>Public method to check, if synchronization is enabled.</td> |
133 </tr> |
130 </tr> |
134 </table> |
131 </table> |
|
132 |
135 <h3>Static Methods</h3> |
133 <h3>Static Methods</h3> |
136 |
134 <table> |
137 <table> |
135 <tr><td>None</td></tr> |
138 <tr><td>None</td></tr> |
136 </table> |
139 </table> |
137 |
140 |
138 |
141 <a NAME="SyncManager.__init__" ID="SyncManager.__init__"></a> |
139 <a NAME="SyncManager.__init__" ID="SyncManager.__init__"></a> |
142 <h4>SyncManager (Constructor)</h4> |
140 <h4>SyncManager (Constructor)</h4> |
143 <b>SyncManager</b>(<i>parent=None</i>) |
141 <b>SyncManager</b>(<i>parent=None</i>) |
144 |
|
145 <p> |
142 <p> |
146 Constructor |
143 Constructor |
147 </p> |
144 </p> |
|
145 |
148 <dl> |
146 <dl> |
149 |
147 |
150 <dt><i>parent</i> (QObject)</dt> |
148 <dt><i>parent</i> (QObject)</dt> |
151 <dd> |
149 <dd> |
152 reference to the parent object |
150 reference to the parent object |
153 </dd> |
151 </dd> |
154 </dl> |
152 </dl> |
155 <a NAME="SyncManager.__syncBookmarks" ID="SyncManager.__syncBookmarks"></a> |
153 <a NAME="SyncManager.__syncBookmarks" ID="SyncManager.__syncBookmarks"></a> |
156 <h4>SyncManager.__syncBookmarks</h4> |
154 <h4>SyncManager.__syncBookmarks</h4> |
157 <b>__syncBookmarks</b>(<i></i>) |
155 <b>__syncBookmarks</b>(<i></i>) |
158 |
|
159 <p> |
156 <p> |
160 Private slot to synchronize the bookmarks. |
157 Private slot to synchronize the bookmarks. |
161 </p> |
158 </p> |
|
159 |
162 <a NAME="SyncManager.__syncError" ID="SyncManager.__syncError"></a> |
160 <a NAME="SyncManager.__syncError" ID="SyncManager.__syncError"></a> |
163 <h4>SyncManager.__syncError</h4> |
161 <h4>SyncManager.__syncError</h4> |
164 <b>__syncError</b>(<i>message</i>) |
162 <b>__syncError</b>(<i>message</i>) |
165 |
|
166 <p> |
163 <p> |
167 Private slot to handle general synchronization issues. |
164 Private slot to handle general synchronization issues. |
168 </p> |
165 </p> |
|
166 |
169 <dl> |
167 <dl> |
170 |
168 |
171 <dt><i>message</i> (str)</dt> |
169 <dt><i>message</i> (str)</dt> |
172 <dd> |
170 <dd> |
173 error message |
171 error message |
174 </dd> |
172 </dd> |
175 </dl> |
173 </dl> |
176 <a NAME="SyncManager.__syncFinished" ID="SyncManager.__syncFinished"></a> |
174 <a NAME="SyncManager.__syncFinished" ID="SyncManager.__syncFinished"></a> |
177 <h4>SyncManager.__syncFinished</h4> |
175 <h4>SyncManager.__syncFinished</h4> |
178 <b>__syncFinished</b>(<i>type_, status, download</i>) |
176 <b>__syncFinished</b>(<i>type_, status, download</i>) |
179 |
|
180 <p> |
177 <p> |
181 Private slot to handle a finished synchronization event. |
178 Private slot to handle a finished synchronization event. |
182 </p> |
179 </p> |
|
180 |
183 <dl> |
181 <dl> |
184 |
182 |
185 <dt><i>type_</i> (str)</dt> |
183 <dt><i>type_</i> (str)</dt> |
186 <dd> |
184 <dd> |
187 type of the synchronization event (one of "bookmarks", |
185 type of the synchronization event (one of "bookmarks", |
197 </dd> |
195 </dd> |
198 </dl> |
196 </dl> |
199 <a NAME="SyncManager.__syncHistory" ID="SyncManager.__syncHistory"></a> |
197 <a NAME="SyncManager.__syncHistory" ID="SyncManager.__syncHistory"></a> |
200 <h4>SyncManager.__syncHistory</h4> |
198 <h4>SyncManager.__syncHistory</h4> |
201 <b>__syncHistory</b>(<i></i>) |
199 <b>__syncHistory</b>(<i></i>) |
202 |
|
203 <p> |
200 <p> |
204 Private slot to synchronize the history. |
201 Private slot to synchronize the history. |
205 </p> |
202 </p> |
|
203 |
206 <a NAME="SyncManager.__syncPasswords" ID="SyncManager.__syncPasswords"></a> |
204 <a NAME="SyncManager.__syncPasswords" ID="SyncManager.__syncPasswords"></a> |
207 <h4>SyncManager.__syncPasswords</h4> |
205 <h4>SyncManager.__syncPasswords</h4> |
208 <b>__syncPasswords</b>(<i></i>) |
206 <b>__syncPasswords</b>(<i></i>) |
209 |
|
210 <p> |
207 <p> |
211 Private slot to synchronize the passwords. |
208 Private slot to synchronize the passwords. |
212 </p> |
209 </p> |
|
210 |
213 <a NAME="SyncManager.__syncSpeedDial" ID="SyncManager.__syncSpeedDial"></a> |
211 <a NAME="SyncManager.__syncSpeedDial" ID="SyncManager.__syncSpeedDial"></a> |
214 <h4>SyncManager.__syncSpeedDial</h4> |
212 <h4>SyncManager.__syncSpeedDial</h4> |
215 <b>__syncSpeedDial</b>(<i></i>) |
213 <b>__syncSpeedDial</b>(<i></i>) |
216 |
|
217 <p> |
214 <p> |
218 Private slot to synchronize the speed dial settings. |
215 Private slot to synchronize the speed dial settings. |
219 </p> |
216 </p> |
|
217 |
220 <a NAME="SyncManager.__syncStatus" ID="SyncManager.__syncStatus"></a> |
218 <a NAME="SyncManager.__syncStatus" ID="SyncManager.__syncStatus"></a> |
221 <h4>SyncManager.__syncStatus</h4> |
219 <h4>SyncManager.__syncStatus</h4> |
222 <b>__syncStatus</b>(<i>type_, message</i>) |
220 <b>__syncStatus</b>(<i>type_, message</i>) |
223 |
|
224 <p> |
221 <p> |
225 Private slot to handle a status update of a synchronization event. |
222 Private slot to handle a status update of a synchronization event. |
226 </p> |
223 </p> |
|
224 |
227 <dl> |
225 <dl> |
228 |
226 |
229 <dt><i>type_</i> (str)</dt> |
227 <dt><i>type_</i> (str)</dt> |
230 <dd> |
228 <dd> |
231 type of the synchronization event (one of "bookmarks", |
229 type of the synchronization event (one of "bookmarks", |
237 </dd> |
235 </dd> |
238 </dl> |
236 </dl> |
239 <a NAME="SyncManager.__syncUserAgents" ID="SyncManager.__syncUserAgents"></a> |
237 <a NAME="SyncManager.__syncUserAgents" ID="SyncManager.__syncUserAgents"></a> |
240 <h4>SyncManager.__syncUserAgents</h4> |
238 <h4>SyncManager.__syncUserAgents</h4> |
241 <b>__syncUserAgents</b>(<i></i>) |
239 <b>__syncUserAgents</b>(<i></i>) |
242 |
|
243 <p> |
240 <p> |
244 Private slot to synchronize the user agent settings. |
241 Private slot to synchronize the user agent settings. |
245 </p> |
242 </p> |
|
243 |
246 <a NAME="SyncManager.close" ID="SyncManager.close"></a> |
244 <a NAME="SyncManager.close" ID="SyncManager.close"></a> |
247 <h4>SyncManager.close</h4> |
245 <h4>SyncManager.close</h4> |
248 <b>close</b>(<i></i>) |
246 <b>close</b>(<i></i>) |
249 |
|
250 <p> |
247 <p> |
251 Public slot to shut down the synchronization manager. |
248 Public slot to shut down the synchronization manager. |
252 </p> |
249 </p> |
|
250 |
253 <a NAME="SyncManager.handler" ID="SyncManager.handler"></a> |
251 <a NAME="SyncManager.handler" ID="SyncManager.handler"></a> |
254 <h4>SyncManager.handler</h4> |
252 <h4>SyncManager.handler</h4> |
255 <b>handler</b>(<i></i>) |
253 <b>handler</b>(<i></i>) |
256 |
|
257 <p> |
254 <p> |
258 Public method to get a reference to the sync handler object. |
255 Public method to get a reference to the sync handler object. |
259 </p> |
256 </p> |
|
257 |
260 <dl> |
258 <dl> |
261 <dt>Return:</dt> |
259 <dt>Return:</dt> |
262 <dd> |
260 <dd> |
263 reference to the sync handler object |
261 reference to the sync handler object |
264 </dd> |
262 </dd> |
270 </dd> |
268 </dd> |
271 </dl> |
269 </dl> |
272 <a NAME="SyncManager.loadSettings" ID="SyncManager.loadSettings"></a> |
270 <a NAME="SyncManager.loadSettings" ID="SyncManager.loadSettings"></a> |
273 <h4>SyncManager.loadSettings</h4> |
271 <h4>SyncManager.loadSettings</h4> |
274 <b>loadSettings</b>(<i>forceUpload=False</i>) |
272 <b>loadSettings</b>(<i>forceUpload=False</i>) |
275 |
|
276 <p> |
273 <p> |
277 Public method to load the settings. |
274 Public method to load the settings. |
278 </p> |
275 </p> |
|
276 |
279 <dl> |
277 <dl> |
280 |
278 |
281 <dt><i>forceUpload</i> (bool)</dt> |
279 <dt><i>forceUpload</i> (bool)</dt> |
282 <dd> |
280 <dd> |
283 flag indicating a forced upload of the files |
281 flag indicating a forced upload of the files |
284 </dd> |
282 </dd> |
285 </dl> |
283 </dl> |
286 <a NAME="SyncManager.showSyncDialog" ID="SyncManager.showSyncDialog"></a> |
284 <a NAME="SyncManager.showSyncDialog" ID="SyncManager.showSyncDialog"></a> |
287 <h4>SyncManager.showSyncDialog</h4> |
285 <h4>SyncManager.showSyncDialog</h4> |
288 <b>showSyncDialog</b>(<i></i>) |
286 <b>showSyncDialog</b>(<i></i>) |
289 |
|
290 <p> |
287 <p> |
291 Public method to show the synchronization dialog. |
288 Public method to show the synchronization dialog. |
292 </p> |
289 </p> |
|
290 |
293 <a NAME="SyncManager.syncEnabled" ID="SyncManager.syncEnabled"></a> |
291 <a NAME="SyncManager.syncEnabled" ID="SyncManager.syncEnabled"></a> |
294 <h4>SyncManager.syncEnabled</h4> |
292 <h4>SyncManager.syncEnabled</h4> |
295 <b>syncEnabled</b>(<i></i>) |
293 <b>syncEnabled</b>(<i></i>) |
296 |
|
297 <p> |
294 <p> |
298 Public method to check, if synchronization is enabled. |
295 Public method to check, if synchronization is enabled. |
299 </p> |
296 </p> |
|
297 |
300 <dl> |
298 <dl> |
301 <dt>Return:</dt> |
299 <dt>Return:</dt> |
302 <dd> |
300 <dd> |
303 flag indicating enabled synchronization |
301 flag indicating enabled synchronization |
304 </dd> |
302 </dd> |