Mercurial Repositories > eric / file comparison

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

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

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

Mercurial Repository: eric

eric ide

mercurial