Mercurial Repositories > eric / file comparison

comparison: eric7/Documentation/Source/eric7.WebBrowser.Sync.SyncManager.html

eric7/Documentation/Source/eric7.WebBrowser.Sync.SyncManager.html

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
equal deleted inserted replaced
8371:d6062691d424 8372:e0227a7c850e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.WebBrowser.Sync.SyncManager</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body>
22 <a NAME="top" ID="top"></a>
23 <h1>eric7.WebBrowser.Sync.SyncManager</h1>
24
25 <p>
26 Module implementing the synchronization manager class.
27 </p>
28 <h3>Global Attributes</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <h3>Classes</h3>
34
35 <table>
36
37 <tr>
38 <td><a href="#SyncManager">SyncManager</a></td>
39 <td>Class implementing the synchronization manager.</td>
40 </tr>
41 </table>
42 <h3>Functions</h3>
43
44 <table>
45 <tr><td>None</td></tr>
46 </table>
47 <hr />
48 <hr />
49 <a NAME="SyncManager" ID="SyncManager"></a>
50 <h2>SyncManager</h2>
51
52 <p>
53 Class implementing the synchronization manager.
54 </p>
55 <h3>Signals</h3>
56 <dl>
57
58 <dt>syncError(message)</dt>
59 <dd>
60 emitted for a general error with the error
61 message (string)
62 </dd>
63 <dt>syncFinished(type_, done, download)</dt>
64 <dd>
65 emitted after a
66 synchronization has finished (string one of "bookmarks", "history",
67 "passwords", "useragents" or "speeddial", boolean, boolean)
68 </dd>
69 <dt>syncMessage(message)</dt>
70 <dd>
71 emitted to give status info about the sync
72 process (string)
73 </dd>
74 <dt>syncStatus(type_, message)</dt>
75 <dd>
76 emitted to indicate the synchronization
77 status (string one of "bookmarks", "history", "passwords",
78 "useragents" or "speeddial", string)
79 </dd>
80 </dl>
81 <h3>Derived from</h3>
82 QObject
83 <h3>Class Attributes</h3>
84
85 <table>
86 <tr><td>None</td></tr>
87 </table>
88 <h3>Class Methods</h3>
89
90 <table>
91 <tr><td>None</td></tr>
92 </table>
93 <h3>Methods</h3>
94
95 <table>
96
97 <tr>
98 <td><a href="#SyncManager.__init__">SyncManager</a></td>
99 <td>Constructor</td>
100 </tr>
101 <tr>
102 <td><a href="#SyncManager.__syncBookmarks">__syncBookmarks</a></td>
103 <td>Private slot to synchronize the bookmarks.</td>
104 </tr>
105 <tr>
106 <td><a href="#SyncManager.__syncError">__syncError</a></td>
107 <td>Private slot to handle general synchronization issues.</td>
108 </tr>
109 <tr>
110 <td><a href="#SyncManager.__syncFinished">__syncFinished</a></td>
111 <td>Private slot to handle a finished synchronization event.</td>
112 </tr>
113 <tr>
114 <td><a href="#SyncManager.__syncHistory">__syncHistory</a></td>
115 <td>Private slot to synchronize the history.</td>
116 </tr>
117 <tr>
118 <td><a href="#SyncManager.__syncPasswords">__syncPasswords</a></td>
119 <td>Private slot to synchronize the passwords.</td>
120 </tr>
121 <tr>
122 <td><a href="#SyncManager.__syncSpeedDial">__syncSpeedDial</a></td>
123 <td>Private slot to synchronize the speed dial settings.</td>
124 </tr>
125 <tr>
126 <td><a href="#SyncManager.__syncStatus">__syncStatus</a></td>
127 <td>Private slot to handle a status update of a synchronization event.</td>
128 </tr>
129 <tr>
130 <td><a href="#SyncManager.__syncUserAgents">__syncUserAgents</a></td>
131 <td>Private slot to synchronize the user agent settings.</td>
132 </tr>
133 <tr>
134 <td><a href="#SyncManager.close">close</a></td>
135 <td>Public slot to shut down the synchronization manager.</td>
136 </tr>
137 <tr>
138 <td><a href="#SyncManager.handler">handler</a></td>
139 <td>Public method to get a reference to the sync handler object.</td>
140 </tr>
141 <tr>
142 <td><a href="#SyncManager.loadSettings">loadSettings</a></td>
143 <td>Public method to load the settings.</td>
144 </tr>
145 <tr>
146 <td><a href="#SyncManager.showSyncDialog">showSyncDialog</a></td>
147 <td>Public method to show the synchronization dialog.</td>
148 </tr>
149 <tr>
150 <td><a href="#SyncManager.syncEnabled">syncEnabled</a></td>
151 <td>Public method to check, if synchronization is enabled.</td>
152 </tr>
153 </table>
154 <h3>Static Methods</h3>
155
156 <table>
157 <tr><td>None</td></tr>
158 </table>
159
160 <a NAME="SyncManager.__init__" ID="SyncManager.__init__"></a>
161 <h4>SyncManager (Constructor)</h4>
162 <b>SyncManager</b>(<i>parent=None</i>)
163
164 <p>
165 Constructor
166 </p>
167 <dl>
168
169 <dt><i>parent</i></dt>
170 <dd>
171 reference to the parent object (QObject)
172 </dd>
173 </dl>
174 <a NAME="SyncManager.__syncBookmarks" ID="SyncManager.__syncBookmarks"></a>
175 <h4>SyncManager.__syncBookmarks</h4>
176 <b>__syncBookmarks</b>(<i></i>)
177
178 <p>
179 Private slot to synchronize the bookmarks.
180 </p>
181 <a NAME="SyncManager.__syncError" ID="SyncManager.__syncError"></a>
182 <h4>SyncManager.__syncError</h4>
183 <b>__syncError</b>(<i>message</i>)
184
185 <p>
186 Private slot to handle general synchronization issues.
187 </p>
188 <dl>
189
190 <dt><i>message</i></dt>
191 <dd>
192 error message (string)
193 </dd>
194 </dl>
195 <a NAME="SyncManager.__syncFinished" ID="SyncManager.__syncFinished"></a>
196 <h4>SyncManager.__syncFinished</h4>
197 <b>__syncFinished</b>(<i>type_, status, download</i>)
198
199 <p>
200 Private slot to handle a finished synchronization event.
201 </p>
202 <dl>
203
204 <dt><i>type_</i></dt>
205 <dd>
206 type of the synchronization event (string one
207 of "bookmarks", "history", "passwords", "useragents" or
208 "speeddial")
209 </dd>
210 <dt><i>status</i></dt>
211 <dd>
212 flag indicating success (boolean)
213 </dd>
214 <dt><i>download</i></dt>
215 <dd>
216 flag indicating a download of a file (boolean)
217 </dd>
218 </dl>
219 <a NAME="SyncManager.__syncHistory" ID="SyncManager.__syncHistory"></a>
220 <h4>SyncManager.__syncHistory</h4>
221 <b>__syncHistory</b>(<i></i>)
222
223 <p>
224 Private slot to synchronize the history.
225 </p>
226 <a NAME="SyncManager.__syncPasswords" ID="SyncManager.__syncPasswords"></a>
227 <h4>SyncManager.__syncPasswords</h4>
228 <b>__syncPasswords</b>(<i></i>)
229
230 <p>
231 Private slot to synchronize the passwords.
232 </p>
233 <a NAME="SyncManager.__syncSpeedDial" ID="SyncManager.__syncSpeedDial"></a>
234 <h4>SyncManager.__syncSpeedDial</h4>
235 <b>__syncSpeedDial</b>(<i></i>)
236
237 <p>
238 Private slot to synchronize the speed dial settings.
239 </p>
240 <a NAME="SyncManager.__syncStatus" ID="SyncManager.__syncStatus"></a>
241 <h4>SyncManager.__syncStatus</h4>
242 <b>__syncStatus</b>(<i>type_, message</i>)
243
244 <p>
245 Private slot to handle a status update of a synchronization event.
246 </p>
247 <dl>
248
249 <dt><i>type_</i></dt>
250 <dd>
251 type of the synchronization event (string one
252 of "bookmarks", "history", "passwords", "useragents" or
253 "speeddial")
254 </dd>
255 <dt><i>message</i></dt>
256 <dd>
257 status message for the event (string)
258 </dd>
259 </dl>
260 <a NAME="SyncManager.__syncUserAgents" ID="SyncManager.__syncUserAgents"></a>
261 <h4>SyncManager.__syncUserAgents</h4>
262 <b>__syncUserAgents</b>(<i></i>)
263
264 <p>
265 Private slot to synchronize the user agent settings.
266 </p>
267 <a NAME="SyncManager.close" ID="SyncManager.close"></a>
268 <h4>SyncManager.close</h4>
269 <b>close</b>(<i></i>)
270
271 <p>
272 Public slot to shut down the synchronization manager.
273 </p>
274 <a NAME="SyncManager.handler" ID="SyncManager.handler"></a>
275 <h4>SyncManager.handler</h4>
276 <b>handler</b>(<i></i>)
277
278 <p>
279 Public method to get a reference to the sync handler object.
280 </p>
281 <dl>
282 <dt>Return:</dt>
283 <dd>
284 reference to the sync handler object (SyncHandler)
285 </dd>
286 </dl>
287 <a NAME="SyncManager.loadSettings" ID="SyncManager.loadSettings"></a>
288 <h4>SyncManager.loadSettings</h4>
289 <b>loadSettings</b>(<i>forceUpload=False</i>)
290
291 <p>
292 Public method to load the settings.
293 </p>
294 <dl>
295
296 <dt><i>forceUpload</i></dt>
297 <dd>
298 flag indicating a forced upload of the files
299 (boolean)
300 </dd>
301 </dl>
302 <a NAME="SyncManager.showSyncDialog" ID="SyncManager.showSyncDialog"></a>
303 <h4>SyncManager.showSyncDialog</h4>
304 <b>showSyncDialog</b>(<i></i>)
305
306 <p>
307 Public method to show the synchronization dialog.
308 </p>
309 <a NAME="SyncManager.syncEnabled" ID="SyncManager.syncEnabled"></a>
310 <h4>SyncManager.syncEnabled</h4>
311 <b>syncEnabled</b>(<i></i>)
312
313 <p>
314 Public method to check, if synchronization is enabled.
315 </p>
316 <dl>
317 <dt>Return:</dt>
318 <dd>
319 flag indicating enabled synchronization
320 </dd>
321 </dl>
322 <div align="right"><a href="#top">Up</a></div>
323 <hr />
324 </body></html>

Mercurial Repository: eric

eric ide

mercurial