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

branch
maintenance
changeset 7286
7eb04391adf7
parent 7226
babe80d84a3e
parent 7285
1ff497f33f31
child 7287
1c17f2191bdd
equal deleted inserted replaced
7226:babe80d84a3e 7286:7eb04391adf7
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Helpviewer.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><a NAME="top" ID="top"></a>
22 <h1>eric6.Helpviewer.Sync.SyncManager</h1>
23 <p>
24 Module implementing the synchronization manager class.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#SyncManager">SyncManager</a></td>
34 <td>Class implementing the synchronization manager.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="SyncManager" ID="SyncManager"></a>
43 <h2>SyncManager</h2>
44 <p>
45 Class implementing the synchronization manager.
46 </p><h3>Signals</h3>
47 <dl>
48 <dt>syncError(message)</dt>
49 <dd>
50 emitted for a general error with the error
51 message (string)
52 </dd><dt>syncFinished(type_, done, download)</dt>
53 <dd>
54 emitted after a
55 synchronization has finished (string one of "bookmarks", "history",
56 "passwords", "useragents" or "speeddial", boolean, boolean)
57 </dd><dt>syncMessage(message)</dt>
58 <dd>
59 emitted to give status info about the sync
60 process (string)
61 </dd><dt>syncStatus(type_, message)</dt>
62 <dd>
63 emitted to indicate the synchronization
64 status (string one of "bookmarks", "history", "passwords",
65 "useragents" or "speeddial", string)
66 </dd>
67 </dl>
68 <h3>Derived from</h3>
69 QObject
70 <h3>Class Attributes</h3>
71 <table>
72 <tr><td>None</td></tr>
73 </table>
74 <h3>Class Methods</h3>
75 <table>
76 <tr><td>None</td></tr>
77 </table>
78 <h3>Methods</h3>
79 <table>
80 <tr>
81 <td><a href="#SyncManager.__init__">SyncManager</a></td>
82 <td>Constructor</td>
83 </tr><tr>
84 <td><a href="#SyncManager.__syncBookmarks">__syncBookmarks</a></td>
85 <td>Private slot to synchronize the bookmarks.</td>
86 </tr><tr>
87 <td><a href="#SyncManager.__syncError">__syncError</a></td>
88 <td>Private slot to handle general synchronization issues.</td>
89 </tr><tr>
90 <td><a href="#SyncManager.__syncFinished">__syncFinished</a></td>
91 <td>Private slot to handle a finished synchronization event.</td>
92 </tr><tr>
93 <td><a href="#SyncManager.__syncHistory">__syncHistory</a></td>
94 <td>Private slot to synchronize the history.</td>
95 </tr><tr>
96 <td><a href="#SyncManager.__syncPasswords">__syncPasswords</a></td>
97 <td>Private slot to synchronize the passwords.</td>
98 </tr><tr>
99 <td><a href="#SyncManager.__syncSpeedDial">__syncSpeedDial</a></td>
100 <td>Private slot to synchronize the speed dial settings.</td>
101 </tr><tr>
102 <td><a href="#SyncManager.__syncStatus">__syncStatus</a></td>
103 <td>Private slot to handle a status update of a synchronization event.</td>
104 </tr><tr>
105 <td><a href="#SyncManager.__syncUserAgents">__syncUserAgents</a></td>
106 <td>Private slot to synchronize the user agent settings.</td>
107 </tr><tr>
108 <td><a href="#SyncManager.close">close</a></td>
109 <td>Public slot to shut down the synchronization manager.</td>
110 </tr><tr>
111 <td><a href="#SyncManager.handler">handler</a></td>
112 <td>Public method to get a reference to the sync handler object.</td>
113 </tr><tr>
114 <td><a href="#SyncManager.loadSettings">loadSettings</a></td>
115 <td>Public method to load the settings.</td>
116 </tr><tr>
117 <td><a href="#SyncManager.showSyncDialog">showSyncDialog</a></td>
118 <td>Public method to show the synchronization dialog.</td>
119 </tr><tr>
120 <td><a href="#SyncManager.syncEnabled">syncEnabled</a></td>
121 <td>Public method to check, if synchronization is enabled.</td>
122 </tr>
123 </table>
124 <h3>Static Methods</h3>
125 <table>
126 <tr><td>None</td></tr>
127 </table>
128 <a NAME="SyncManager.__init__" ID="SyncManager.__init__"></a>
129 <h4>SyncManager (Constructor)</h4>
130 <b>SyncManager</b>(<i>parent=None</i>)
131 <p>
132 Constructor
133 </p><dl>
134 <dt><i>parent</i></dt>
135 <dd>
136 reference to the parent object (QObject)
137 </dd>
138 </dl><a NAME="SyncManager.__syncBookmarks" ID="SyncManager.__syncBookmarks"></a>
139 <h4>SyncManager.__syncBookmarks</h4>
140 <b>__syncBookmarks</b>(<i></i>)
141 <p>
142 Private slot to synchronize the bookmarks.
143 </p><a NAME="SyncManager.__syncError" ID="SyncManager.__syncError"></a>
144 <h4>SyncManager.__syncError</h4>
145 <b>__syncError</b>(<i>message</i>)
146 <p>
147 Private slot to handle general synchronization issues.
148 </p><dl>
149 <dt><i>message</i></dt>
150 <dd>
151 error message (string)
152 </dd>
153 </dl><a NAME="SyncManager.__syncFinished" ID="SyncManager.__syncFinished"></a>
154 <h4>SyncManager.__syncFinished</h4>
155 <b>__syncFinished</b>(<i>type_, status, download</i>)
156 <p>
157 Private slot to handle a finished synchronization event.
158 </p><dl>
159 <dt><i>type_</i></dt>
160 <dd>
161 type of the synchronization event (string one
162 of "bookmarks", "history", "passwords", "useragents" or
163 "speeddial")
164 </dd><dt><i>status</i></dt>
165 <dd>
166 flag indicating success (boolean)
167 </dd><dt><i>download</i></dt>
168 <dd>
169 flag indicating a download of a file (boolean)
170 </dd>
171 </dl><a NAME="SyncManager.__syncHistory" ID="SyncManager.__syncHistory"></a>
172 <h4>SyncManager.__syncHistory</h4>
173 <b>__syncHistory</b>(<i></i>)
174 <p>
175 Private slot to synchronize the history.
176 </p><a NAME="SyncManager.__syncPasswords" ID="SyncManager.__syncPasswords"></a>
177 <h4>SyncManager.__syncPasswords</h4>
178 <b>__syncPasswords</b>(<i></i>)
179 <p>
180 Private slot to synchronize the passwords.
181 </p><a NAME="SyncManager.__syncSpeedDial" ID="SyncManager.__syncSpeedDial"></a>
182 <h4>SyncManager.__syncSpeedDial</h4>
183 <b>__syncSpeedDial</b>(<i></i>)
184 <p>
185 Private slot to synchronize the speed dial settings.
186 </p><a NAME="SyncManager.__syncStatus" ID="SyncManager.__syncStatus"></a>
187 <h4>SyncManager.__syncStatus</h4>
188 <b>__syncStatus</b>(<i>type_, message</i>)
189 <p>
190 Private slot to handle a status update of a synchronization event.
191 </p><dl>
192 <dt><i>type_</i></dt>
193 <dd>
194 type of the synchronization event (string one
195 of "bookmarks", "history", "passwords", "useragents" or
196 "speeddial")
197 </dd><dt><i>message</i></dt>
198 <dd>
199 status message for the event (string)
200 </dd>
201 </dl><a NAME="SyncManager.__syncUserAgents" ID="SyncManager.__syncUserAgents"></a>
202 <h4>SyncManager.__syncUserAgents</h4>
203 <b>__syncUserAgents</b>(<i></i>)
204 <p>
205 Private slot to synchronize the user agent settings.
206 </p><a NAME="SyncManager.close" ID="SyncManager.close"></a>
207 <h4>SyncManager.close</h4>
208 <b>close</b>(<i></i>)
209 <p>
210 Public slot to shut down the synchronization manager.
211 </p><a NAME="SyncManager.handler" ID="SyncManager.handler"></a>
212 <h4>SyncManager.handler</h4>
213 <b>handler</b>(<i></i>)
214 <p>
215 Public method to get a reference to the sync handler object.
216 </p><dl>
217 <dt>Returns:</dt>
218 <dd>
219 reference to the sync handler object (SyncHandler)
220 </dd>
221 </dl><a NAME="SyncManager.loadSettings" ID="SyncManager.loadSettings"></a>
222 <h4>SyncManager.loadSettings</h4>
223 <b>loadSettings</b>(<i>forceUpload=False</i>)
224 <p>
225 Public method to load the settings.
226 </p><dl>
227 <dt><i>forceUpload=</i></dt>
228 <dd>
229 flag indicating a forced upload of the files
230 (boolean)
231 </dd>
232 </dl><a NAME="SyncManager.showSyncDialog" ID="SyncManager.showSyncDialog"></a>
233 <h4>SyncManager.showSyncDialog</h4>
234 <b>showSyncDialog</b>(<i></i>)
235 <p>
236 Public method to show the synchronization dialog.
237 </p><a NAME="SyncManager.syncEnabled" ID="SyncManager.syncEnabled"></a>
238 <h4>SyncManager.syncEnabled</h4>
239 <b>syncEnabled</b>(<i></i>)
240 <p>
241 Public method to check, if synchronization is enabled.
242 </p><dl>
243 <dt>Returns:</dt>
244 <dd>
245 flag indicating enabled synchronization
246 </dd>
247 </dl>
248 <div align="right"><a href="#top">Up</a></div>
249 <hr />
250 </body></html>

eric ide

mercurial